Stream.FlushAsync Method

Definition

Namespace:
System.IO
Assemblies:
System.IO.dll, mscorlib.dll, netstandard.dll, System.Runtime.dll

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

Overloads

FlushAsync(CancellationToken)

Asynchronously clears all buffers for this stream, causes any buffered data to be written to the underlying device, and monitors cancellation requests.
FlushAsync()

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

FlushAsync(CancellationToken)

Asynchronously clears all buffers for this stream, causes any buffered data to be written to the underlying device, and monitors cancellation requests.

public:
 virtual System::Threading::Tasks::Task ^ FlushAsync(System::Threading::CancellationToken cancellationToken);
[System.Runtime.InteropServices.ComVisible(false)]
public virtual System.Threading.Tasks.Task FlushAsync (System.Threading.CancellationToken cancellationToken);
abstract member FlushAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.FlushAsync : System.Threading.CancellationToken -> System.Threading.Tasks.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.

Attributes
ComVisibleAttribute

Exceptions

ObjectDisposedException

The stream has been disposed.

Remarks

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

If a derived class, such as DeflateStream or GZipStream, does not flush the buffer in its implementation of the Flush method, the FlushAsync method will not flush the buffer.

See also

FlushAsync()

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

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

Returns

Task

A task that represents the asynchronous flush operation.

Attributes
ComVisibleAttribute

Exceptions

ObjectDisposedException

The stream has been disposed.

Remarks

If a derived class, such as DeflateStream or GZipStream, does not flush the buffer in its implementation of the Flush method, the FlushAsync method will not flush the buffer.

Applies to