File.WriteAllTextAsync 方法

定义

重载

WriteAllTextAsync(String, String, CancellationToken)

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

WriteAllTextAsync(String, String, Encoding, CancellationToken)

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

WriteAllTextAsync(String, String, CancellationToken)

Source:
File.cs
Source:
File.cs
Source:
File.cs

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

public static System.Threading.Tasks.Task WriteAllTextAsync (string path, string? contents, System.Threading.CancellationToken cancellationToken = default);
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

返回

表示异步写入操作的任务。

例外

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

注解

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

适用于

WriteAllTextAsync(String, String, Encoding, CancellationToken)

Source:
File.cs
Source:
File.cs
Source:
File.cs

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

public static System.Threading.Tasks.Task WriteAllTextAsync (string path, string? contents, System.Text.Encoding encoding, System.Threading.CancellationToken cancellationToken = default);
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

返回

表示异步写入操作的任务。

例外

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

注解

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

适用于