ZipFile.CreateFromDirectoryAsync メソッド

ソース:

ZipFile.Create.Async.cs

ソース:

ZipFile.Create.Async.cs

public static System.Threading.Tasks.Task CreateFromDirectoryAsync(string sourceDirectoryName, string destinationArchiveFileName, System.IO.Compression.CompressionLevel compressionLevel, bool includeBaseDirectory, System.Text.Encoding? entryNameEncoding, System.Threading.CancellationToken cancellationToken = default);

static member CreateFromDirectoryAsync : string * string * System.IO.Compression.CompressionLevel * bool * System.Text.Encoding * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Shared Function CreateFromDirectoryAsync (sourceDirectoryName As String, destinationArchiveFileName As String, compressionLevel As CompressionLevel, includeBaseDirectory As Boolean, entryNameEncoding As Encoding, Optional cancellationToken As CancellationToken = Nothing) As Task

パラメーター

返品

例外

注釈

ディレクトリ構造はアーカイブに保持され、アーカイブするファイルに対して再帰的な検索が実行されます。 アーカイブは存在してはなりません。 ディレクトリが空の場合は、空のアーカイブが作成されます。

ディレクトリ内のファイルをアーカイブに追加できない場合、アーカイブは不完全で無効なままになり、メソッドは例外をスローします。 このメソッドは、必要に応じて、アーカイブにベース ディレクトリを含めます。

アーカイブへのファイルの追加中にエラーが発生した場合、このメソッドはファイルの追加を停止し、アーカイブを無効な状態のままにします。 パスには、相対パスまたは絶対パス情報を指定できます。 相対パス情報は、現在の作業ディレクトリに対する相対パスとして解釈されます。 アーカイブ内のファイルの最終書き込み時刻フィールドに有効な zip タイムスタンプではないデータがある場合、ファイルの最終変更時刻に 1980 年 1 月 1 日午前 0 時のインジケーター値が使用されます。指定した名前のエントリがアーカイブに既に存在する場合は、同じ名前の 2 番目のエントリが作成されます。 CompressionLevelが指定されていないため、基になる圧縮アルゴリズムの実装によって提供される既定値が使用されます。ZipArchiveは独自の既定値を適用しません。

(現在、基になる圧縮アルゴリズムは、 DeflateStream クラスによって提供されています)。

entryNameEncoding以外のnullの値を指定することはお勧めしません。

ただし、エントリ名またはコメントに対して UTF-8 エンコードが正しくサポートされていない zip アーカイブ ツールやライブラリとの相互運用性のために、これが必要になる場合があります。

• entryNameEncodingが指定されていない場合 (== null):
  • ASCII 範囲外の文字を含むファイル名またはコメントの場合:
    言語エンコード フラグ (EFS) は、対応するエントリのローカル ファイル ヘッダーの汎用ビット フラグに設定され、UTF-8 (Encoding.UTF8) を使用してエントリ名とコメントをバイトにエンコードします。
  • ASCII 範囲外の文字を含まないファイル名またはコメントの場合:
    言語エンコード フラグ (EFS) は、対応するエントリのローカル ファイル ヘッダーの汎用ビット フラグには設定されず、現在のシステムの既定のコード ページ (Encoding.Default) を使用して、エントリ名とコメントをバイトにエンコードします。
• entryNameEncodingが指定されている場合 (!= null):
  • 指定した entryNameEncoding は、エントリ名とコメントをバイトにエンコードするために常に使用されます。
    指定した entryNameEncoding が UTF-8 エンコードの場合にのみ、各エントリのローカル ファイル ヘッダーの汎用ビット フラグの言語エンコード フラグ (EFS) が設定されます。

UTF-8 以外の Unicode エンコードは entryNameEncodingに使用できません。それ以外の場合は、 ArgumentException がスローされます。

ソース:

ZipFile.Create.Async.cs

ソース:

ZipFile.Create.Async.cs

public static System.Threading.Tasks.Task CreateFromDirectoryAsync(string sourceDirectoryName, System.IO.Stream destination, System.IO.Compression.CompressionLevel compressionLevel, bool includeBaseDirectory, System.Text.Encoding? entryNameEncoding, System.Threading.CancellationToken cancellationToken = default);

static member CreateFromDirectoryAsync : string * System.IO.Stream * System.IO.Compression.CompressionLevel * bool * System.Text.Encoding * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Shared Function CreateFromDirectoryAsync (sourceDirectoryName As String, destination As Stream, compressionLevel As CompressionLevel, includeBaseDirectory As Boolean, entryNameEncoding As Encoding, Optional cancellationToken As CancellationToken = Nothing) As Task

パラメーター

返品

例外

注釈

ファイル システムのディレクトリ構造はアーカイブに保持されます。 ディレクトリが空の場合は、空のアーカイブが作成されます。

圧縮レベルと文字エンコード、およびベース ディレクトリをアーカイブに含めるかどうかを指定するには、このメソッドオーバーロードを使用します。

ディレクトリ内のファイルをアーカイブに追加できない場合、アーカイブは不完全で無効なままになり、メソッドは IOException 例外をスローします。

ソース:

ZipFile.Create.Async.cs

ソース:

ZipFile.Create.Async.cs

public static System.Threading.Tasks.Task CreateFromDirectoryAsync(string sourceDirectoryName, string destinationArchiveFileName, System.IO.Compression.CompressionLevel compressionLevel, bool includeBaseDirectory, System.Threading.CancellationToken cancellationToken = default);

static member CreateFromDirectoryAsync : string * string * System.IO.Compression.CompressionLevel * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Shared Function CreateFromDirectoryAsync (sourceDirectoryName As String, destinationArchiveFileName As String, compressionLevel As CompressionLevel, includeBaseDirectory As Boolean, Optional cancellationToken As CancellationToken = Nothing) As Task

