File.ReadLinesAsync Método

Definição

Namespace:

System.IO

Assembly:

System.Runtime.dll

Sobrecargas

ReadLinesAsync(String, CancellationToken)	Lê as linhas de um arquivo de forma assíncrona.
ReadLinesAsync(String, Encoding, CancellationToken)	Lê de forma assíncrona as linhas de um arquivo que tem uma codificação especificada.

ReadLinesAsync(String, CancellationToken)

Origem:

File.cs

Lê as linhas de um arquivo de forma assíncrona.

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)

Parâmetros

path

String

O arquivo a ser lido.

cancellationToken

CancellationToken

O token a se monitorar para solicitações de cancelamento. O valor padrão é None.

Retornos

IAsyncEnumerable<String>

O enumerável assíncrono que representa todas as linhas do arquivo ou as linhas que são o resultado de uma consulta.

Exceções

OperationCanceledException

O token de cancelamento foi cancelado. Essa exceção é armazenada na tarefa retornada.

Comentários

Esse método armazena na tarefa que retorna todas as exceções de não uso que a contraparte síncrona do método pode gerar. Se uma exceção for armazenada na tarefa retornada, essa exceção será gerada quando a tarefa for aguardada. Exceções de uso, como ArgumentException, ainda são geradas de forma síncrona. Para as exceções armazenadas, consulte as exceções geradas por ReadLines(String).

ReadLinesAsync(String, Encoding, CancellationToken)

Origem:

File.cs

Lê de forma assíncrona as linhas de um arquivo que tem uma codificação especificada.

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)

Parâmetros

path

String

O arquivo a ser lido.

encoding

Encoding

A codificação aplicada ao conteúdo do arquivo.

cancellationToken

CancellationToken

O token a se monitorar para solicitações de cancelamento. O valor padrão é None.

Retornos

IAsyncEnumerable<String>

O enumerável assíncrono que representa todas as linhas do arquivo ou as linhas que são o resultado de uma consulta.

Exceções

OperationCanceledException

O token de cancelamento foi cancelado. Essa exceção é armazenada na tarefa retornada.

Comentários

Esse método armazena na tarefa que retorna todas as exceções de não uso que a contraparte síncrona do método pode gerar. Se uma exceção for armazenada na tarefa retornada, essa exceção será gerada quando a tarefa for aguardada. Exceções de uso, como ArgumentException, ainda são geradas de forma síncrona. Para as exceções armazenadas, consulte as exceções geradas por ReadLines(String, Encoding).