StreamReader.ReadBlockAsync 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
| ReadBlockAsync(Memory<Char>, CancellationToken) |
Lê de forma assíncrona os caracteres do fluxo atual e grava os dados em um buffer. |
| ReadBlockAsync(Char[], Int32, Int32) |
Lê um máximo especificado de caracteres do fluxo atual de forma assíncrona e grava os dados em um buffer, começando no índice especificado. |
ReadBlockAsync(Memory<Char>, CancellationToken)
- Origem:
- StreamReader.cs
- Origem:
- StreamReader.cs
- Origem:
- StreamReader.cs
Lê de forma assíncrona os caracteres do fluxo atual e grava os dados em um buffer.
public override System.Threading.Tasks.ValueTask<int> ReadBlockAsync (Memory<char> buffer, System.Threading.CancellationToken cancellationToken = default);override this.ReadBlockAsync : Memory<char> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>Public Overrides Function ReadBlockAsync (buffer As Memory(Of Char), Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Integer)Parâmetros
Quando este método é retornado, contém o bloco de memória de caracteres especificado substituídos pelos caracteres lidos da fonte de dados atual.
- cancellationToken
- CancellationToken
O token a se monitorar 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 da tarefa de valor contém o número total de caracteres lidos no buffer. O valor do resultado poderá ser menor que o número de caracteres solicitados se o número de caracteres disponíveis no momento for menor que o número solicitado ou poderá ser 0 (zero) se o final do fluxo for atingido.
Exceções
O token de cancelamento foi cancelado. Essa exceção é armazenada na tarefa retornada.
Aplica-se a
ReadBlockAsync(Char[], Int32, Int32)
- Origem:
- StreamReader.cs
- Origem:
- StreamReader.cs
- Origem:
- StreamReader.cs
Lê um máximo especificado de caracteres do fluxo atual de forma assíncrona e grava os dados em um buffer, começando no índice especificado.
public:
override System::Threading::Tasks::Task<int> ^ ReadBlockAsync(cli::array <char> ^ buffer, int index, int count);public override System.Threading.Tasks.Task<int> ReadBlockAsync (char[] buffer, int index, int count);[System.Runtime.InteropServices.ComVisible(false)]
public override System.Threading.Tasks.Task<int> ReadBlockAsync (char[] buffer, int index, int count);override this.ReadBlockAsync : char[] * int * int -> System.Threading.Tasks.Task<int>[<System.Runtime.InteropServices.ComVisible(false)>]
override this.ReadBlockAsync : char[] * int * int -> System.Threading.Tasks.Task<int>Public Overrides Function ReadBlockAsync (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 origem atual.
- index
- Int32
A posição em buffer na qual a gravação será iniciada.
- count
- Int32
O número máximo de caracteres a serem lidos. Se o final do fluxo for atingido antes que o número especificado de caracteres seja gravado no buffer, o método será retornado.
Retornos
Uma tarefa que representa a operação de leitura assíncrona. O valor do parâmetro TResult contém o número total de caracteres lidos no buffer. O valor do resultado poderá ser menor que o número de caracteres solicitados se o número de caracteres disponíveis no momento for menor que o número solicitado ou poderá ser 0 (zero) se o final do fluxo for atingido.
- Atributos
Exceções
buffer é null.
index ou count é negativo.
A soma de index e count é maior que o tamanho do buffer.
O fluxo foi descartado.
O leitor está sendo usado no momento por uma operação de leitura anterior.
Comentários
A tarefa não é concluída até que o número de caracteres especificado pelo count parâmetro seja lido ou o final do fluxo seja atingido.
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 ReadBlock(Char[], Int32, Int32).
