TarEntry.ExtractToFileAsync(String, Boolean, CancellationToken) Método

Definição

Namespace:

System.Formats.Tar

Assembly:

System.Formats.Tar.dll

Origem:

TarEntry.cs

Extrai de forma assíncrona a entrada atual para o sistema de arquivos.

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

Parâmetros

destinationFileName

String

O caminho para o arquivo de destino.

overwrite

Boolean

truese esse método deve substituir qualquer objeto de sistema de arquivos existente localizado no caminho; false para evitar a destinationFileName substituição.

cancellationToken

CancellationToken

O token a se monitorar para solicitações de cancelamento. O valor padrão é None.

Retornos

Task

Uma tarefa que representa a operação de extração assíncrona.

Exceções

ArgumentNullException

destinationFileName é null.

ArgumentException

destinationFileName está vazio.

IOException

O diretório pai de destinationFileName não existe.

-ou-

overwrite é false e um arquivo já existe em destinationFileName.

-ou-

Existe um diretório com o mesmo nome que destinationFileName.

-ou-

Ocorreu um problema de E/S.

InvalidOperationException

O tipo de entrada não tem suporte.

UnauthorizedAccessException

As permissões são insuficientes.

OperationCanceledException

O token de cancelamento foi cancelado. Essa exceção é armazenada na tarefa retornada.

Comentários

Arquivos do tipo BlockDevice, CharacterDeviceou Fifo só podem ser extraídos em plataformas Unix.

A elevação é necessária para extrair um ou CharacterDevice para o BlockDevice disco.

Esse método armazena na tarefa que retorna todas as exceções de não uso que a contraparte síncrona do método pode gerar. Se uma exceção for armazenada na tarefa retornada, essa exceção será gerada quando a tarefa for aguardada. Exceções de uso, como ArgumentException, ainda são geradas de forma síncrona. Para as exceções armazenadas, consulte as exceções geradas por ExtractToFile(String, Boolean).