TextWriter.FlushAsync Method
Definition
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.
Overloads
FlushAsync() |
Asynchronously clears all buffers for the current writer and causes any buffered data to be written to the underlying device. |
FlushAsync(CancellationToken) |
Asynchronously clears all buffers for the current writer and causes any buffered data to be written to the underlying device. |
FlushAsync()
- Source:
- TextWriter.cs
- Source:
- TextWriter.cs
- Source:
- TextWriter.cs
Asynchronously clears all buffers for the current writer and causes any buffered data to be written to the underlying device.
public:
virtual System::Threading::Tasks::Task ^ FlushAsync();
public virtual System.Threading.Tasks.Task FlushAsync ();
[System.Runtime.InteropServices.ComVisible(false)]
public virtual System.Threading.Tasks.Task FlushAsync ();
abstract member FlushAsync : unit -> System.Threading.Tasks.Task
override this.FlushAsync : unit -> System.Threading.Tasks.Task
[<System.Runtime.InteropServices.ComVisible(false)>]
abstract member FlushAsync : unit -> System.Threading.Tasks.Task
override this.FlushAsync : unit -> System.Threading.Tasks.Task
Public Overridable Function FlushAsync () As Task
Returns
A task that represents the asynchronous flush operation.
- Attributes
Exceptions
The text writer is disposed.
The writer is currently in use by a previous write operation.
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().
See also
Applies to
FlushAsync(CancellationToken)
- Source:
- TextWriter.cs
- Source:
- TextWriter.cs
Asynchronously clears all buffers for the current writer and causes any buffered data to be written to the underlying device.
public:
virtual System::Threading::Tasks::Task ^ FlushAsync(System::Threading::CancellationToken cancellationToken);
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
Public Overridable 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 text writer is disposed.
The writer is currently in use by a previous write operation.
The cancellation token was canceled. This exception is stored into the returned task.