File.ReadAllTextAsync メソッド

定義

名前空間:

System.IO

アセンブリ:

System.Runtime.dll

オーバーロード

ReadAllTextAsync(String, Encoding, CancellationToken)	テキスト ファイルを非同期に開き、指定のエンコーディングが適用されたファイルのすべてのテキストを読み取った後、ファイルを閉じます。
ReadAllTextAsync(String, CancellationToken)	テキスト ファイルを非同期に開き、ファイルのすべてのテキストを読み取った後、ファイルを閉じます。

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

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