ReadAsync(byte[] buffer, int offset, int count, System.Threading.CancellationToken cancellationToken) Method
Asynchronously 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[]
The buffer to write the data into.
- offset
- Type: int
The byte offset in buffer at which to begin writing data from the stream.
- count
- Type: int
The maximum number of bytes to read.
- cancellationToken
- Type: System.Threading.CancellationToken
The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None.
Returns
A task that represents the asynchronous read operation. The value of the TResult
parameter contains the total number of bytes read into the buffer. 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.
