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

Definición

Espacio de nombres:

System.Formats.Tar

Ensamblado:

System.Formats.Tar.dll

Source:

TarEntry.cs

Extrae de forma asincrónica la entrada actual en el sistema de archivos.

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

Ruta de acceso al archivo de destino.

overwrite

Boolean

true si este método debe sobrescribir cualquier objeto del sistema de archivos existente ubicado en la destinationFileName ruta de acceso; false para evitar la sobrescritura.

cancellationToken

CancellationToken

Token para supervisar solicitudes de cancelación. El valor predeterminado es None.

Devoluciones

Task

Tarea que representa la operación de extracción asincrónica.

Excepciones

ArgumentNullException

destinationFileName es null.

ArgumentException

destinationFileName está vacía.

IOException

El directorio primario de destinationFileName no existe.

O bien

overwrite es false y ya existe un archivo en destinationFileName.

O bien

Existe un directorio con el mismo nombre que destinationFileName.

O bien

Se produjo un problema de E/S.

InvalidOperationException

El tipo de entrada no es compatible.

UnauthorizedAccessException

Los permisos son insuficientes.

OperationCanceledException

Se canceló el token de cancelación. Esta excepción se almacena en la tarea devuelta.

Comentarios

Los archivos de tipo BlockDevice, CharacterDeviceo Fifo solo se pueden extraer en plataformas Unix.

La elevación es necesaria para extraer un BlockDevice o CharacterDevice en el disco.

Este método almacena en la tarea que devuelve todas las excepciones que no son de uso que puede producir el homólogo sincrónico del método. Si se almacena una excepción en la tarea devuelta, se producirá esa excepción cuando se espere la tarea. Las excepciones de uso, como ArgumentException, se siguen iniciando de forma sincrónica. Para ver las excepciones almacenadas, consulte las excepciones producidas por ExtractToFile(String, Boolean).