File.ReadAllTextAsync 方法

定义

命名空间:

System.IO

程序集:

System.Runtime.dll

重载

ReadAllTextAsync(String, CancellationToken)	异步打开文本文件，读取文件中的所有文本，然后关闭该文件。
ReadAllTextAsync(String, Encoding, CancellationToken)	异步打开文本文件，使用指定的编码读取文件中的所有文本，然后关闭该文件。

ReadAllTextAsync(String, CancellationToken)

Source:

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)

Source:

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)引发的异常。