GZipStream.FlushAsync(CancellationToken) Method

Definition

Asynchronously clears all buffers for this GZip stream, causes any buffered data to be written to the underlying device, 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. The default value is None.

Returns

A task that represents the asynchronous flush operation.

Exceptions

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

Remarks

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

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

Applies to