TarEntry.ExtractToFileAsync(String, Boolean, CancellationToken) Метод

Определение

Пространство имен:

System.Formats.Tar

Сборка:

System.Formats.Tar.dll

Исходный код:

TarEntry.cs

Асинхронно извлекает текущую запись в файловую систему.

public System.Threading.Tasks.Task ExtractToFileAsync (string destinationFileName, bool overwrite, System.Threading.CancellationToken cancellationToken = default);

member this.ExtractToFileAsync : string * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Function ExtractToFileAsync (destinationFileName As String, overwrite As Boolean, Optional cancellationToken As CancellationToken = Nothing) As Task

Параметры

destinationFileName

String

Путь к целевому файлу.

overwrite

Boolean

true Значение , если этот метод должен перезаписать любой существующий объект файловой системы, расположенный destinationFileName в пути; значение , false чтобы предотвратить перезапись.

cancellationToken

CancellationToken

Токен для отслеживания запросов отмены. Значение по умолчанию — None.

Возвращаемое значение

Task

Задача, представляющая асинхронную операцию извлечения.

Исключения

ArgumentNullException

destinationFileName имеет значение null.

ArgumentException

Параметр destinationFileName пуст.

IOException

Родительский destinationFileName каталог не существует.

-или-

overwrite имеет значение false , а файл уже существует в destinationFileName.

-или-

Существует каталог с тем же именем, что и destinationFileName.

-или-

Возникла проблема ввода-вывода.

InvalidOperationException

Тип записи не поддерживается.

UnauthorizedAccessException

Недостаточно разрешений.

OperationCanceledException

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

Комментарии

Файлы типа BlockDevice, CharacterDeviceили Fifo можно извлечь только на платформах Unix.

Для извлечения BlockDevice или CharacterDevice на диск требуется повышение прав.

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