パラメーター

返品

例外

注釈

ディレクトリ構造はアーカイブに保持され、アーカイブするファイルに対して再帰的な検索が実行されます。 アーカイブは存在してはなりません。 ディレクトリが空の場合は、空のアーカイブが作成されます。

ディレクトリ内のファイルをアーカイブに追加できない場合、アーカイブは不完全で無効なままになり、メソッドは例外をスローします。 このメソッドは、必要に応じて、アーカイブにベース ディレクトリを含めます。

アーカイブへのファイルの追加中にエラーが発生した場合、このメソッドはファイルの追加を停止し、アーカイブを無効な状態のままにします。 パスには、相対パスまたは絶対パス情報を指定できます。 相対パス情報は、現在の作業ディレクトリに対する相対パスとして解釈されます。 アーカイブ内のファイルの最終書き込み時刻フィールドに有効な zip タイムスタンプではないデータがある場合、ファイルの最終変更時刻に 1980 年 1 月 1 日午前 0 時のインジケーター値が使用されます。指定した名前のエントリがアーカイブに既に存在する場合は、同じ名前の 2 番目のエントリが作成されます。 CompressionLevelが指定されていないため、基になる圧縮アルゴリズムの実装によって提供される既定値が使用されます。ZipArchiveは独自の既定値を適用しません。

(現在、基になる圧縮アルゴリズムは、 DeflateStream クラスによって提供されています)。

ソース:

ZipFile.Create.Async.cs

ソース:

ZipFile.Create.Async.cs

public static System.Threading.Tasks.Task CreateFromDirectoryAsync(string sourceDirectoryName, System.IO.Stream destination, System.IO.Compression.CompressionLevel compressionLevel, bool includeBaseDirectory, System.Threading.CancellationToken cancellationToken = default);

static member CreateFromDirectoryAsync : string * System.IO.Stream * System.IO.Compression.CompressionLevel * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Shared Function CreateFromDirectoryAsync (sourceDirectoryName As String, destination As Stream, compressionLevel As CompressionLevel, includeBaseDirectory As Boolean, Optional cancellationToken As CancellationToken = Nothing) As Task

パラメーター

返品

例外

注釈

ファイル システムのディレクトリ構造はアーカイブに保持されます。 ディレクトリが空の場合は、空のアーカイブが作成されます。

このメソッドのオーバーロードを使用して、圧縮レベルと、ベース ディレクトリをアーカイブに含めるかどうかを指定します。

ディレクトリ内のファイルをアーカイブに追加できない場合、アーカイブは不完全で無効なままになり、メソッドは IOException 例外をスローします。

ソース:

ZipFile.Create.Async.cs

ソース:

ZipFile.Create.Async.cs

public static System.Threading.Tasks.Task CreateFromDirectoryAsync(string sourceDirectoryName, string destinationArchiveFileName, System.Threading.CancellationToken cancellationToken = default);

static member CreateFromDirectoryAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Shared Function CreateFromDirectoryAsync (sourceDirectoryName As String, destinationArchiveFileName As String, Optional cancellationToken As CancellationToken = Nothing) As Task

パラメーター

返品

例外

注釈

ディレクトリ構造はアーカイブに保持され、アーカイブするファイルに対して再帰的な検索が実行されます。 アーカイブは存在してはなりません。 ディレクトリが空の場合は、空のアーカイブが作成されます。 ディレクトリ内のファイルをアーカイブに追加できない場合、アーカイブは不完全で無効なままになり、メソッドは例外をスローします。 このメソッドでは、ベース ディレクトリはアーカイブに含まれません。

アーカイブへのファイルの追加中にエラーが発生した場合、このメソッドはファイルの追加を停止し、アーカイブを無効な状態のままにします。 パスには、相対パスまたは絶対パス情報を指定できます。 相対パス情報は、現在の作業ディレクトリに対する相対パスとして解釈されます。 アーカイブ内のファイルの最終書き込み時刻フィールドに有効な zip タイムスタンプではないデータがある場合、ファイルの最終変更時刻に 1980 年 1 月 1 日午前 0 時のインジケーター値が使用されます。指定した名前のエントリがアーカイブに既に存在する場合は、同じ名前の 2 つ目のエントリが作成されます。 CompressionLevelが指定されていないため、基になる圧縮アルゴリズムの実装によって提供される既定値が使用されます。ZipArchiveでは独自の既定値は適用されません。

(現在、基になる圧縮アルゴリズムは、 DeflateStream クラスによって提供されています)。

ソース:

ZipFile.Create.Async.cs

ソース:

ZipFile.Create.Async.cs

public static System.Threading.Tasks.Task CreateFromDirectoryAsync(string sourceDirectoryName, System.IO.Stream destination, System.Threading.CancellationToken cancellationToken = default);

static member CreateFromDirectoryAsync : string * System.IO.Stream * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Shared Function CreateFromDirectoryAsync (sourceDirectoryName As String, destination As Stream, Optional cancellationToken As CancellationToken = Nothing) As Task

パラメーター

返品

例外

注釈

ファイル システムのディレクトリ構造はアーカイブに保持されます。 ディレクトリが空の場合は、空のアーカイブが作成されます。

このメソッドのオーバーロードには、アーカイブ内のベース ディレクトリは含まれていないので、圧縮レベルを指定することはできません。

ベース ディレクトリを含める場合、または圧縮レベルを指定する場合は、 CreateFromDirectory(String, Stream, CompressionLevel, Boolean) メソッドのオーバーロードを呼び出します。

ディレクトリ内のファイルをアーカイブに追加できない場合、アーカイブは不完全で無効なままになり、メソッドは IOException 例外をスローします。