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)

Source:

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)

Source:

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)异常。