File.ReadLinesAsync 方法

定義

命名空間:

System.IO

組件:

System.Runtime.dll

多載

ReadLinesAsync(String, CancellationToken)	以異步方式讀取檔案的行。
ReadLinesAsync(String, Encoding, CancellationToken)	以異步方式讀取具有指定編碼方式的檔案行。

ReadLinesAsync(String, CancellationToken)

來源:

File.cs

以異步方式讀取檔案的行。

public static System.Collections.Generic.IAsyncEnumerable<string> ReadLinesAsync (string path, System.Threading.CancellationToken cancellationToken = default);

static member ReadLinesAsync : string * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<string>

Public Shared Function ReadLinesAsync (path As String, Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of String)

參數

path

String

要讀取的檔案。

cancellationToken

CancellationToken

用來監視是否有取消要求的語彙基元。 預設值是 None。

傳回

IAsyncEnumerable<String>

異步列舉，表示檔案的所有行，或是查詢結果的行。

例外狀況

OperationCanceledException

取消標記已取消。 此例外狀況會儲存在傳回的工作中。

備註

這個方法會儲存在工作中，它會傳回方法同步對應專案可以擲回的所有非使用例外狀況。 如果例外狀況儲存在傳回的工作中，則會在等候工作時擲回該例外狀況。 使用例外狀況，例如 ArgumentException仍會同步擲回。 如需預存例外狀況，請參閱 擲回的 ReadLines(String)例外狀況。

ReadLinesAsync(String, Encoding, CancellationToken)

來源:

File.cs

以異步方式讀取具有指定編碼方式的檔案行。

public static System.Collections.Generic.IAsyncEnumerable<string> ReadLinesAsync (string path, System.Text.Encoding encoding, System.Threading.CancellationToken cancellationToken = default);

static member ReadLinesAsync : string * System.Text.Encoding * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<string>

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

參數

path

String

要讀取的檔案。

encoding

Encoding

套用至檔案內容的編碼方式。

cancellationToken

CancellationToken

用來監視是否有取消要求的語彙基元。 預設值是 None。

傳回

IAsyncEnumerable<String>

異步列舉，表示檔案的所有行，或是查詢結果的行。

例外狀況

OperationCanceledException

取消標記已取消。 此例外狀況會儲存在傳回的工作中。

備註

這個方法會儲存在工作中，它會傳回方法同步對應專案可以擲回的所有非使用例外狀況。 如果例外狀況儲存在傳回的工作中，則會在等候工作時擲回該例外狀況。 使用例外狀況，例如 ArgumentException仍會同步擲回。 如需預存例外狀況，請參閱 擲回的 ReadLines(String, Encoding)例外狀況。