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

Définition

Espace de noms:

System.IO

Assembly:

System.Runtime.dll

Source:

BufferedStream.cs

Lit de façon asynchrone les octets du flux mis en mémoire tampon actuel et les écrit dans un autre flux, en utilisant une taille de mémoire tampon et d’un jeton d’annulation spécifiés.

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

Paramètres

destination

Stream

Flux vers lequel le contenu du flux mis en mémoire tampon actuel sera copié.

bufferSize

Int32

Taille en octets de la mémoire tampon. Cette valeur doit être supérieure à zéro. La taille par défaut est 81 920.

cancellationToken

CancellationToken

Jeton pour surveiller les requêtes d'annulation. La valeur par défaut est None.

Retours

Task

Tâche qui représente l’opération de copie asynchrone.

Exceptions

OperationCanceledException

Le jeton d’annulation a été annulé. Cette exception est stockée dans la tâche retournée.

Remarques

La CopyToAsync méthode vous permet d’effectuer des opérations d’E/S nécessitant beaucoup de ressources sans bloquer le thread main. Cette considération de performance est particulièrement importante dans une application Windows 8.x Store ou une application de bureau où une longue opération de flux peut bloquer le thread d'interface utilisateur et faire que l'application s'affiche comme si elle ne fonctionnait pas. Les méthodes asynchrones sont utilisées conjointement avec les async mots clés et await dans Visual Basic et C#.

Si l’opération est annulée avant qu’elle ne se termine, la tâche retournée contient la Canceled valeur de la Status propriété.

La copie commence à la position actuelle dans le flux actif.

Cette méthode stocke dans la tâche toutes les exceptions de non-utilisation que l’équivalent synchrone de la méthode peut lever. Si une exception est stockée dans la tâche retournée, cette exception sera levée lorsque la tâche est attendue. Les exceptions d’utilisation, telles que ArgumentException, sont toujours levées de manière synchrone. Pour connaître les exceptions stockées, consultez les exceptions levées par CopyTo(Stream, Int32).