Method ReadAsync
| Edit this page View SourceReadAsync(byte[], int, int, CancellationToken)
Performs a read operation of the stream
Declaration
protected virtual Task<int> ReadAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken)
Parameters
Type | Name | Description |
---|---|---|
byte[] | buffer | The buffer to write the data into. |
int | offset | The byte offset in buffer at which to begin writing data from the stream. |
int | count | The maximum number of bytes to read. |
CancellationToken | cancellationToken | The token to monitor for cancellation requests. The default value is System.Threading.CancellationToken.None. |
Returns
Type | Description |
---|---|
Task<int> | 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. |
Applies to
Platforms and versions
Target | Versions |
---|---|
.NET Standard 2.0 | GitHub, v3.0, v2.2 |
.NET | GitHub, v3.0 |
.NET Windows | GitHub, v3.0 |
.NET Android | GitHub, v3.0 |
.NET iOS | GitHub, v3.0 |
.NET Framework | GitHub, v3.0, v2.2, v2.1, v2.0 |
UWP | GitHub, v3.0, v2.2 |
Xamarin.Android | v2.2, v2.1, v2.0 |
Xamarin.iOS | v2.2, v2.1, v2.0 |