TarFile.CreateFromDirectoryAsync メソッド

定義

名前空間:
System.Formats.Tar
アセンブリ:
System.Formats.Tar.dll

オーバーロード

名前 説明
CreateFromDirectoryAsync(String, String, Boolean, TarWriterOptions, CancellationToken)
CreateFromDirectoryAsync(String, String, Boolean, TarEntryFormat, CancellationToken)
CreateFromDirectoryAsync(String, Stream, Boolean, TarWriterOptions, CancellationToken)
CreateFromDirectoryAsync(String, String, Boolean, CancellationToken)

指定したディレクトリの内容から tar アーカイブを非同期に作成し、指定したパスに出力します。 必要に応じて、エントリ名のプレフィックスとしてベース ディレクトリを含めることができます。
CreateFromDirectoryAsync(String, Stream, Boolean, CancellationToken)

指定したディレクトリからのすべてのファイルシステム エントリを含む tar ストリームを非同期的に作成します。
CreateFromDirectoryAsync(String, Stream, Boolean, TarEntryFormat, CancellationToken)

CreateFromDirectoryAsync(String, String, Boolean, TarWriterOptions, CancellationToken)

ソース:
TarFile.cs
public static System.Threading.Tasks.Task CreateFromDirectoryAsync(string sourceDirectoryName, string destinationFileName, bool includeBaseDirectory, System.Formats.Tar.TarWriterOptions options, System.Threading.CancellationToken cancellationToken = default);
static member CreateFromDirectoryAsync : string * string * bool * System.Formats.Tar.TarWriterOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Shared Function CreateFromDirectoryAsync (sourceDirectoryName As String, destinationFileName As String, includeBaseDirectory As Boolean, options As TarWriterOptions, Optional cancellationToken As CancellationToken = Nothing) As Task

パラメーター

sourceDirectoryName
String
destinationFileName
String
includeBaseDirectory
Boolean
options
TarWriterOptions
cancellationToken
CancellationToken

返品

Task

適用対象

CreateFromDirectoryAsync(String, String, Boolean, TarEntryFormat, CancellationToken)

ソース:
TarFile.cs
public static System.Threading.Tasks.Task CreateFromDirectoryAsync(string sourceDirectoryName, string destinationFileName, bool includeBaseDirectory, System.Formats.Tar.TarEntryFormat format, System.Threading.CancellationToken cancellationToken = default);
static member CreateFromDirectoryAsync : string * string * bool * System.Formats.Tar.TarEntryFormat * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Shared Function CreateFromDirectoryAsync (sourceDirectoryName As String, destinationFileName As String, includeBaseDirectory As Boolean, format As TarEntryFormat, Optional cancellationToken As CancellationToken = Nothing) As Task

パラメーター

sourceDirectoryName
String
destinationFileName
String
includeBaseDirectory
Boolean
format
TarEntryFormat
cancellationToken
CancellationToken

返品

Task

適用対象

CreateFromDirectoryAsync(String, Stream, Boolean, TarWriterOptions, CancellationToken)

ソース:
TarFile.cs
public static System.Threading.Tasks.Task CreateFromDirectoryAsync(string sourceDirectoryName, System.IO.Stream destination, bool includeBaseDirectory, System.Formats.Tar.TarWriterOptions options, System.Threading.CancellationToken cancellationToken = default);
static member CreateFromDirectoryAsync : string * System.IO.Stream * bool * System.Formats.Tar.TarWriterOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Shared Function CreateFromDirectoryAsync (sourceDirectoryName As String, destination As Stream, includeBaseDirectory As Boolean, options As TarWriterOptions, Optional cancellationToken As CancellationToken = Nothing) As Task

パラメーター

sourceDirectoryName
String
destination
Stream
includeBaseDirectory
Boolean
options
TarWriterOptions
cancellationToken
CancellationToken

返品

Task

適用対象

CreateFromDirectoryAsync(String, String, Boolean, CancellationToken)

ソース:
TarFile.cs
ソース:
TarFile.cs
ソース:
TarFile.cs
ソース:
TarFile.cs
ソース:
TarFile.cs

