BufferedStream::ReadAsync Method (array<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.
Assembly: mscorlib (in mscorlib.dll)
public: virtual Task<int>^ ReadAsync( array<unsigned char>^ buffer, int offset, int count, CancellationToken cancellationToken ) override
Parameters
- buffer
-
Type:
array<System::Byte>^
The buffer to write the data into.
- offset
-
Type:
System::Int32
The byte offset in buffer at which to begin writing data from the stream.
- count
-
Type:
System::Int32
The maximum number of bytes to read.
- cancellationToken
-
Type:
System.Threading::CancellationToken
The token to monitor for cancellation requests.
Return Value
Type: System.Threading.Tasks::Task<Int32>^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.
| Exception | Condition |
|---|---|
| ArgumentNullException | buffer is null. |
| ArgumentOutOfRangeException | offset or count is negative. |
| ArgumentException | The sum of offset and count is larger than the buffer length. |
| NotSupportedException | The stream does not support reading. |
| ObjectDisposedException | The stream has been disposed. |
| InvalidOperationException | The stream is currently in use by a previous read operation. |
You can create a cancellation token by creating an instance of the CancellationTokenSource class and passing the Token property as the cancellationToken parameter.
Available since 4.5