MemoryStream.FlushAsync(CancellationToken) Method

Definition

Namespace:

System.IO

Assembly:

System.Runtime.dll

Source:

MemoryStream.cs

Asynchronously clears all buffers for this stream, and monitors cancellation requests.

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.

Returns

Task

A task that represents the asynchronous flush operation.

Exceptions

ObjectDisposedException

The stream has been disposed.

OperationCanceledException

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

Remarks

Because any data written to a MemoryStream object is written into RAM, this method is redundant.

If the operation is canceled before it completes, the returned task contains the Canceled value for the Status property.

You can create a cancellation token by creating an instance of the CancellationTokenSource class and passing the Token property as the cancellationToken parameter.

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

See also

• Cancellation