指定したディレクトリの内容から tar アーカイブを非同期に作成し、指定したパスに出力します。 必要に応じて、エントリ名のプレフィックスとしてベース ディレクトリを含めることができます。

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

パラメーター

sourceDirectoryName
String

アーカイブするディレクトリのパス。

destinationFileName
String

コピー先のアーカイブ ファイルのパス。

includeBaseDirectory
Boolean

true は、アーカイブ 項目のすべての名前に最初のパス・セグメントとして基本ディレクトリー名を含める場合に使用します。 false では、エントリ名のパスからベース ディレクトリ名を除外します。

cancellationToken
CancellationToken

キャンセル要求を監視するトークン。 既定値は None です。

返品

Task

非同期作成操作を表すタスク。

例外

ArgumentNullException

sourceDirectoryName または destinationFileName が null。

ArgumentException

sourceDirectoryName または destinationFileName が空です。

DirectoryNotFoundException

sourceDirectoryName ディレクトリ パスが見つかりません。

IOException

I/O 例外が発生しました。

OperationCanceledException

キャンセル トークンが取り消されました。 この例外は、返されたタスクに格納されます。

注釈

このメソッドは、メソッドの同期的な例外がスローできるすべての非使用例外を返すタスクに格納します。 返されたタスクに例外が格納されている場合、その例外はタスクが待機しているときにスローされます。 ArgumentException などの使用に関する例外は、引き続き同期的にスローされます。 格納されている例外については、 CreateFromDirectory(String, String, Boolean)によってスローされる例外を参照してください。

適用対象

CreateFromDirectoryAsync(String, Stream, Boolean, CancellationToken)

ソース:
TarFile.cs
ソース:
TarFile.cs
ソース:
TarFile.cs
ソース:
TarFile.cs
ソース:
TarFile.cs

指定したディレクトリからのすべてのファイルシステム エントリを含む tar ストリームを非同期的に作成します。

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

パラメーター

sourceDirectoryName
String

アーカイブするディレクトリのパス。

destination
Stream

アーカイブの宛先ストリーム。

includeBaseDirectory
Boolean

true は、アーカイブ 項目のすべての名前に最初のパス・セグメントとして基本ディレクトリー名を含める場合に使用します。 false では、エントリ名のパスからベース ディレクトリ名を除外します。

cancellationToken
CancellationToken

キャンセル要求を監視するトークン。 既定値は None です。

返品

Task

非同期作成操作を表すタスク。

例外

ArgumentNullException

sourceDirectoryName または destination が null。

ArgumentException

sourceDirectoryName が空です。

-又は-

destination は書き込みをサポートしていません。

DirectoryNotFoundException

sourceDirectoryName ディレクトリ パスが見つかりません。

IOException

I/O 例外が発生しました。

OperationCanceledException

キャンセル トークンが取り消されました。 この例外は、返されたタスクに格納されます。

注釈

このメソッドは、メソッドの同期的な例外がスローできるすべての非使用例外を返すタスクに格納します。 返されたタスクに例外が格納されている場合、その例外はタスクが待機しているときにスローされます。 ArgumentException などの使用に関する例外は、引き続き同期的にスローされます。 格納されている例外については、 CreateFromDirectory(String, Stream, Boolean)によってスローされる例外を参照してください。

適用対象

CreateFromDirectoryAsync(String, Stream, Boolean, TarEntryFormat, CancellationToken)

ソース:
TarFile.cs
public static System.Threading.Tasks.Task CreateFromDirectoryAsync(string sourceDirectoryName, System.IO.Stream destination, bool includeBaseDirectory, System.Formats.Tar.TarEntryFormat format, System.Threading.CancellationToken cancellationToken = default);
static member CreateFromDirectoryAsync : string * System.IO.Stream * bool * System.Formats.Tar.TarEntryFormat * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Shared Function CreateFromDirectoryAsync (sourceDirectoryName As String, destination As Stream, includeBaseDirectory As Boolean, format As TarEntryFormat, Optional cancellationToken As CancellationToken = Nothing) As Task

パラメーター

sourceDirectoryName
String
destination
Stream
includeBaseDirectory
Boolean
format
TarEntryFormat
cancellationToken
CancellationToken

返品

Task

適用対象