MemoryStream.ReadAsync MemoryStream.ReadAsync MemoryStream.ReadAsync Method

定義

オーバーロード

ReadAsync(Memory<Byte>, CancellationToken) ReadAsync(Memory<Byte>, CancellationToken)
ReadAsync(Byte[], Int32, Int32, CancellationToken) ReadAsync(Byte[], Int32, Int32, CancellationToken) ReadAsync(Byte[], Int32, Int32, CancellationToken)

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

ReadAsync(Memory<Byte>, CancellationToken) ReadAsync(Memory<Byte>, CancellationToken)

public override System.Threading.Tasks.ValueTask<int> ReadAsync (Memory<byte> destination, System.Threading.CancellationToken cancellationToken = null);
override this.ReadAsync : Memory<byte> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>

パラメーター

destination
Memory<Byte>

戻り値

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

現在のストリームからバイト シーケンスを非同期に読み取り、読み取ったバイト数だけストリーム内の位置を進め、キャンセル要求を監視します。Asynchronously reads a sequence of bytes from the current stream, 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);
[System.Runtime.InteropServices.ComVisible(false)]
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>

パラメーター

buffer
Byte[]

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

offset
Int32 Int32 Int32

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

count
Int32 Int32 Int32

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

cancellationToken
CancellationToken CancellationToken CancellationToken

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

戻り値

非同期の読み取り操作を表すタスク。A task that represents the asynchronous read operation. TResult パラメーターの値には、バッファーに読み込まれるバイトの合計数が含まれます。The value of the TResult parameter contains the total number of bytes read into the buffer. 現在使用できるバイト数が要求した数より小さい場合、結果の値は要求したバイト数より小さくなることがあります。また、ストリームの末尾に到達した場合は 0 になることがあります。The result value 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.

注釈

完了前に、操作が取り消された場合、返されたタスクが含まれています、Canceled値、Statusプロパティ。If the operation is canceled before it completes, the returned task contains the Canceled value for the Status property.

インスタンスを作成して、キャンセル トークンを作成することができます、CancellationTokenSourceクラスを渡して、Tokenプロパティとして、cancellationTokenパラメーター。You can create a cancellation token by creating an instance of the CancellationTokenSource class and passing the Token property as the cancellationToken parameter.

適用対象