語言

TarFile.ExtractToDirectoryAsync 方法

定義

多載

ExtractToDirectoryAsync(String, String, Boolean, CancellationToken)

來源:
TarFile.cs
來源:
TarFile.cs
來源:
TarFile.cs
來源:
TarFile.cs
來源:
TarFile.cs

非同步地將 tar 檔案的內容解壓到指定的目錄中。

public static System.Threading.Tasks.Task ExtractToDirectoryAsync(string sourceFileName, string destinationDirectoryName, bool overwriteFiles, System.Threading.CancellationToken cancellationToken = default);
static member ExtractToDirectoryAsync : string * string * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Shared Function ExtractToDirectoryAsync (sourceFileName As String, destinationDirectoryName As String, overwriteFiles As Boolean, Optional cancellationToken As CancellationToken = Nothing) As Task

參數

sourceFileName
String

就是要提取 tar 檔案的路徑。

destinationDirectoryName
String

目的地目錄的路徑,檔案系統條目應該被解壓。 在 .NET 11 及更早版本中,該目錄必須已經存在。 在 .NET 12 及更新版本中,當提取條目時,會根據需要建立缺少的目的地和父目錄。 空的壓縮檔不會建立任何目錄。

overwriteFiles
Boolean

true 覆寫檔案 destinationDirectoryName與目錄; false 以避免覆寫,若發現已有檔案或目錄名稱則丟棄。

cancellationToken
CancellationToken

用來監控取消申請的代幣。 預設值為 None。

傳回

一個代表非同步擷取操作的任務。

例外狀況

sourceFileName 或 destinationDirectoryName 為 null。

.NET 11 及更早版本:destinationDirectoryName目錄不存在。

找不到檔案路徑。sourceFileName

權限不足。

解壓其中一個 tar 條目會導致檔案出現在指定目的目錄之外。

-或-

sourceFileName 或者 destinationDirectoryName 是空的。

僅限 .NET 11 及更新版本:條目的校驗和無效。

發生了 I/O 例外。

取消令牌也被取消了。 此例外會儲存在回傳的任務中。

備註

Warning

此方法不得用於解壓不受信任的檔案。 它不強制執行任何大小限制、條目數量限制或其他安全解壓不可信檔案所需的政策。 欲了解更多如何安全解壓來自不可信來源的壓縮檔,請參閱 使用壓縮檔與 tar 壓縮檔的最佳實務。

在 .NET 11 及更早版本中,指定的destinationDirectoryName目錄必須已經存在。 如果不存在,這個方法會拋出一個 DirectoryNotFoundException,即使壓縮檔是空的。

在 .NET 12 及更新版本中,目的目錄已經可以存在。 缺少的目的地目錄和父目錄會在提取條目時依需要建立。 空的壓縮檔不會建立任何目錄。

如果 tar 壓縮檔中的符號連結或交接導致檔案被解壓在指定 destinationDirectoryName目錄之外,則會拋出 an IOException 以確保解壓仍在同一目錄中。

如果 destinationDirectoryName 其父目錄中的任何一個是既有的連接或符號連結,則會沿著連結追蹤,並將擷取寫入最終目標資料夾。

類型為 BlockDevice、 CharacterDevice或 Fifo 的檔案只能在 Unix 平台中解壓。

提取 a BlockDevice 或 CharacterDevice 磁碟需要抬高。

此方法在任務中儲存所有非使用例外,該方法的同步對應程式可拋出這些例外。 如果回傳的任務中儲存了例外,該例外會在等待任務時拋出。 使用例外錯誤,例如 ArgumentException,仍會同步拋出。 關於儲存的例外,請參見由 ExtractToDirectory(String, String, Boolean)拋出的例外。

適用於

ExtractToDirectoryAsync(Stream, String, Boolean, CancellationToken)

來源:
TarFile.cs
來源:
TarFile.cs
來源:
TarFile.cs
來源:
TarFile.cs
來源:
TarFile.cs

非同步地將代表 tar archive 的串流內容解壓到指定的目錄中。

public static System.Threading.Tasks.Task ExtractToDirectoryAsync(System.IO.Stream source, string destinationDirectoryName, bool overwriteFiles, System.Threading.CancellationToken cancellationToken = default);
static member ExtractToDirectoryAsync : System.IO.Stream * string * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Shared Function ExtractToDirectoryAsync (source As Stream, destinationDirectoryName As String, overwriteFiles As Boolean, Optional cancellationToken As CancellationToken = Nothing) As Task

