NonCryptographicHashAlgorithm.AppendAsync(Stream, CancellationToken) Method

Definition

Namespace:

System.IO.Hashing

Assembly:

System.IO.Hashing.dll

Package:

System.IO.Hashing v9.0.0-preview.3.24172.9

Source:

NonCryptographicHashAlgorithm.cs

Asychronously reads the contents of stream and appends them to the data already processed for the current hash computation.

public System.Threading.Tasks.Task AppendAsync (System.IO.Stream stream, System.Threading.CancellationToken cancellationToken = default);

member this.AppendAsync : System.IO.Stream * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Function AppendAsync (stream As Stream, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

stream

Stream

The data to process.

cancellationToken

CancellationToken

The token to monitor for cancellation requests. The default value is None.

Returns

Task

A task that represents the asynchronous append operation.

Exceptions

ArgumentNullException

stream is null.

OperationCanceledException

The cancellation token was canceled. This exception is stored into the returned task.

Remarks

This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by Append(Stream).