Version:

ReadAsync(byte[] buffer, int offset, int count, System.Threading.CancellationToken cancellationToken) Method

Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.

Syntax

public virtual Task<int> ReadAsync(byte[] buffer, int offset, int count, System.Threading.CancellationToken cancellationToken)

Parameters

buffer: Type: byte[]
An array of bytes. When this method returns, the buffer contains the specified byte array with the values between offset and (offset + count - 1) replaced by the bytes read from the current source.

offset: Type: int
The zero-based byte offset in buffer at which to begin storing the data read from the current stream.

count: Type: int
The maximum number of bytes to be read from the current stream.

cancellationToken: Type: System.Threading.CancellationToken
The cancellation token.

Returns

The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if the end of the stream has been reached.

Exceptions

System.ObjectDisposedException	Methods were called after the stream was closed.
System.ArgumentException	The sum of offset and count is larger than the buffer length.
System.ArgumentNullException	buffer is null (Nothing in Visual Basic).
System.ArgumentOutOfRangeException	offset or count is negative.