Język

TarEntry.ExtractToFileAsync(String, Boolean, CancellationToken) Metoda

Definicja

Asynchronicznie wyodrębnia bieżący wpis do systemu plików.

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

Parametry

destinationFileName
String

Ścieżka do pliku docelowego.

overwrite
Boolean

true jeśli ta metoda powinna zastąpić dowolny istniejący obiekt systemu plików znajdujący się w ścieżce destinationFileName ; false aby zapobiec zastępowaniu.

cancellationToken
CancellationToken

Token do monitorowania żądań anulowania. Wartość domyślna to None.

Zwraca

Zadanie reprezentujące operację wyodrębniania asynchronicznego.

Wyjątki

Parametr destinationFileName ma wartość null.

destinationFileName jest pusta.

Katalog nadrzędny obiektu destinationFileName nie istnieje.

— lub —

overwrite to false i plik już istnieje w pliku destinationFileName.

— lub —

Istnieje katalog o takiej samej nazwie jak destinationFileName.

— lub —

Wystąpił problem z we/wy.

Typ wpisu jest nieobsługiwany.

Uprawnienia są niewystarczające.

Token anulowania został anulowany. Ten wyjątek jest przechowywany w zwracanym zadaniu.

Uwagi

Pliki typu BlockDevice, CharacterDevicelub Fifo mogą być wyodrębniane tylko na platformach Unix.

Podniesienie uprawnień jest wymagane do wyodrębnienia BlockDevice dysku lub CharacterDevice .

Ta metoda przechowuje w zadaniu zwraca wszystkie wyjątki inne niż użycie, które może zgłosić synchroniczna odpowiednik metody. Jeśli wyjątek jest przechowywany w zwróconym zadaniu, ten wyjątek zostanie zgłoszony, gdy zadanie będzie oczekiwać. Wyjątki użycia, takie jak ArgumentException, są nadal zgłaszane synchronicznie. Aby uzyskać informacje o przechowywanych wyjątkach, zobacz wyjątki zgłaszane przez program ExtractToFile(String, Boolean).

Dotyczy