ZipFileExtensions.ExtractToFileAsync メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
オーバーロード
| 名前 | 説明 |
|---|---|
| ExtractToFileAsync(ZipArchiveEntry, String, CancellationToken) |
エントリの内容と指定した名前を使用して、ファイル システム上にファイルを非同期に作成します。 |
| ExtractToFileAsync(ZipArchiveEntry, String, Boolean, CancellationToken) |
エントリの内容と指定した名前を使用して、ファイル システム上にファイルを非同期に作成します。 |
ExtractToFileAsync(ZipArchiveEntry, String, CancellationToken)
エントリの内容と指定した名前を使用して、ファイル システム上にファイルを非同期に作成します。
public static System.Threading.Tasks.Task ExtractToFileAsync(this System.IO.Compression.ZipArchiveEntry source, string destinationFileName, System.Threading.CancellationToken cancellationToken = default);
static member ExtractToFileAsync : System.IO.Compression.ZipArchiveEntry * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task
<Extension()>
Public Function ExtractToFileAsync (source As ZipArchiveEntry, destinationFileName As String, Optional cancellationToken As CancellationToken = Nothing) As Task
パラメーター
- source
- ZipArchiveEntry
ファイルを抽出する zip アーカイブ エントリ。
- destinationFileName
- String
エントリの内容を保持するファイルの名前。
- cancellationToken
- CancellationToken
キャンセル要求を監視するキャンセル トークン。
返品
例外
呼び出し元に必要なアクセス許可がありません。
destinationFileName は長さ 0 の文字列で、空白文字のみを含むか、InvalidPathChars で定義されている無効な文字を 1 つ以上含みます。
-又は-
destinationFileName はディレクトリを指定します。
destinationFileName は nullです。
指定したパス、ファイル名、またはその両方が、システム定義の最大長を超えています。 たとえば、Windows ベースのプラットフォームでは、パスは 248 文字未満にする必要があり、ファイル名は 260 文字未満にする必要があります。
destinationFileNameで指定されたパスが無効です (たとえば、マップされていないドライブ上にあります)。
エントリがアーカイブに存在しないか、破損しているため、読み取ることができません。
-又は-
エントリは、サポートされていない圧縮方法を使用して圧縮されています。
このエントリが属する ZipArchive が破棄されました。
注釈
指定したパスは、相対パス情報または絶対パス情報を指定できます。 相対パス情報は、現在の作業ディレクトリに対する相対パスとして解釈されます。
ファイルの最後の書き込み時刻は、エントリの最後の書き込み時刻に設定されます。 このメソッドでは、同じ名前の既存のファイルを上書きすることはできません。 明示的なディレクトリ (ディレクトリ区切り文字で終わる名前のエントリ) を抽出しようとしても、ディレクトリは作成されません。
適用対象
ExtractToFileAsync(ZipArchiveEntry, String, Boolean, CancellationToken)
エントリの内容と指定した名前を使用して、ファイル システム上にファイルを非同期に作成します。
public static System.Threading.Tasks.Task ExtractToFileAsync(this System.IO.Compression.ZipArchiveEntry source, string destinationFileName, bool overwrite, System.Threading.CancellationToken cancellationToken = default);
static member ExtractToFileAsync : System.IO.Compression.ZipArchiveEntry * string * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task
<Extension()>
Public Function ExtractToFileAsync (source As ZipArchiveEntry, destinationFileName As String, overwrite As Boolean, Optional cancellationToken As CancellationToken = Nothing) As Task
パラメーター
- source
- ZipArchiveEntry
ファイルを抽出する zip アーカイブ エントリ。
- destinationFileName
- String
エントリの内容を保持するファイルの名前。
- overwrite
- Boolean
true ファイルを上書きする場合。それ以外の場合 false 。
- cancellationToken
- CancellationToken
キャンセル要求を監視するキャンセル トークン。
返品
例外
呼び出し元に必要なアクセス許可がありません。
destinationFileName は長さ 0 の文字列で、空白文字のみを含むか、InvalidPathChars で定義されている無効な文字を 1 つ以上含みます。
-又は-
destinationFileName はディレクトリを指定します。
destinationFileName は nullです。
指定したパス、ファイル名、またはその両方が、システム定義の最大長を超えています。 たとえば、Windows ベースのプラットフォームでは、パスは 248 文字未満にする必要があり、ファイル名は 260 文字未満にする必要があります。
destinationFileNameで指定されたパスが無効です (たとえば、マップされていないドライブ上にあります)。
エントリがアーカイブに存在しないか、破損しているため、読み取ることができません。
-又は-
エントリは、サポートされていない圧縮方法を使用して圧縮されています。
このエントリが属する ZipArchive が破棄されました。
非同期操作は取り消されます。
注釈
指定したパスは、相対パス情報または絶対パス情報を指定できます。 相対パス情報は、現在の作業ディレクトリに対する相対パスとして解釈されます。
ファイルの最後の書き込み時刻は、エントリの最後の書き込み時刻に設定されます。
このメソッドでは、同じ名前の既存のファイルを上書きできます。