TarFile.CreateFromDirectoryAsync Metoda

Definicja

Przestrzeń nazw:

System.Formats.Tar

Zestaw:

System.Formats.Tar.dll

Przeciążenia

Nazwa	Opis
CreateFromDirectoryAsync(String, String, Boolean, CancellationToken)	Asynchronicznie tworzy archiwum tar z zawartości określonego katalogu i przekazuje je do określonej ścieżki. Opcjonalnie może zawierać katalog podstawowy jako prefiks nazw wpisów.
CreateFromDirectoryAsync(String, Stream, Boolean, CancellationToken)	Asynchronicznie tworzy strumień tar zawierający wszystkie wpisy systemu plików z określonego katalogu.

CreateFromDirectoryAsync(String, String, Boolean, CancellationToken)

Źródło:

TarFile.cs

Asynchronicznie tworzy archiwum tar z zawartości określonego katalogu i przekazuje je do określonej ścieżki. Opcjonalnie może zawierać katalog podstawowy jako prefiks nazw wpisów.

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

Parametry

sourceDirectoryName

String

Ścieżka katalogu do archiwum.

destinationFileName

String

Ścieżka pliku archiwum docelowego.

includeBaseDirectory

Boolean

true aby uwzględnić nazwę katalogu podstawowego jako pierwszy segment ścieżki we wszystkich nazwach wpisów archiwum. false aby wykluczyć nazwę katalogu podstawowego ze ścieżek nazw wpisów.

cancellationToken

CancellationToken

Token do monitorowania żądań anulowania. Domyślna wartość to None.

Zwraca

Task

Zadanie reprezentujące operację tworzenia asynchronicznego.

Wyjątki

ArgumentNullException

sourceDirectoryName lub destinationFileName ma wartość null.

ArgumentException

sourceDirectoryName lub destinationFileName jest pusty.

DirectoryNotFoundException

Nie sourceDirectoryName można odnaleźć ścieżki katalogu.

IOException

Wystąpił wyjątek we/wy.

OperationCanceledException

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

Uwagi

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 CreateFromDirectory(String, String, Boolean).

CreateFromDirectoryAsync(String, Stream, Boolean, CancellationToken)

Źródło:

TarFile.cs

Asynchronicznie tworzy strumień tar zawierający wszystkie wpisy systemu plików z określonego katalogu.

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

Parametry

sourceDirectoryName

String

Ścieżka katalogu do archiwum.

destination

Stream

Docelowy strumień archiwum.

includeBaseDirectory

Boolean

true aby uwzględnić nazwę katalogu podstawowego jako pierwszy segment ścieżki we wszystkich nazwach wpisów archiwum. false aby wykluczyć nazwę katalogu podstawowego ze ścieżek nazw wpisów.

cancellationToken

CancellationToken

Token do monitorowania żądań anulowania. Domyślna wartość to None.

Zwraca

Task

Zadanie reprezentujące operację tworzenia asynchronicznego.

Wyjątki

ArgumentNullException

sourceDirectoryName lub destination ma wartość null.

ArgumentException

sourceDirectoryName jest pusta.

— lub —

destination nie obsługuje pisania.

DirectoryNotFoundException

Nie sourceDirectoryName można odnaleźć ścieżki katalogu.

IOException

Wystąpił wyjątek we/wy.

OperationCanceledException

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

Uwagi

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 CreateFromDirectory(String, Stream, Boolean).