TextWriter.FlushAsync Method

Definition

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

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

Task

A task that represents the asynchronous flush operation.

Attributes
ComVisibleAttribute

Exceptions

ObjectDisposedException

The text writer is disposed.

InvalidOperationException

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().

Applies to

See also