TextWriter.FlushAsync Method

Definition

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.

C#
public virtual System.Threading.Tasks.Task FlushAsync();
C#
[System.Runtime.InteropServices.ComVisible(false)]
public virtual System.Threading.Tasks.Task FlushAsync();

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

.NET 9 and other versions
Product Versions
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.0, 2.1
UWP 10.0

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.

C#
public virtual System.Threading.Tasks.Task FlushAsync(System.Threading.CancellationToken cancellationToken);

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.

Applies to

.NET 9 and .NET 8
Product Versions
.NET 8, 9