參數

source
Stream

包含瀝青檔案的溪流。

destinationDirectoryName
String

目的地目錄的路徑,檔案系統條目應該被解壓。 在 .NET 11 及更早版本中,該目錄必須已經存在。 在 .NET 12 及更新版本中,當提取條目時,會根據需要建立缺少的目的地和父目錄。 空的壓縮檔不會建立任何目錄。

overwriteFiles
Boolean

true 覆寫檔案 destinationDirectoryName與目錄; false 以避免覆寫,若發現已有檔案或目錄名稱則丟棄。

cancellationToken
CancellationToken

用來監控取消申請的代幣。 預設值為 None。

傳回

一個代表非同步擷取操作的任務。

例外狀況

source 或 destinationDirectoryName 為 null。

.NET 11 及更早版本:destinationDirectoryName目錄不存在。

權限不足。

解壓其中一個 tar 條目會導致檔案出現在指定目的目錄之外。

-或-

destinationDirectoryName 空無一人。

-或-

source 不支援閱讀。

僅限 .NET 11 及更新版本:條目的校驗和無效。

發生了 I/O 例外。

取消令牌也被取消了。 此例外會儲存在回傳的任務中。

備註

Warning

此方法不得用於解壓不受信任的檔案。 它不強制執行任何大小限制、條目數量限制或其他安全解壓不可信檔案所需的政策。 欲了解更多如何安全解壓來自不可信來源的壓縮檔,請參閱 使用壓縮檔與 tar 壓縮檔的最佳實務。

在 .NET 11 及更早版本中,指定的destinationDirectoryName目錄必須已經存在。 如果不存在,這個方法會拋出一個 DirectoryNotFoundException,即使壓縮檔是空的。

在 .NET 12 及更新版本中,目的目錄已經可以存在。 缺少的目的地目錄和父目錄會在提取條目時依需要建立。 空的壓縮檔不會建立任何目錄。

如果 tar 壓縮檔中的符號連結或交接導致檔案被解壓在指定 destinationDirectoryName目錄之外,則會拋出 an IOException 以確保解壓仍在同一目錄中。

如果 destinationDirectoryName 其父目錄中的任何一個是既有的連接或符號連結,則會沿著連結追蹤,並將擷取寫入最終目標資料夾。

類型為 BlockDevice、 CharacterDevice或 Fifo 的檔案只能在 Unix 平台中解壓。

提取 a BlockDevice 或 CharacterDevice 磁碟需要抬高。

此方法在任務中儲存所有非使用例外,該方法的同步對應程式可拋出這些例外。 如果回傳的任務中儲存了例外,該例外會在等待任務時拋出。 使用例外錯誤,例如 ArgumentException,仍會同步拋出。 關於儲存的例外,請參見由 ExtractToDirectory(Stream, String, Boolean)拋出的例外。

適用於

ExtractToDirectoryAsync(Stream, String, TarExtractOptions, CancellationToken)

來源:
TarFile.cs
public static System.Threading.Tasks.Task ExtractToDirectoryAsync(System.IO.Stream source, string destinationDirectoryName, System.Formats.Tar.TarExtractOptions options, System.Threading.CancellationToken cancellationToken = default);
static member ExtractToDirectoryAsync : System.IO.Stream * string * System.Formats.Tar.TarExtractOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Shared Function ExtractToDirectoryAsync (source As Stream, destinationDirectoryName As String, options As TarExtractOptions, Optional cancellationToken As CancellationToken = Nothing) As Task

參數

source
Stream
destinationDirectoryName
String

指向存放擷取檔案目錄的路徑。 在 .NET 11 及更早版本中,該目錄必須已經存在。 在 .NET 12 及更新版本中,當提取條目時,會根據需要建立缺少的目的地和父目錄。 空的壓縮檔不會建立任何目錄。

cancellationToken
CancellationToken

傳回

例外狀況

.NET 11 及更早版本:destinationDirectoryName目錄不存在。

備註

Warning

