StreamReader.ReadBlockAsync メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
オーバーロード
| 名前 | 説明 |
|---|---|
| ReadBlockAsync(Memory<Char>, CancellationToken) |
現在のストリームから文字を非同期に読み取り、データをバッファーに書き込みます。 |
| ReadBlockAsync(Char[], Int32, Int32) |
現在のストリームから指定した最大文字数を非同期的に読み取り、指定したインデックスから始まるデータをバッファーに書き込みます。 |
ReadBlockAsync(Memory<Char>, CancellationToken)
現在のストリームから文字を非同期に読み取り、データをバッファーに書き込みます。
public override System.Threading.Tasks.ValueTask<int> ReadBlockAsync(Memory<char> buffer, System.Threading.CancellationToken cancellationToken = default);override this.ReadBlockAsync : Memory<char> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>Public Overrides Function ReadBlockAsync (buffer As Memory(Of Char), Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Integer)パラメーター
- cancellationToken
- CancellationToken
キャンセル要求を監視するトークン。 既定値は None です。
返品
非同期読み取り操作を表す値タスク。 値タスクの型パラメーターの値には、バッファーに読み込まれる文字数の合計が含まれます。 現在使用可能な文字数が要求された数より少ない場合は、結果の値が要求された文字数より小さいか、ストリームの末尾に達した場合は 0 (ゼロ) にすることができます。
例外
キャンセル トークンが取り消されました。 この例外は、返されたタスクに格納されます。
適用対象
ReadBlockAsync(Char[], Int32, Int32)
現在のストリームから指定した最大文字数を非同期的に読み取り、指定したインデックスから始まるデータをバッファーに書き込みます。
public:
override System::Threading::Tasks::Task<int> ^ ReadBlockAsync(cli::array <char> ^ buffer, int index, int count);public override System.Threading.Tasks.Task<int> ReadBlockAsync(char[] buffer, int index, int count);[System.Runtime.InteropServices.ComVisible(false)]
public override System.Threading.Tasks.Task<int> ReadBlockAsync(char[] buffer, int index, int count);override this.ReadBlockAsync : char[] * int * int -> System.Threading.Tasks.Task<int>[<System.Runtime.InteropServices.ComVisible(false)>]
override this.ReadBlockAsync : char[] * int * int -> System.Threading.Tasks.Task<int>Public Overrides Function ReadBlockAsync (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 パラメーターで指定された文字数が読み取られるか、ストリームの末尾に達するまで完了しません。
このメソッドは、メソッドの同期的な例外がスローできるすべての非使用例外を返すタスクに格納します。 返されたタスクに例外が格納されている場合、その例外はタスクが待機しているときにスローされます。 ArgumentException などの使用に関する例外は、引き続き同期的にスローされます。 格納されている例外については、 ReadBlock(Char[], Int32, Int32)によってスローされる例外を参照してください。