File.WriteAllTextAsync 方法

定義

命名空間:

System.IO

組件:

System.Runtime.dll

多載

WriteAllTextAsync(String, String, CancellationToken)	以非同步方式建立新檔案，將指定的字串寫入檔案，然後關閉檔案。 如果目標檔案已經存在，則會遭到截斷並覆寫。
WriteAllTextAsync(String, String, Encoding, CancellationToken)	以非同步方式建立新檔案，使用指定編碼方式將指定的字串寫入檔案，然後關閉檔案。 如果目標檔案已經存在，則會遭到截斷並覆寫。

WriteAllTextAsync(String, String, CancellationToken)

來源:

File.cs

以非同步方式建立新檔案，將指定的字串寫入檔案，然後關閉檔案。 如果目標檔案已經存在，則會遭到截斷並覆寫。

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)

來源:

File.cs

以非同步方式建立新檔案，使用指定編碼方式將指定的字串寫入檔案，然後關閉檔案。 如果目標檔案已經存在，則會遭到截斷並覆寫。

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)例外狀況。