ZipFile.OpenAsync 方法

來源:

ZipFile.Create.Async.cs

來源:

ZipFile.Create.Async.cs

public static System.Threading.Tasks.Task<System.IO.Compression.ZipArchive> OpenAsync(string archiveFileName, System.IO.Compression.ZipArchiveMode mode, System.Threading.CancellationToken cancellationToken = default);

static member OpenAsync : string * System.IO.Compression.ZipArchiveMode * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Compression.ZipArchive>

Public Shared Function OpenAsync (archiveFileName As String, mode As ZipArchiveMode, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ZipArchive)

參數

傳回

例外狀況

備註

針對 archiveFileName：

路徑可指定相對或絕對路徑資訊。 相對路徑資訊會被解讀為相對於目前工作目錄的相對於。

針對 mode：

若 Read 指定為 ，檔案以 開啟 System.IO.FileMode.Open，若檔案不存在則拋出 a FileNotFoundException 。

若 Create 指定為 ，檔案以 開， System.IO.FileMode.CreateNew若檔案已存在則拋出 a System.IO.IOException 。

若Update指定為 ，則以 開啟檔案。System.IO.FileMode.OpenOrCreate

如果該檔案存在且是壓縮檔，其條目將被存取並可修改，並可建立新的條目。

如果該檔案存在且不是壓縮檔，則拋出 a InvalidDataException 鍵。

如果檔案存在且為空或不存在，就會建立一個新的 zip 檔。

用這個 Create 模式建立壓縮檔在建立新壓縮檔時會更有效率。

來源:

ZipFile.Create.Async.cs

來源:

ZipFile.Create.Async.cs

public static System.Threading.Tasks.Task<System.IO.Compression.ZipArchive> OpenAsync(string archiveFileName, System.IO.Compression.ZipArchiveMode mode, System.Text.Encoding? entryNameEncoding, System.Threading.CancellationToken cancellationToken = default);

static member OpenAsync : string * System.IO.Compression.ZipArchiveMode * System.Text.Encoding * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Compression.ZipArchive>

Public Shared Function OpenAsync (archiveFileName As String, mode As ZipArchiveMode, entryNameEncoding As Encoding, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ZipArchive)

參數

傳回

例外狀況

備註

針對 archiveFileName：

路徑可指定相對或絕對路徑資訊。 相對路徑資訊會被解讀為相對於目前工作目錄的相對於。

針對 mode：

若 Read 指定為 ，檔案以 開啟 System.IO.FileMode.Open，若檔案不存在則拋出 a FileNotFoundException 。

若 Create 指定為 ，檔案以 開， System.IO.FileMode.CreateNew若檔案已存在則拋出 a System.IO.IOException 。

若Update指定為 ，則以 開啟檔案。System.IO.FileMode.OpenOrCreate

如果該檔案存在且是壓縮檔，其條目將被存取並可修改，並可建立新的條目。

如果該檔案存在且不是壓縮檔，則拋出 a InvalidDataException 鍵。

如果檔案存在且為空或不存在，就會建立一個新的 zip 檔。

用這個 Create 模式建立壓縮檔在建立新壓縮檔時會更有效率。

不建議指定除 null for entryNameEncoding 以外的值。 然而，這可能是為了與無法正確支援 UTF-8 編碼的 zip 壓縮工具和函式庫的互通性所必需的。

此數值的使用方式如下：

讀取（開啟）ZIP 壓縮檔：

• 若 entryNameEncoding 未指定 （== null）：
  • 對於本地檔案標頭通用位元旗標 中語言 編碼旗標（EFS）未設定的條目，請使用目前系統預設代碼頁（Encoding.Default）來解碼條目名稱並註解。
  • 對於 設定了 本地檔案標頭通用位元旗標中語言編碼旗標（EFS）的條目，請使用 UTF-8 （Encoding.UTF8） 來解碼條目名稱並註解。
• 若 entryNameEncoding 指定為（!= null）：
  • 對於本地檔案標頭通用位元旗標 中語言 編碼旗標（EFS）未設定的條目，請使用指定的 entryNameEncoding 標示來解碼條目名稱與註解。
  • 對於 設定了 本地檔案標頭通用位元旗標中語言編碼旗標（EFS）的條目，請使用 UTF-8 （Encoding.UTF8） 來解碼條目名稱並註解。

撰寫（儲存）ZIP 壓縮檔：

• 若 entryNameEncoding 未指定 （== null）：
  • 對於包含 ASCII 範圍外字元的條目名稱與註解，語言編碼旗標（EFS）會設在本地檔案標頭的通用位元旗標中，並使用 UTF-8 （Encoding.UTF8） 將條目名稱與註解編碼成位元組。
  • 對於不包含 ASCII 範圍外字元的條目名稱與註解，語言編碼旗標（EFS）不會在本地檔案標頭的通用位元旗標中設定，且將使用目前系統預設的代碼頁Encoding.Default（）來將條目名稱與註解編碼成位元組。
• 若 entryNameEncoding 指定為（!= null）：
  • 指定的 entryNameEncoding 會被用來將條目名稱和註解編碼成位元組。
  • 本地檔案標頭通用位元旗標中的語言編碼旗標（EFS）當且僅當指定的 entryNameEncoding UTF-8 編碼時才會被設定。

除了 UTF-8 外，無法使用其他 Unicode 編碼， entryNameEncoding否則 an ArgumentException 會被拋出。