TextReader.ReadAsync メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
オーバーロード
| 名前 | 説明 |
|---|---|
| ReadAsync(Char[], Int32, Int32) |
現在のテキスト リーダーから指定した最大文字数を非同期的に読み取り、指定したインデックスから始まるデータをバッファーに書き込みます。 |
| ReadAsync(Memory<Char>, CancellationToken) |
現在のストリームからメモリ ブロックに文字を非同期的に読み取ります。 |
ReadAsync(Char[], Int32, Int32)
現在のテキスト リーダーから指定した最大文字数を非同期的に読み取り、指定したインデックスから始まるデータをバッファーに書き込みます。
public:
virtual System::Threading::Tasks::Task<int> ^ ReadAsync(cli::array <char> ^ buffer, int index, int count);public virtual System.Threading.Tasks.Task<int> ReadAsync(char[] buffer, int index, int count);[System.Runtime.InteropServices.ComVisible(false)]
public virtual System.Threading.Tasks.Task<int> ReadAsync(char[] buffer, int index, int count);abstract member ReadAsync : char[] * int * int -> System.Threading.Tasks.Task<int>
override this.ReadAsync : char[] * int * int -> System.Threading.Tasks.Task<int>[<System.Runtime.InteropServices.ComVisible(false)>]
abstract member ReadAsync : char[] * int * int -> System.Threading.Tasks.Task<int>
override this.ReadAsync : char[] * int * int -> System.Threading.Tasks.Task<int>Public Overridable Function ReadAsync (buffer As Char(), index As Integer, count As Integer) As Task(Of Integer)パラメーター
- buffer
- Char[]
このメソッドから制御が戻るときに、指定された文字配列が格納され、 index から (index + count - 1) までの値が現在のソースから読み取られた文字に置き換えられます。
- index
- Int32
buffer書き込みを開始する位置。
- count
- Int32
読み取る最大文字数。 指定した文字数がバッファーに読み込まれる前にテキストの末尾に達すると、現在のメソッドが返されます。
返品
非同期読み取り操作を表すタスク。
TResult パラメーターの値には、バッファーに読み込まれる合計バイト数が含まれます。 現在使用可能なバイト数が要求された数より少ない場合は、結果の値が要求されたバイト数より小さい場合、またはテキストの末尾に達した場合は 0 (ゼロ) にすることができます。
- 属性
例外
buffer は nullです。
index または count が負の値です。
indexとcountの合計がバッファー長を超えています。
テキスト リーダーが破棄されました。
リーダーは現在、以前の読み取り操作で使用されています。
注釈
タスクは、 count パラメーターで指定された文字数が読み取られた後、またはファイルの末尾に達した後に完了します。
TextReader クラスは抽象クラスです。 そのため、コードではインスタンス化しません。 ReadAsync メソッドの使用例については、StreamReader.ReadAsync メソッドを参照してください。
このメソッドは、メソッドの同期的な例外がスローできるすべての非使用例外を返すタスクに格納します。 返されたタスクに例外が格納されている場合、その例外はタスクが待機しているときにスローされます。 ArgumentException などの使用に関する例外は、引き続き同期的にスローされます。 格納されている例外については、 Read(Char[], Int32, Int32)によってスローされる例外を参照してください。
こちらもご覧ください
- ReadAsync(Char[], Int32, Int32)
- ReadAsync(Char[], Int32, Int32)
- ファイルおよびストリーム入出力
- 方法: ファイルからテキストを読み取る
- 方法: ファイルにテキストを書き込む
適用対象
ReadAsync(Memory<Char>, CancellationToken)
現在のストリームからメモリ ブロックに文字を非同期的に読み取ります。
public virtual System.Threading.Tasks.ValueTask<int> ReadAsync(Memory<char> buffer, System.Threading.CancellationToken cancellationToken = default);abstract member ReadAsync : Memory<char> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>
override this.ReadAsync : Memory<char> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>Public Overridable Function ReadAsync (buffer As Memory(Of Char), Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Integer)パラメーター
- cancellationToken
- CancellationToken
キャンセル要求を監視するトークン。 既定値は None です。
返品
非同期読み取り操作を表す値タスク。 型パラメーターの値には、読み取られた文字数が含まれます。ストリームの末尾でデータが読み取られなかった場合は 0 です。 データがストリーム内で使用可能かどうかに応じて、この数値は buffer 長以下になります。
例外
キャンセル トークンが取り消されました。 この例外は、返されたタスクに格納されます。