File.ReadLinesAsync 方法

定义

命名空间:

System.IO

程序集:

System.Runtime.dll

重载

ReadLinesAsync(String, CancellationToken)	异步读取文件的行。
ReadLinesAsync(String, Encoding, CancellationToken)	异步读取具有指定编码的文件行。

ReadLinesAsync(String, CancellationToken)

Source:

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)

Source:

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