File.ReadAllTextAsync 方法

定義

命名空間:

System.IO

組件:

netstandard.dll, System.Runtime.dll

多載

名稱	Description
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)拋出的例外。