File.ReadAllTextAsync メソッド

定義

名前空間:

System.IO

アセンブリ:

System.Runtime.dll

オーバーロード

ReadAllTextAsync(String, CancellationToken)	テキスト ファイルを非同期的に開き、ファイル内のすべてのテキストを読み取って、ファイルを閉じます。
ReadAllTextAsync(String, Encoding, CancellationToken)	テキスト ファイルを非同期的に開き、指定したエンコードを使用してファイル内のすべてのテキストを読み取り、ファイルを閉じます。

ReadAllTextAsync(String, CancellationToken)

ソース:

File.cs

テキスト ファイルを非同期的に開き、ファイル内のすべてのテキストを読み取って、ファイルを閉じます。

public static System.Threading.Tasks.Task<string> ReadAllTextAsync (string path, System.Threading.CancellationToken cancellationToken = default);

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

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

パラメーター

path

String

読み取り用に開くファイル。

cancellationToken

CancellationToken

キャンセル要求を監視するトークン。 既定値は Noneです。

戻り値

Task<String>

非同期読み取り操作を表すタスク。ファイル内のすべてのテキストを含む文字列をラップします。

例外

OperationCanceledException

キャンセル トークンが取り消されました。 この例外は、返されたタスクに格納されます。

注釈

このメソッドは、メソッドの同期的な例外がスローできるすべての非使用例外を返すタスクに格納します。 返されたタスクに例外が格納されている場合、その例外はタスクが待機しているときにスローされます。 ArgumentExceptionなどの使用例外は、引き続き同期的にスローされます。 格納されている例外については、ReadAllText(String)によってスローされる例外を参照してください。

ReadAllTextAsync(String, Encoding, CancellationToken)

ソース:

File.cs

テキスト ファイルを非同期的に開き、指定したエンコードを使用してファイル内のすべてのテキストを読み取り、ファイルを閉じます。

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

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

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

パラメーター

path

String

読み取り用に開くファイル。

encoding

Encoding

ファイルの内容に適用されるエンコード。

cancellationToken

CancellationToken

キャンセル要求を監視するトークン。 既定値は Noneです。

戻り値

Task<String>

非同期読み取り操作を表すタスク。ファイル内のすべてのテキストを含む文字列をラップします。

例外

OperationCanceledException

キャンセル トークンが取り消されました。 この例外は、返されたタスクに格納されます。

注釈

このメソッドは、メソッドの同期的な例外がスローできるすべての非使用例外を返すタスクに格納します。 返されたタスクに例外が格納されている場合、その例外はタスクが待機しているときにスローされます。 ArgumentExceptionなどの使用例外は、引き続き同期的にスローされます。 格納されている例外については、ReadAllText(String, Encoding)によってスローされる例外を参照してください。