TarFile.CreateFromDirectoryAsync メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
オーバーロード
| CreateFromDirectoryAsync(String, Stream, Boolean, CancellationToken) |
指定したディレクトリのすべてのファイルシステム エントリを含む tar ストリームを非同期的に作成します。 |
| CreateFromDirectoryAsync(String, String, Boolean, CancellationToken) |
指定したディレクトリの内容から tar アーカイブを非同期に作成し、指定したパスに出力します。 必要に応じて、エントリ名のプレフィックスとしてベース ディレクトリを含めることができます。 |
CreateFromDirectoryAsync(String, Stream, Boolean, CancellationToken)
- ソース:
- 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 です。
戻り値
非同期作成操作を表すタスク。
例外
sourceDirectoryName または destination が null です。
sourceDirectoryNameディレクトリ パスが見つかりません。
I/O 例外が発生しました。
キャンセル トークンが取り消されました。 この例外は、返されたタスクに格納されます。
注釈
このメソッドは、メソッドの同期的な例外がスローできる非使用例外をすべて返すタスクに格納します。 返されたタスクに例外が格納されている場合、その例外はタスクの待機時にスローされます。 などの ArgumentException使用例外は、引き続き同期的にスローされます。 格納されている例外については、 によって CreateFromDirectory(String, Stream, Boolean)スローされる例外に関するページを参照してください。
適用対象
CreateFromDirectoryAsync(String, String, Boolean, CancellationToken)
- ソース:
- 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 です。
戻り値
非同期作成操作を表すタスク。
例外
sourceDirectoryName または destinationFileName が null です。
sourceDirectoryName または destinationFileName が空です。
sourceDirectoryNameディレクトリ パスが見つかりません。
I/O 例外が発生しました。
キャンセル トークンが取り消されました。 この例外は、返されたタスクに格納されます。
注釈
このメソッドは、メソッドの同期的な例外がスローできる非使用例外をすべて返すタスクに格納します。 返されたタスクに例外が格納されている場合、その例外はタスクの待機時にスローされます。 などの ArgumentException使用例外は、引き続き同期的にスローされます。 格納されている例外については、 によって CreateFromDirectory(String, String, Boolean)スローされる例外に関するページを参照してください。