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

Definición

Espacio de nombres:

System.IO.Compression

Ensamblado:

System.IO.Compression.dll

Source:

GZipStream.cs

Lee asincrónicamente los bytes de la secuencia de GZip actual y los escribe en otra secuencia, usando el tamaño de búfer especificado.

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

Secuencia en la que se copiará el contenido de la secuencia de GZip actual.

bufferSize

Int32

Tamaño del búfer en bytes. Este valor debe ser mayor que cero. El tamaño predeterminado es 81920.

cancellationToken

CancellationToken

Token para supervisar solicitudes de cancelación. El valor predeterminado es None.

Devoluciones

Task

Tarea que representa la operación de copia asincrónica.

Excepciones

OperationCanceledException

Se canceló el token de cancelación. Esta excepción se almacena en la tarea devuelta.

Comentarios

El CopyToAsync método permite realizar operaciones de E/S intensivas en recursos sin bloquear el subproceso principal. Esta consideración de rendimiento es especialmente importante en una aplicación de escritorio en la que una operación de secuencia que consume mucho tiempo puede bloquear el subproceso de la interfaz de usuario y hacer que la aplicación aparezca como si no funcionara. Los métodos asincrónicos se usan junto con las async palabras clave y await en Visual Basic y C#.

Si la operación se cancela antes de completarse, la tarea devuelta contiene el TaskStatus.Canceled valor de la Task.Status propiedad .

La copia comienza en la posición actual de la secuencia GZip actual.

Este método almacena en la tarea que devuelve todas las excepciones que no son de uso que puede producir el homólogo sincrónico del método. Si se almacena una excepción en la tarea devuelta, esa excepción se producirá cuando se espere a la tarea. Las excepciones de uso, como ArgumentException, se siguen produciendo de forma sincrónica. Para ver las excepciones almacenadas, vea las excepciones producidas por CopyTo(Stream, Int32).