PipeStream.FlushAsync(CancellationToken) Method

Definition

Namespace:

System.IO.Pipes

Assembly:

System.IO.Pipes.dll

Source:

PipeStream.cs

Asynchronously clears the buffer for the current stream and causes any buffered data to be written to the underlying device.

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