GZipStream.CopyToAsync(Stream, Int32, CancellationToken) Metoda

Definice

Obor názvů:

System.IO.Compression

Sestavení:

System.IO.Compression.dll

Zdroj:

GZipStream.cs

Asynchronně přečte bajty z aktuálního datového proudu GZip a zapíše je do jiného datového proudu pomocí zadané velikosti vyrovnávací paměti.

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

Parametry

destination

Stream

Datový proud, do kterého se zkopíruje obsah aktuálního datového proudu GZip.

bufferSize

Int32

Velikost vyrovnávací paměti v bajtech. Tato hodnota musí být větší než nula. Výchozí velikost je 81920.

cancellationToken

CancellationToken

Token, který se má monitorovat pro žádosti o zrušení. Výchozí hodnota je None.

Návraty

Task

Úloha, která představuje asynchronní operaci kopírování.

Výjimky

OperationCanceledException

Token zrušení byl zrušen. Tato výjimka je uložena ve vrácené úloze.

Poznámky

Metoda CopyToAsync umožňuje provádět vstupně-výstupní operace náročné na prostředky bez blokování hlavního vlákna. Tento faktor výkonu je obzvláště důležitý v desktopové aplikaci, kde časově náročná operace streamu může blokovat vlákno uživatelského rozhraní a vaše aplikace vypadat, jako by nefungovala. Asynchronní metody se používají ve spojení s klíčovými async slovy a await v jazyce Visual Basic a C#.

Pokud je operace zrušena před dokončením, bude vrácená úloha obsahovat TaskStatus.Canceled hodnotu vlastnosti Task.Status .

Kopírování začíná na aktuální pozici v aktuálním datovém proudu GZip.

Tato metoda ukládá do úlohy, která vrací všechny výjimky nesouvisejí s používáním, které může vyvolat synchronní protějšek metody. Pokud je ve vrácené úloze uložena výjimka, bude tato výjimka vyvolána při čekání na úkol. Výjimky použití, například ArgumentException, jsou stále vyvolány synchronně. Informace o uložených výjimkách najdete v tématu Výjimky vyvolané nástrojem CopyTo(Stream, Int32).