CryptoStream.ReadAsync(Byte[], Int32, Int32, CancellationToken) メソッド

定義

現在のストリームから非同期的にバイト シーケンスを読み取り、読み取ったバイト数だけストリーム内の位置を進め、キャンセル要求を監視します。Reads a sequence of bytes from the current stream asynchronously, advances the position within the stream by the number of bytes read, and monitors cancellation requests.

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[]

データを書き込むバッファー。The buffer to write the data into.

offset
Int32

ストリームからのデータの書き込み開始位置を示す buffer 内のバイト オフセット。The byte offset in buffer at which to begin writing data from the stream.

count
Int32

読み取る最大バイト数。The maximum number of bytes to read.

cancellationToken
CancellationToken

キャンセル要求を監視するためのトークン。The token to monitor for cancellation requests. 既定値は None です。The default value is None.

戻り値

Task<Int32>

非同期の読み取り操作を表すタスク。A task that represents the asynchronous read operation. タスク オブジェクトの TResult パラメーターの値には、バッファーに読み込まれるバイトの合計数が含まれます。The value of the task object's TResult parameter contains the total number of bytes read into the buffer. 現在使用できるバイト数が要求した数より小さい場合、結果は要求したバイト数より小さくなることがあります。また、ストリームの末尾に到達した場合は 0 になることがあります。The result can be less than the number of bytes requested if the number of bytes currently available is less than the requested number, or it can be 0 (zero) if the end of the stream has been reached.

例外

buffernullです。buffer is null.

offset または count が負の値です。offset or count is negative.

offsetcount の合計が、バッファーの長さよりも大きいです。The sum of offset and count is larger than the buffer length.

ストリームは読み取りをサポートしません。The stream does not support reading.

ストリームは破棄されています。The stream has been disposed.

ストリームは、前の読み取り操作によって現在使用されています。The stream is currently in use by a previous read operation.

注釈

ReadAsync await Await タスクが完了するまでメソッドの実行を中断するには、の呼び出しの前に (C#) または (Visual Basic) 演算子を使用する必要があります。You must preface your call to ReadAsync with the await (C#) or Await (Visual Basic) operator to suspend execution of the method until the task is complete. 詳細については、「 非同期プログラミング (C#) 」または「 Async と Await を使用した非同期プログラミング (Visual Basic)」を参照してください。For more information, see Asynchronous programming (C#) or Asynchronous programming with Async and Await (Visual Basic).

操作が完了前にキャンセルされた場合、返されたタスクには Canceled プロパティの値が含まれ Status ます。If the operation is canceled before it completes, the returned task contains the Canceled value for the Status property.

適用対象