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