TextReader.ReadAsync Método
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Sobrecargas
| Nome | Description |
|---|---|
| ReadAsync(Char[], Int32, Int32) |
Lê um número máximo especificado de caracteres do leitor de texto atual de forma assíncrona e grava os dados em um buffer, começando no índice especificado. |
| ReadAsync(Memory<Char>, CancellationToken) |
Lê de forma assíncrona os caracteres do fluxo atual em 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 grava os dados em um 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 esse método é retornado, contém a matriz de caracteres especificada com os valores entre index e (index + count - 1) substituídos pelos caracteres lidos da fonte atual.
- index
- Int32
A posição na buffer qual começar a escrever.
- count
- Int32
O número máximo de caracteres a serem lidos. Se o final do texto for atingido antes que o número especificado de caracteres seja lido no buffer, o método atual retornará.
Retornos
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 menor do que o número de bytes solicitados se o número de bytes atualmente disponível for menor que o número solicitado ou pode ser 0 (zero) se o final do texto tiver sido atingido.
- Atributos
Exceções
buffer é null.
index ou count é negativo.
A soma de index e count é maior que o comprimento do buffer.
O leitor de texto foi descartado.
O leitor está atualmente em uso por uma operação de leitura anterior.
Comentários
A tarefa é concluída depois que o número de caracteres especificado pelo count parâmetro é lido ou o final do arquivo é atingido.
A TextReader classe é uma classe abstrata. Portanto, você não instanciá-lo em seu código. Para obter um exemplo de como usar o ReadAsync método, consulte o StreamReader.ReadAsync método.
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 Read(Char[], Int32, Int32).
Confira também
- ReadAsync(Char[], Int32, Int32)
- ReadAsync(Char[], Int32, Int32)
- E/S de arquivo e de fluxo
- Como ler texto de um arquivo
- Como gravar texto em um arquivo
Aplica-se a
ReadAsync(Memory<Char>, CancellationToken)
Lê de forma assíncrona os caracteres do fluxo atual em 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
Quando esse método é retornado, contém o bloco de memória especificado dos caracteres substituídos pelos caracteres lidos da origem atual.
- cancellationToken
- CancellationToken
O token a ser monitorado para solicitações de cancelamento. O valor padrão é None.
Retornos
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á menor ou igual ao buffer comprimento, dependendo se os dados estão disponíveis dentro do fluxo.
Exceções
O token de cancelamento foi cancelado. Essa exceção é armazenada na tarefa retornada.