TarFile.CreateFromDirectoryAsync 方法

定義

命名空間:

System.Formats.Tar

組件:

System.Formats.Tar.dll

多載

CreateFromDirectoryAsync(String, Stream, Boolean, CancellationToken)	以異步方式建立 tar 數據流，其中包含指定目錄中的所有文件系統專案。
CreateFromDirectoryAsync(String, String, Boolean, CancellationToken)	以異步方式從指定目錄的內容建立 tar 封存，並將其輸出至指定的路徑。 可以選擇性地包含基底目錄做為專案名稱的前置詞。

CreateFromDirectoryAsync(String, Stream, Boolean, CancellationToken)

來源:

TarFile.cs

以異步方式建立 tar 數據流，其中包含指定目錄中的所有文件系統專案。

public static System.Threading.Tasks.Task CreateFromDirectoryAsync (string sourceDirectoryName, System.IO.Stream destination, bool includeBaseDirectory, System.Threading.CancellationToken cancellationToken = default);

static member CreateFromDirectoryAsync : string * System.IO.Stream * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Shared Function CreateFromDirectoryAsync (sourceDirectoryName As String, destination As Stream, includeBaseDirectory As Boolean, Optional cancellationToken As CancellationToken = Nothing) As Task

參數

sourceDirectoryName

String

要封存的目錄路徑。

destination

Stream

封存的目的地數據流。

includeBaseDirectory

Boolean

true 將基底目錄名稱包含在封存專案的所有名稱中作為第一個路徑區段。 false 表示從項目名稱路徑中排除基底目錄名稱。

cancellationToken

CancellationToken

用來監視是否有取消要求的語彙基元。 預設值是 None。

傳回

Task

表示異步建立作業的工作。

例外狀況

ArgumentNullException

sourceDirectoryName 或 destination 為 null。

ArgumentException

sourceDirectoryName 是空的。

-或-

destination 不支援寫入。

DirectoryNotFoundException

sourceDirectoryName找不到目錄路徑。

IOException

發生 I/O 例外狀況。

OperationCanceledException

取消標記已取消。 此例外狀況會儲存在傳回的工作中。

備註

這個方法會儲存在工作中，它會傳回方法同步對應專案可以擲回的所有非使用例外狀況。 如果例外狀況儲存在傳回的工作中，則會在等候工作時擲回該例外狀況。 使用例外狀況，例如 ArgumentException仍會同步擲回。 如需預存例外狀況，請參閱 擲回的 CreateFromDirectory(String, Stream, Boolean)例外狀況。

CreateFromDirectoryAsync(String, String, Boolean, CancellationToken)

來源:

TarFile.cs

以異步方式從指定目錄的內容建立 tar 封存，並將其輸出至指定的路徑。 可以選擇性地包含基底目錄做為專案名稱的前置詞。

public static System.Threading.Tasks.Task CreateFromDirectoryAsync (string sourceDirectoryName, string destinationFileName, bool includeBaseDirectory, System.Threading.CancellationToken cancellationToken = default);

static member CreateFromDirectoryAsync : string * string * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Shared Function CreateFromDirectoryAsync (sourceDirectoryName As String, destinationFileName As String, includeBaseDirectory As Boolean, Optional cancellationToken As CancellationToken = Nothing) As Task

參數

sourceDirectoryName

String

要封存的目錄路徑。

destinationFileName

String

目的地封存盤案的路徑。

includeBaseDirectory

Boolean

true 將基底目錄名稱包含在封存專案的所有名稱中作為第一個路徑區段。 false 表示從項目名稱路徑中排除基底目錄名稱。

cancellationToken

CancellationToken

用來監視是否有取消要求的語彙基元。 預設值是 None。

傳回

Task

表示異步建立作業的工作。

例外狀況

ArgumentNullException

sourceDirectoryName 或 destinationFileName 為 null。

ArgumentException

sourceDirectoryName 或 destinationFileName 是空的。

DirectoryNotFoundException

sourceDirectoryName找不到目錄路徑。

IOException

發生 I/O 例外狀況。

OperationCanceledException

取消標記已取消。 此例外狀況會儲存在傳回的工作中。

備註

這個方法會儲存在工作中，它會傳回方法同步對應專案可以擲回的所有非使用例外狀況。 如果例外狀況儲存在傳回的工作中，則會在等候工作時擲回該例外狀況。 使用例外狀況，例如 ArgumentException仍會同步擲回。 如需預存例外狀況，請參閱 擲回的 CreateFromDirectory(String, String, Boolean)例外狀況。