UnmanagedMemoryStream.FlushAsync(CancellationToken) Method

Definition

Namespace:

System.IO

Assembly:

System.Runtime.dll

Source:

UnmanagedMemoryStream.cs

Overrides the FlushAsync(CancellationToken) method so that the operation is cancelled if specified, but no other action is performed.

public:
 override System::Threading::Tasks::Task ^ FlushAsync(System::Threading::CancellationToken cancellationToken);

public override System.Threading.Tasks.Task FlushAsync (System.Threading.CancellationToken cancellationToken);

override this.FlushAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Overrides Function FlushAsync (cancellationToken As CancellationToken) As Task

Parameters

cancellationToken

CancellationToken

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

Returns

Task

A task that represents the asynchronous flush operation.

Exceptions

OperationCanceledException

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

Remarks

If the operation isn't cancelled, the UnmanagedMemoryStream calls the Flush method, which means that no action performed.

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