File.WriteAllTextAsync 方法

定义

命名空间:

System.IO

程序集:

netstandard.dll

重载

名称	说明
WriteAllTextAsync(String, String, CancellationToken)	异步创建一个新文件，将指定的字符串写入文件，然后关闭该文件。 如果目标文件已存在，则会截断并覆盖该文件。
WriteAllTextAsync(String, String, Encoding, CancellationToken)	异步创建一个新文件，使用指定的编码将指定的字符串写入文件，然后关闭该文件。 如果目标文件已存在，则会截断并覆盖该文件。

WriteAllTextAsync(String, String, CancellationToken)

异步创建一个新文件，将指定的字符串写入文件，然后关闭该文件。 如果目标文件已存在，则会截断并覆盖该文件。

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

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

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

参数

path

String

要写入的文件。

contents

String

要写入文件的字符串。

cancellationToken

CancellationToken

用于监视取消请求的令牌。 默认值为 None。

返回

Task

表示异步写入作的任务。

例外

OperationCanceledException

取消令牌已取消。 此异常存储在返回的任务中。

注解

此方法存储在任务中，它返回该方法的同步对应项可以引发的所有非使用异常。 如果异常存储在返回的任务中，则等待任务时将引发该异常。 使用情况异常（例如 ArgumentException）仍会同步引发。 有关存储的异常，请参阅由 WriteAllText(String, String)..

WriteAllTextAsync(String, String, Encoding, CancellationToken)

异步创建一个新文件，使用指定的编码将指定的字符串写入文件，然后关闭该文件。 如果目标文件已存在，则会截断并覆盖该文件。

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

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

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

参数

path

String

要写入的文件。

contents

String

要写入文件的字符串。

encoding

Encoding

要应用于字符串的编码。

cancellationToken

CancellationToken

用于监视取消请求的令牌。 默认值为 None。

返回

Task

表示异步写入作的任务。

例外

OperationCanceledException

取消令牌已取消。 此异常存储在返回的任务中。

注解

此方法存储在任务中，它返回该方法的同步对应项可以引发的所有非使用异常。 如果异常存储在返回的任务中，则等待任务时将引发该异常。 使用情况异常（例如 ArgumentException）仍会同步引发。 有关存储的异常，请参阅由 WriteAllText(String, String, Encoding)..