CryptoStream.FlushFinalBlockAsync(CancellationToken) Method

Definition

Namespace:

System.Security.Cryptography

Assembly:

System.Security.Cryptography.dll

Source:

CryptoStream.cs

Asynchronously updates the underlying data source or repository with the current state of the buffer, then clears the buffer.

public System.Threading.Tasks.ValueTask FlushFinalBlockAsync (System.Threading.CancellationToken cancellationToken = default);

member this.FlushFinalBlockAsync : System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask

Public Function FlushFinalBlockAsync (Optional cancellationToken As CancellationToken = Nothing) As ValueTask

Parameters

cancellationToken

CancellationToken

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

Returns

ValueTask

A task that represents the asynchronous flush operation.

Exceptions

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 FlushFinalBlock().