Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Stream.FlushAsync Method
Definition
- Namespace:
- System.IO
- Assemblies:
- mscorlib.dll, System.IO.dll
- Assemblies:
- netstandard.dll, System.Runtime.dll
- Assembly:
- System.IO.dll
- Assembly:
- System.Runtime.dll
- Assembly:
- mscorlib.dll
- Assembly:
- netstandard.dll
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Asynchronously clears all buffers for this stream and causes any buffered data to be written to the underlying device.
Overloads
| Name | Description |
|---|---|
| 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. |
FlushAsync()
- Source:
- Stream.cs
- Source:
- Stream.cs
- Source:
- Stream.cs
- Source:
- Stream.cs
- Source:
- Stream.cs
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();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[<System.Runtime.InteropServices.ComVisible(false)>]
member this.FlushAsync : unit -> System.Threading.Tasks.TaskPublic Function FlushAsync () As TaskReturns
A task that represents the asynchronous flush operation.
- Attributes
Exceptions
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.
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)
- Source:
- Stream.cs
- Source:
- Stream.cs
- Source:
- Stream.cs
- Source:
- Stream.cs
- Source:
- Stream.cs
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);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[<System.Runtime.InteropServices.ComVisible(false)>]
abstract member FlushAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.FlushAsync : System.Threading.CancellationToken -> System.Threading.Tasks.TaskPublic Overridable Function FlushAsync (cancellationToken As CancellationToken) As TaskParameters
- cancellationToken
- CancellationToken
The token to monitor for cancellation requests. The default value is None.
Returns
A task that represents the asynchronous flush operation.
- Attributes
Exceptions
The stream has been disposed.
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 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.
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().
See also
Applies to
Feedback
Was this page helpful?