Stream. Read Async(Byte, Int32, Int32, CancellationToken) Method
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>
The buffer to write the data into.
The byte offset in
buffer at which to begin writing data from the stream.
The maximum number of bytes to read.
The token to monitor for cancellation requests. The default value is None.
A task that represents the asynchronous read operation. The value of the task object's
TResult parameter contains the total number of bytes read into the buffer. 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.
count is negative.
The sum of
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.
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. For more information, see Asynchronous Programming with Async and Await.