File.AppendAllTextAsync Method

Definition

Namespace:

System.IO

Assembly:

System.Runtime.dll

Overloads

AppendAllTextAsync(String, String, CancellationToken)	Asynchronously opens a file or creates a file if it does not already exist, appends the specified string to the file, and then closes the file.
AppendAllTextAsync(String, String, Encoding, CancellationToken)	Asynchronously opens a file or creates the file if it does not already exist, appends the specified string to the file using the specified encoding, and then closes the file.

AppendAllTextAsync(String, String, CancellationToken)

Source:

File.cs

Asynchronously opens a file or creates a file if it does not already exist, appends the specified string to the file, and then closes the file.

public static System.Threading.Tasks.Task AppendAllTextAsync (string path, string? contents, System.Threading.CancellationToken cancellationToken = default);

static member AppendAllTextAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Shared Function AppendAllTextAsync (path As String, contents As String, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

path

String

The file to append the specified string to.

contents

String

The string to append to the file.

cancellationToken

CancellationToken

The token to monitor for cancellation requests. The default value is None.

Returns

Task

A task that represents the asynchronous append operation.

Exceptions

OperationCanceledException

The cancellation token was canceled. This exception is stored into the returned task.

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 AppendAllText(String, String).

AppendAllTextAsync(String, String, Encoding, CancellationToken)

Source:

File.cs

Asynchronously opens a file or creates the file if it does not already exist, appends the specified string to the file using the specified encoding, and then closes the file.

public static System.Threading.Tasks.Task AppendAllTextAsync (string path, string? contents, System.Text.Encoding encoding, System.Threading.CancellationToken cancellationToken = default);

static member AppendAllTextAsync : string * string * System.Text.Encoding * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Shared Function AppendAllTextAsync (path As String, contents As String, encoding As Encoding, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

path

String

The file to append the specified string to.

contents

String

The string to append to the file.

encoding

Encoding

The character encoding to use.

cancellationToken

CancellationToken

The token to monitor for cancellation requests. The default value is None.

Returns

Task

A task that represents the asynchronous append operation.

Exceptions

OperationCanceledException

The cancellation token was canceled. This exception is stored into the returned task.

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 AppendAllText(String, String, Encoding).