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

Definición

Espacio de nombres:

System.IO

Ensamblado:

System.Runtime.dll

Source:

FileStream.cs

Lee de forma asincrónica los bytes de la secuencia de archivo actual y los escribe en otra secuencia, utilizando el tamaño de búfer y el token de cancelación especificados.

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 archivo 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 la Tienda Windows 8.x o una aplicación de escritorio en que una operación de streaming prolongada puede bloquear el subproceso de interfaz de usuario y hacer que parezca que una aplicación ha dejado de responder. 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 de archivos actual.

Para obtener un ejemplo de copia entre dos flujos, consulte la CopyToAsync(Stream) sobrecarga.