File.WriteAllLinesAsync Method

Definition

Namespace:

System.IO

Assembly:

System.Runtime.dll

Overloads

WriteAllLinesAsync(String, IEnumerable<String>, CancellationToken)	Asynchronously creates a new file, writes the specified lines to the file, and then closes the file.
WriteAllLinesAsync(String, IEnumerable<String>, Encoding, CancellationToken)	Asynchronously creates a new file, write the specified lines to the file by using the specified encoding, and then closes the file.

WriteAllLinesAsync(String, IEnumerable<String>, CancellationToken)

Source:

File.cs

Asynchronously creates a new file, writes the specified lines to the file, and then closes the file.

public static System.Threading.Tasks.Task WriteAllLinesAsync (string path, System.Collections.Generic.IEnumerable<string> contents, System.Threading.CancellationToken cancellationToken = default);

static member WriteAllLinesAsync : string * seq<string> * System.Threading.CancellationToken -> System.Threading.Tasks.Task

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

Parameters

path

String

The file to write to.

contents

IEnumerable<String>

The lines to write 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 write 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 WriteAllLines(String, IEnumerable<String>).

WriteAllLinesAsync(String, IEnumerable<String>, Encoding, CancellationToken)

Source:

File.cs

Asynchronously creates a new file, write the specified lines to the file by using the specified encoding, and then closes the file.

public static System.Threading.Tasks.Task WriteAllLinesAsync (string path, System.Collections.Generic.IEnumerable<string> contents, System.Text.Encoding encoding, System.Threading.CancellationToken cancellationToken = default);

static member WriteAllLinesAsync : string * seq<string> * System.Text.Encoding * System.Threading.CancellationToken -> System.Threading.Tasks.Task

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

Parameters

path

String

The file to write to.

contents

IEnumerable<String>

The lines to write 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 write 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 WriteAllLines(String, IEnumerable<String>, Encoding).