StreamWriter.FlushAsync Method

Definition

Overloads

FlushAsync()

Clears all buffers for this stream asynchronously and causes any buffered data to be written to the underlying device.

FlushAsync(CancellationToken)

Clears all buffers for this stream asynchronously and causes any buffered data to be written to the underlying device.

FlushAsync()

Clears all buffers for this stream asynchronously and causes any buffered data to be written to the underlying device.

public:
 override System::Threading::Tasks::Task ^ FlushAsync();
public override System.Threading.Tasks.Task FlushAsync ();
[System.Runtime.InteropServices.ComVisible(false)]
public override System.Threading.Tasks.Task FlushAsync ();
override this.FlushAsync : unit -> System.Threading.Tasks.Task
[<System.Runtime.InteropServices.ComVisible(false)>]
override this.FlushAsync : unit -> System.Threading.Tasks.Task
Public Overrides Function FlushAsync () As Task

Returns

A task that represents the asynchronous flush operation.

Attributes

Exceptions

The stream has been disposed.

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

Applies to

FlushAsync(CancellationToken)

Clears all buffers for this stream asynchronously 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 CancellationToken to monitor for cancellation requests.

Returns

A Task that represents the asynchronous flush operation.

Exceptions

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

Applies to