BufferedStream.ReadAsync メソッド

定義

オーバーロード

ReadAsync(Memory<Byte>, CancellationToken)

現在のバッファー ストリームからバイト シーケンスを非同期に読み取り、読み取ったバイト数だけバッファー ストリーム内の位置を進めます。

ReadAsync(Byte[], Int32, Int32, CancellationToken)

現在のストリームからバイト シーケンスを非同期に読み取り、読み取ったバイト数だけストリーム内の位置を進め、キャンセル要求を監視します。

ReadAsync(Memory<Byte>, CancellationToken)

ソース:
BufferedStream.cs
ソース:
BufferedStream.cs
ソース:
BufferedStream.cs

現在のバッファー ストリームからバイト シーケンスを非同期に読み取り、読み取ったバイト数だけバッファー ストリーム内の位置を進めます。

public override System.Threading.Tasks.ValueTask<int> ReadAsync (Memory<byte> buffer, System.Threading.CancellationToken cancellationToken = default);
override this.ReadAsync : Memory<byte> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>
Public Overrides Function ReadAsync (buffer As Memory(Of Byte), Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Integer)

パラメーター

buffer
Memory<Byte>

データを書き込むメモリの領域。

cancellationToken
CancellationToken

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

戻り値

非同期の読み取り操作を表すタスク。 その Result プロパティの値には、バッファーに読み取られるバイトの合計数が含まれます。 要求しただけのバイト数を読み取ることができなかった場合、結果の値はバッファーに割り当てられているバイト数より小さくなります。ストリームの末尾に到達した場合は 0 (ゼロ) になることがあります。

例外

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

注釈

ReadAsyncメソッドを使用すると、メイン スレッドをブロックすることなく、リソースを大量に消費する I/O 操作を実行できます。 このパフォーマンスに関する考慮事項は、時間のかかるストリーム操作によって UI スレッドがブロックされ、アプリが動作していないと見なされる可能性がある Windows 8.x Store アプリまたはデスクトップ アプリで特に重要です。 非同期メソッドは、Visual Basic および C# の および await キーワードと組み合わせてasync使用されます。

プロパティを使用して、 CanRead 現在のインスタンスが読み取りをサポートしているかどうかを判断します。

操作が完了する前に取り消された場合、返されるタスクには プロパティの値がTaskStatus.CanceledStatus含まれます。

適用対象

ReadAsync(Byte[], Int32, Int32, CancellationToken)

ソース:
BufferedStream.cs
ソース:
BufferedStream.cs
ソース:
BufferedStream.cs

現在のストリームからバイト シーケンスを非同期に読み取り、読み取ったバイト数だけストリーム内の位置を進め、キャンセル要求を監視します。

public:
 override System::Threading::Tasks::Task<int> ^ ReadAsync(cli::array <System::Byte> ^ buffer, int offset, int count, System::Threading::CancellationToken cancellationToken);
public override System.Threading.Tasks.Task<int> ReadAsync (byte[] buffer, int offset, int count, System.Threading.CancellationToken cancellationToken);
override this.ReadAsync : byte[] * int * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>
Public Overrides Function ReadAsync (buffer As Byte(), offset As Integer, count As Integer, cancellationToken As CancellationToken) As Task(Of Integer)

パラメーター

buffer
Byte[]

データを書き込むバッファー。

offset
Int32

ストリームからのデータの書き込み開始位置を示す buffer 内のバイト オフセット。

count
Int32

読み取る最大バイト数。

cancellationToken
CancellationToken

キャンセル要求を監視するためのトークン。

戻り値

非同期の読み取り操作を表すタスク。 TResult パラメーターの値には、バッファーに読み込まれるバイトの合計数が含まれます。 現在使用できるバイト数が要求した数より小さい場合、結果の値は要求したバイト数より小さくなることがあります。また、ストリームの末尾に到達した場合は 0 になることがあります。

例外

buffernullです。

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

offsetcount の合計が、バッファーの長さよりも大きいです。

ストリームは読み取りをサポートしません。

ストリームは破棄されています。

ストリームは、前の読み取り操作によって現在使用されています。

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

注釈

キャンセル トークンを作成するには、 クラスの CancellationTokenSource インスタンスを作成し、 プロパティを Token パラメーターとして cancellationToken 渡します。

このメソッドは、メソッドの同期例外がスローできる非使用例外をすべて返すタスクに格納します。 返されたタスクに例外が格納されている場合、その例外はタスクが待機されたときにスローされます。 などの ArgumentException使用例外は、引き続き同期的にスローされます。 格納されている例外については、 によって Read(Byte[], Int32, Int32)スローされる例外に関するページを参照してください。

適用対象