StringReader.ReadBlockAsync メソッド

定義

オーバーロード

名前 説明
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)

パラメーター

buffer
Memory<Char>

このメソッドが戻るときに、現在のソースから読み取られた文字を格納します。 読み取られた文字数の合計が 0 の場合、スパンは変更されません。

cancellationToken
CancellationToken

キャンセル要求を監視するトークン。 既定値は None です。

返品

非同期読み取り操作を表すタスク。 TResult パラメーターの値には、バッファーに読み込まれる文字数の合計が含まれます。

例外

キャンセル トークンが取り消されました。 この例外は、返されたタスクに格納されます。

注釈

ReadBlockAsync(Memory<Char>, CancellationToken) 呼び出し ReadBlock(Span<Char>) 非同期的に行われます。その結果、 Read(Span<Char>) 直接呼び出されます。

適用対象

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 (ゼロ) にすることができます。

属性

例外

buffernullです。

index または count が負の値です。

indexcountの合計がバッファー長を超えています。

文字列リーダーが破棄されました。

リーダーは現在、以前の読み取り操作で使用されています。

注釈

タスクは、 count パラメーターで指定された文字数が読み取られるか、文字列の末尾に達するまで完了しません。

適用対象