| StreamExtensionsFlushAsync Method (Stream, CancellationToken) |
Asynchronously clears all buffers for a stream and causes any buffered data to be written to the underlying device,
and monitors cancellation requests.
Namespace: Rackspace.Threading
Assembly: Rackspace.Threading (in Rackspace.Threading.dll) Version: 2.1.0-beta1
Syntaxpublic static Task FlushAsync( this Stream stream, CancellationToken cancellationToken )
Parameters
- stream
- Type: System.IOStream
The stream to flush. - cancellationToken
- Type: System.ThreadingCancellationToken
The token to monitor for cancellation requests. The default value is None.
Return Value
Type: TaskA task that represents the asynchronous flush operation.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type Stream. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).Exceptions| Exception | Condition |
|---|---|
| ArgumentNullException | If stream is . |
| ObjectDisposedException | If stream has been disposed. |
RemarksIf the operation is canceled before it completes, the returned task contains the Canceled value for the Status property.
If a derived class does not flush the buffer in its implementation of the Flush method, the FlushAsync(Stream) method will not flush the buffer.
Version Information.NET for Windows Store apps
Supported in: Windows 8.NET Framework
Supported in: 4.5, 4.0, 3.5Portable Class Library
Supported in: Portable Class Library (Legacy), Portable Class LibraryThreading Library
Supported in: 2.1, 2.0, 1.1, 1.0See Also