Parameters

buffer

The buffer to write the data into.

offset

The byte offset in buffer at which to begin writing data from the stream.

count

The maximum number of bytes to read.

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 task object's TResult parameter contains the total number of bytes read into the buffer. The result 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.

Remarks

You must preface your call to CryptoStream.ReadAsync(Byte[], int, int, System.Threading.CancellationToken) with the await (C#) or Await (Visual Basic) operator to suspend execution of the method until the task is complete. For more information, see Asynchronous Programming with Async and Await (C# and Visual Basic).

If the operation is canceled before it completes, the returned task contains the System.Threading.Tasks.TaskStatus.Canceled value for the System.Threading.Tasks.Task.Status property.

Requirements