BufferedStream.ReadAsync(Byte[], Int32, Int32, CancellationToken) Método

Definição

Lê de forma assíncrona uma sequência de bytes do fluxo atual, avança a posição dentro do fluxo pelo número de bytes lidos e monitora solicitações de cancelamento.

public:
 override System::Threading::Tasks::Task<int> ^ ReadAsync(cli::array <System::Byte> ^ buffer, int offset, int count, System::Threading::CancellationToken cancellationToken);
public override System.Threading.Tasks.Task<int> ReadAsync(byte[] buffer, int offset, int count, System.Threading.CancellationToken cancellationToken);
override this.ReadAsync : byte[] * int * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>
Public Overrides Function ReadAsync (buffer As Byte(), offset As Integer, count As Integer, cancellationToken As CancellationToken) As Task(Of Integer)

Parâmetros

buffer
Byte[]

O buffer no qual gravar os dados.

offset
Int32

O deslocamento de bytes no buffer qual começar a gravar dados do fluxo.

count
Int32

O número máximo de bytes a serem lidos.

cancellationToken
CancellationToken

O token a ser monitorado para solicitações de cancelamento.

Retornos

Uma tarefa que representa a operação de leitura assíncrona. A tarefa retornada 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 fluxo tiver sido atingido.

Exceções

buffer é null.

offset ou count é negativo.

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

O fluxo não dá suporte à leitura.

O fluxo foi descartado.

No momento, o fluxo está em uso por uma operação de leitura anterior.

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

Comentários

Você pode criar um token de cancelamento criando uma instância da CancellationTokenSource classe e passando a Token propriedade como o cancellationToken parâmetro.

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(Byte[], Int32, Int32).

Aplica-se a