DeflateStream.CopyToAsync(Stream, Int32, CancellationToken) Metode

Definisi

Ruang nama:

System.IO.Compression

Rakitan:

System.IO.Compression.dll

Sumber:

DeflateStream.cs

Secara asinkron membaca byte dari aliran Deflate saat ini dan menulisnya ke aliran lain, menggunakan ukuran buffer tertentu.

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

Parameter

destination

Stream

Aliran tempat konten aliran Deflate saat ini akan disalin.

bufferSize

Int32

Ukuran, dalam byte, dari buffer. Nilai ini harus lebih besar dari nol. Ukuran defaultnya adalah 81920.

cancellationToken

CancellationToken

Token yang akan dipantau untuk permintaan pembatalan. Nilai defaultnya adalah None.

Mengembalikan

Task

Tugas yang mewakili operasi penyalinan asinkron.

Pengecualian

OperationCanceledException

Token pembatalan dibatalkan. Pengecualian ini disimpan ke dalam tugas yang dikembalikan.

Keterangan

Metode ini CopyToAsync memungkinkan Anda melakukan operasi I/O intensif sumber daya tanpa memblokir utas utama. Pertimbangan performa ini sangat penting di aplikasi desktop di mana operasi streaming yang memakan waktu dapat memblokir utas UI dan membuat aplikasi muncul seolah-olah tidak berfungsi. Metode asinkron digunakan bersama dengan async kata kunci dan await di Visual Basic dan C#.

Jika operasi dibatalkan sebelum selesai, tugas yang dikembalikan berisi TaskStatus.Canceled nilai untuk Task.Status properti .

Penyalinan dimulai pada posisi saat ini di aliran Deflate saat ini.

Metode ini disimpan dalam tugas yang menampilkan semua pengecualian non-penggunaan yang dapat dilemparkan oleh rekan sinkron metode. Jika pengecualian disimpan ke dalam tugas yang dikembalikan, pengecualian tersebut akan dilemparkan saat tugas ditunggu. Pengecualian penggunaan, seperti ArgumentException, masih dilemparkan secara sinkron. Untuk pengecualian yang disimpan, lihat pengecualian yang dilemparkan oleh CopyTo(Stream, Int32).