此方法不得用於解壓不受信任的檔案。 它不強制執行任何大小限制、條目數量限制或其他安全解壓不可信檔案所需的政策。 欲了解更多如何安全解壓來自不可信來源的壓縮檔,請參閱 使用壓縮檔與 tar 壓縮檔的最佳實務。

在 .NET 11 及更早版本中,指定的destinationDirectoryName目錄必須已經存在。 如果不存在,這個方法會拋出一個 DirectoryNotFoundException,即使壓縮檔是空的。

在 .NET 12 及更新版本中,目的目錄已經可以存在。 缺少的目的地目錄和父目錄會在提取條目時依需要建立。 空的壓縮檔不會建立任何目錄。

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

若解壓過程中發生錯誤,該壓縮檔仍維持部分解壓狀態。

設定 OverwriteFiles 為 以 true 覆蓋現有檔案。 預設值為 false。 用 HardLinkMode 來控制如何擷取硬連結條目。

如果 tar 壓縮檔中的符號連結或交接導致檔案被解壓在指定 destinationDirectoryName目錄之外,則會拋出 an IOException 以確保解壓仍在同一目錄中。

如果 destinationDirectoryName 其父目錄中的任何一個是既有的連接或符號連結,則會沿著連結追蹤,並將擷取寫入最終目標資料夾。

類型為 BlockDevice、 CharacterDevice或 Fifo 的檔案只能在 Unix 平台中解壓。

提取 a BlockDevice 或 CharacterDevice 磁碟需要抬高。

萃取後溪 source 流會保持開放狀態。

非同步擷取期間發生的異常會儲存在回傳的任務中,並在等待任務時拋出。

適用於

ExtractToDirectoryAsync(String, String, TarExtractOptions, CancellationToken)

來源:
TarFile.cs
public static System.Threading.Tasks.Task ExtractToDirectoryAsync(string sourceFileName, string destinationDirectoryName, System.Formats.Tar.TarExtractOptions options, System.Threading.CancellationToken cancellationToken = default);
static member ExtractToDirectoryAsync : string * string * System.Formats.Tar.TarExtractOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Shared Function ExtractToDirectoryAsync (sourceFileName As String, destinationDirectoryName As String, options As TarExtractOptions, Optional cancellationToken As CancellationToken = Nothing) As Task

參數

sourceFileName
String
destinationDirectoryName
String

指向存放擷取檔案目錄的路徑。 在 .NET 11 及更早版本中,該目錄必須已經存在。 在 .NET 12 及更新版本中,當提取條目時,會根據需要建立缺少的目的地和父目錄。 空的壓縮檔不會建立任何目錄。

cancellationToken
CancellationToken

傳回

例外狀況

.NET 11 及更早版本:destinationDirectoryName目錄不存在。

備註

Warning

此方法不得用於解壓不受信任的檔案。 它不強制執行任何大小限制、條目數量限制或其他安全解壓不可信檔案所需的政策。 欲了解更多如何安全解壓來自不可信來源的壓縮檔,請參閱 使用壓縮檔與 tar 壓縮檔的最佳實務。

在 .NET 11 及更早版本中,指定的destinationDirectoryName目錄必須已經存在。 如果不存在,這個方法會拋出一個 DirectoryNotFoundException,即使壓縮檔是空的。

在 .NET 12 及更新版本中,目的目錄已經可以存在。 缺少的目的地目錄和父目錄會在提取條目時依需要建立。 空的壓縮檔不會建立任何目錄。

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

若解壓過程中發生錯誤,該壓縮檔仍維持部分解壓狀態。

設定 OverwriteFiles 為 以 true 覆蓋現有檔案。 預設值為 false。 用 HardLinkMode 來控制如何擷取硬連結條目。

如果 tar 壓縮檔中的符號連結或交接導致檔案被解壓在指定 destinationDirectoryName目錄之外,則會拋出 an IOException 以確保解壓仍在同一目錄中。

如果 destinationDirectoryName 其父目錄中的任何一個是既有的連接或符號連結,則會沿著連結追蹤,並將擷取寫入最終目標資料夾。

類型為 BlockDevice、 CharacterDevice或 Fifo 的檔案只能在 Unix 平台中解壓。

提取 a BlockDevice 或 CharacterDevice 磁碟需要抬高。

非同步擷取期間發生的異常會儲存在回傳的任務中,並在等待任務時拋出。

適用於