File.ReadAllTextAsync Método

Definição

Namespace:

System.IO

Assembly:

System.Runtime.dll

Sobrecargas

ReadAllTextAsync(String, CancellationToken)	Abre um arquivo de texto de forma assíncrona, lê todo o texto no arquivo e fecha o arquivo.
ReadAllTextAsync(String, Encoding, CancellationToken)	Abre um arquivo de texto de forma assíncrona, lê todo o texto no arquivo com a codificação especificada e fecha o arquivo.

ReadAllTextAsync(String, CancellationToken)

Origem:

File.cs

Abre um arquivo de texto de forma assíncrona, lê todo o texto no arquivo e fecha o arquivo.

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)

Parâmetros

path

String

O arquivo a ser aberto para leitura.

cancellationToken

CancellationToken

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

Retornos

Task<String>

Uma tarefa que representa a operação de leitura assíncrona, que encapsula a cadeia de caracteres que contém todo o texto no arquivo.

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 o equivalente síncrono 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 ReadAllText(String).

ReadAllTextAsync(String, Encoding, CancellationToken)

Origem:

File.cs

Abre um arquivo de texto de forma assíncrona, lê todo o texto no arquivo com a codificação especificada e fecha o arquivo.

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)

Parâmetros

path

String

O arquivo a ser aberto para leitura.

encoding

Encoding

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

cancellationToken

CancellationToken

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

Retornos

Task<String>

Uma tarefa que representa a operação de leitura assíncrona, que encapsula a cadeia de caracteres que contém todo o texto no arquivo.

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 o equivalente síncrono 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 ReadAllText(String, Encoding).