TextReader.ReadAsync メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
オーバーロード
| ReadAsync(Memory<Char>, CancellationToken) |
現在のストリームからメモリ ブロックに文字を非同期に読み取ります。 |
| ReadAsync(Char[], Int32, Int32) |
指定した最大文字数を現在のテキスト リーダーから非同期に読み取り、バッファーの指定したインデックス位置にそのデータを書き込みます。 |
ReadAsync(Memory<Char>, CancellationToken)
- ソース:
- TextReader.cs
- ソース:
- TextReader.cs
- ソース:
- TextReader.cs
現在のストリームからメモリ ブロックに文字を非同期に読み取ります。
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 の長さ以下の数値になります。
例外
キャンセル トークンが取り消されました。 この例外は、返されたタスクに格納されます。
適用対象
ReadAsync(Char[], Int32, Int32)
- ソース:
- TextReader.cs
- ソース:
- TextReader.cs
- ソース:
- TextReader.cs
指定した最大文字数を現在のテキスト リーダーから非同期に読み取り、バッファーの指定したインデックス位置にそのデータを書き込みます。
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)
- ファイルおよびストリーム入出力
- 方法: ファイルからのテキストの読み取り
- 方法: テキストのファイルへの書き込み
適用対象
.NET