FlushAsync Method (CancellationToken)
Collapse the table of content
Expand the table of content

Stream.FlushAsync Method (CancellationToken)

.NET Framework (current version)
 

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

Namespace:   System.IO
Assembly:  mscorlib (in mscorlib.dll)

[ComVisibleAttribute(false)]
[HostProtectionAttribute(SecurityAction.LinkDemand, ExternalThreading = true)]
public virtual Task FlushAsync(
	CancellationToken cancellationToken
)

Parameters

cancellationToken
Type: System.Threading.CancellationToken

The token to monitor for cancellation requests. The default value is None.

Return Value

Type: System.Threading.Tasks.Task

A task that represents the asynchronous flush operation.

Exception Condition
ObjectDisposedException

The stream has been disposed.

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.

Universal Windows Platform
Available since 4.5
.NET Framework
Available since 4.5
Portable Class Library
Supported in: portable .NET platforms
Windows Phone Silverlight
Available since 8.0
Windows Phone
Available since 8.1
Return to top
Show:
© 2016 Microsoft