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)によってスローされる例外を参照してください。