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

Definição

Lê uma sequência de bytes do fluxo atual de forma assíncrona, avança a posição dentro do fluxo pelo número de bytes lidos e monitoriza pedidos 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>
abstract member ReadAsync : byte[] * int * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>
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 para escrever os dados.

offset
Int32

O desvio de bytes para buffer onde começar a escrever dados do fluxo.

count
Int32

O número máximo de bytes a ler.

cancellationToken
CancellationToken

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

Devoluções

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

Exceções

buffer é null.

offset ou count é negativo.

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

O stream não suporta leitura.

O riacho foi eliminado.

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

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

Observações

Importante

A partir do .NET 6, este método pode não ler tantos bytes quanto os solicitados. Para mais informações, consulte Leituras parciais e de zero bytes no DeflateStream, GZipStream e CryptoStream.

Deve anteceder a sua chamada para ReadAsync com o operador await (C#) ou Await (Visual Basic) para suspender a execução do método até a tarefa estar concluída. Para mais informações, consulte Programação assíncrona (C#) ou Programação assíncrona com Assíncrona e Espera (Visual Basic).

Se a operação for cancelada antes de ser concluída, a tarefa devolvida contém o Canceled valor da Status propriedade.

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

Aplica-se a

Ver também