BufferedStream.CopyToAsync(Stream, Int32, CancellationToken) Método

Definição

Namespace:

System.IO

Assembly:

System.Runtime.dll

Origem:

BufferedStream.cs

Lê de forma assíncrona os bytes do fluxo em buffer atual e grava-os em outro fluxo usando um tamanho do buffer especificado e um token de cancelamento.

public:
 override System::Threading::Tasks::Task ^ CopyToAsync(System::IO::Stream ^ destination, int bufferSize, System::Threading::CancellationToken cancellationToken);

public override System.Threading.Tasks.Task CopyToAsync (System.IO.Stream destination, int bufferSize, System.Threading.CancellationToken cancellationToken);

override this.CopyToAsync : System.IO.Stream * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Overrides Function CopyToAsync (destination As Stream, bufferSize As Integer, cancellationToken As CancellationToken) As Task

Parâmetros

destination

Stream

O fluxo para o qual o conteúdo do fluxo em buffer atual será copiado.

bufferSize

Int32

O tamanho do buffer, em bytes. Esse valor deve ser maior que zero. O tamanho padrão é 81.920.

cancellationToken

CancellationToken

O token a se monitorar para solicitações de cancelamento. O valor padrão é None.

Retornos

Task

Uma tarefa que representa a operação de cópia assíncrona.

Exceções

OperationCanceledException

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

Comentários

O CopyToAsync método permite que você execute operações de E/S com uso intensivo de recursos sem bloquear o thread main. Essa consideração sobre o desempenho é particularmente importante em um aplicativo da Microsoft Store 8.x ou aplicativo de desktop em que uma operação demorada de fluxo pode bloquear o thread de interface do usuário e fazer seu aplicativo parecer como se não estivesse funcionando. Os métodos assíncronos são usados em conjunto com as async palavras-chave e await no Visual Basic e no C#.

Se a operação for cancelada antes de ser concluída, a tarefa retornada conterá o Canceled valor da Status propriedade .

A cópia começa na posição atual no fluxo atual.

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 CopyTo(Stream, Int32).