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

Произошло исключение ввода-вывода.

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

Произошло исключение ввода-вывода.

OperationCanceledException

Маркер отмены был отменен. Это исключение сохраняется в возвращаемой задаче.

Комментарии

Этот метод сохраняет в задаче все исключения, не относящиеся к использованию, которые может создавать синхронный аналог метода. Если исключение сохраняется в возвращаемой задаче, это исключение будет создано при ожидании задачи. Исключения использования, такие как ArgumentException, по-прежнему создаются синхронно. Хранимые исключения см. в разделе исключения, создаваемые CreateFromDirectory(String, String, Boolean).