Show / Hide Table of Contents

Method ReadAsync

| Edit this page View Source

ReadAsync(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
TargetVersions
.NET Standard 2.0main, v3.0, v2.2
.NETmain, v3.0
.NET Windowsmain, v3.0
.NET Androidmain, v3.0
.NET iOSmain, v3.0
.NET Frameworkmain, v3.0, v2.2, v2.1, v2.0
UWPmain, v3.0, v2.2
Xamarin.Androidv2.2, v2.1, v2.0
Xamarin.iOSv2.2, v2.1, v2.0
  • Edit this page
  • View Source
In this article
Back to top Generated by DocFX