ZipArchive.CreateAsync Metode
Definisi
Penting
Beberapa informasi terkait produk prarilis yang dapat diubah secara signifikan sebelum dirilis. Microsoft tidak memberikan jaminan, tersirat maupun tersurat, sehubungan dengan informasi yang diberikan di sini.
Menginisialisasi dan mengembalikan instans ZipArchive baru secara asinkron pada aliran tertentu dalam mode yang ditentukan, menentukan apakah akan membiarkan aliran terbuka, dengan pengodean opsional dan token pembatalan opsional.
public static System.Threading.Tasks.Task<System.IO.Compression.ZipArchive> CreateAsync(System.IO.Stream stream, System.IO.Compression.ZipArchiveMode mode, bool leaveOpen, System.Text.Encoding? entryNameEncoding, System.Threading.CancellationToken cancellationToken = default);
static member CreateAsync : System.IO.Stream * System.IO.Compression.ZipArchiveMode * bool * System.Text.Encoding * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Compression.ZipArchive>
Public Shared Function CreateAsync (stream As Stream, mode As ZipArchiveMode, leaveOpen As Boolean, entryNameEncoding As Encoding, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ZipArchive)
Parameter
- stream
- Stream
Aliran input atau output.
- mode
- ZipArchiveMode
Salah satu nilai enumerasi yang menentukan apakah aliran mendukung membaca, menulis, dan mencari.
- leaveOpen
- Boolean
true untuk membiarkan aliran terbuka saat membuang ZipArchive, jika tidak false.
- entryNameEncoding
- Encoding
Pengodean yang digunakan saat membaca atau menulis nama entri dan komentar di ZipArchive ini.
- cancellationToken
- CancellationToken
Token pembatalan opsional untuk dipantau.
Mengembalikan
Pengecualian
Alirannya adalah null.
mode menentukan nilai yang tidak valid.
Konten aliran tidak dapat ditafsirkan sebagai file ZIP.
-atau-
mode adalah Pembaruan dan entri hilang dari arsip atau rusak dan tidak dapat dibaca.
-atau-
mode adalah Pembaruan dan entri terlalu besar agar pas dengan memori.
Pengodean Unicode selain UTF-8 ditentukan untuk entryNameEncoding.
Keterangan
Menentukan nilai untuk entryNameEncoding selain null tidak disarankan. Namun, ini mungkin diperlukan untuk interoperabilitas dengan alat arsip ZIP dan pustaka yang tidak mendukung pengodean UTF-8 dengan benar untuk nama entri.
Nilai ini digunakan sebagai berikut:
- Jika
entryNameEncodingtidak ditentukan (== null):- Untuk entri di mana bendera pengodean bahasa (EFS) dalam bendera bit tujuan umum header file lokal tidak diatur, gunakan halaman kode default sistem saat ini (
Encoding.Default) untuk mendekode nama entri dan komentar. - Untuk entri di mana bendera pengodean bahasa (EFS) dalam bendera bit tujuan umum header file lokal diatur, gunakan UTF-8 (
Encoding.UTF8) untuk mendekode nama entri dan komentar.
- Untuk entri di mana bendera pengodean bahasa (EFS) dalam bendera bit tujuan umum header file lokal tidak diatur, gunakan halaman kode default sistem saat ini (
- Jika
entryNameEncodingditentukan (!= null):- Untuk entri di mana bendera pengodean bahasa (EFS) dalam bendera bit tujuan umum header file lokal tidak diatur, gunakan yang ditentukan
entryNameEncodinguntuk mendekode nama entri dan komentar. - Untuk entri di mana bendera pengodean bahasa (EFS) dalam bendera bit tujuan umum header file lokal diatur, gunakan UTF-8 (
Encoding.UTF8) untuk mendekode nama entri dan komentar.
- Untuk entri di mana bendera pengodean bahasa (EFS) dalam bendera bit tujuan umum header file lokal tidak diatur, gunakan yang ditentukan
- Jika
entryNameEncodingtidak ditentukan (== null):- Untuk nama entri dan komentar yang berisi karakter di luar rentang ASCII, bendera pengodean bahasa (EFS) akan diatur dalam bendera bit tujuan umum header file lokal, dan UTF-8 (
Encoding.UTF8) akan digunakan untuk mengodekan nama entri dan komentar ke dalam byte. - Untuk nama entri dan komentar yang tidak berisi karakter di luar rentang ASCII, bendera pengodean bahasa (EFS) tidak akan diatur dalam bendera bit tujuan umum header file lokal, dan halaman kode default sistem saat ini (
Encoding.Default) akan digunakan untuk mengodekan nama entri dan komentar ke dalam byte.
- Untuk nama entri dan komentar yang berisi karakter di luar rentang ASCII, bendera pengodean bahasa (EFS) akan diatur dalam bendera bit tujuan umum header file lokal, dan UTF-8 (
- Jika
entryNameEncodingditentukan (!= null):- Yang ditentukan
entryNameEncodingakan selalu digunakan untuk mengodekan nama entri dan komentar ke dalam byte. - Bendera pengodean bahasa (EFS) dalam bendera bit tujuan umum header file lokal akan diatur jika dan hanya jika yang ditentukan
entryNameEncodingadalah pengodean UTF-8.
- Yang ditentukan