TextReader.ReadAsync Método

Definição

Sobrecargas

Name Description
ReadAsync(Char[], Int32, Int32)

Lê um número máximo especificado de caracteres do leitor de texto atual de forma assíncrona e escreve os dados num buffer, começando no índice especificado.

ReadAsync(Memory<Char>, CancellationToken)

Lê assíncronamente os caracteres do fluxo atual para um bloco de memória.

ReadAsync(Char[], Int32, Int32)

Lê um número máximo especificado de caracteres do leitor de texto atual de forma assíncrona e escreve os dados num buffer, começando no índice especificado.

public:
 virtual System::Threading::Tasks::Task<int> ^ ReadAsync(cli::array <char> ^ buffer, int index, int count);
public virtual System.Threading.Tasks.Task<int> ReadAsync(char[] buffer, int index, int count);
[System.Runtime.InteropServices.ComVisible(false)]
public virtual System.Threading.Tasks.Task<int> ReadAsync(char[] buffer, int index, int count);
abstract member ReadAsync : char[] * int * int -> System.Threading.Tasks.Task<int>
override this.ReadAsync : char[] * int * int -> System.Threading.Tasks.Task<int>
[<System.Runtime.InteropServices.ComVisible(false)>]
abstract member ReadAsync : char[] * int * int -> System.Threading.Tasks.Task<int>
override this.ReadAsync : char[] * int * int -> System.Threading.Tasks.Task<int>
Public Overridable Function ReadAsync (buffer As Char(), index As Integer, count As Integer) As Task(Of Integer)

Parâmetros

buffer
Char[]

Quando este método regressa, contém o array de caracteres especificado com os valores entre index e (index + count - 1) substituídos pelos caracteres lidos da fonte atual.

index
Int32

A posição buffer em que começar a escrever.

count
Int32

O número máximo de caracteres para ler. Se o fim do texto for alcançado antes do número especificado de caracteres ser lido no buffer, o método atual retorna.

Devoluções

Uma tarefa que representa a operação de leitura assíncrona. O valor do TResult parâmetro contém o número total de bytes lidos no buffer. O valor do resultado pode ser inferior ao número de bytes solicitados se o número de bytes atualmente disponíveis for inferior ao número pedido, ou pode ser 0 (zero) se o fim do texto for alcançado.

Atributos

Exceções

buffer é null.

index ou count é negativo.

A soma de index e count é maior do que o comprimento do buffer.

O leitor de texto foi descartado.

O leitor está atualmente em uso por uma operação de leitura anterior.

Observações

A tarefa é concluída após o número de caracteres especificado pelo count parâmetro ser lido ou após o fim do ficheiro ser atingido.

A TextReader disciplina é uma disciplina abstrata. Portanto, não o instancias no teu código. Para um exemplo de utilização do ReadAsync método, veja o StreamReader.ReadAsync método.

Este método armazena na tarefa que devolve todas as exceções de não-utilização que o equivalente síncrono do método pode lançar. Se uma exceção for armazenada na tarefa devolvida, essa exceção será lançada quando a tarefa for aguardada. As exceções de uso, como ArgumentException, ainda são lançadas de forma síncrona. Para as exceções armazenadas, veja as exceções lançadas por Read(Char[], Int32, Int32).

Ver também

Aplica-se a

ReadAsync(Memory<Char>, CancellationToken)

Lê assíncronamente os caracteres do fluxo atual para um bloco de memória.

public virtual System.Threading.Tasks.ValueTask<int> ReadAsync(Memory<char> buffer, System.Threading.CancellationToken cancellationToken = default);
abstract member ReadAsync : Memory<char> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>
override this.ReadAsync : Memory<char> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>
Public Overridable Function ReadAsync (buffer As Memory(Of Char), Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Integer)

Parâmetros

buffer
Memory<Char>

Quando este método regressa, contém o bloco de memória especificado de caracteres substituído pelos caracteres lidos da fonte atual.

cancellationToken
CancellationToken

O token para monitorizar pedidos de cancelamento. O valor predefinido é None.

Devoluções

Uma tarefa de valor que representa a operação de leitura assíncrona. O valor do parâmetro de tipo contém o número de caracteres que foram lidos, ou 0 se no final do fluxo e nenhum dado foi lido. O número será inferior ou igual ao buffer comprimento, dependendo se os dados estão disponíveis dentro do fluxo.

Exceções

O token de cancelamento foi cancelado. Esta exceção é armazenada na tarefa devolvida.

Aplica-se a