TarEntry.ExtractToFileAsync(String, Boolean, CancellationToken) メソッド

定義

名前空間:

System.Formats.Tar

アセンブリ:

System.Formats.Tar.dll

ソース:

TarEntry.cs

現在のエントリをファイル システムに非同期的に抽出します。

public System.Threading.Tasks.Task ExtractToFileAsync (string destinationFileName, bool overwrite, System.Threading.CancellationToken cancellationToken = default);

member this.ExtractToFileAsync : string * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Function ExtractToFileAsync (destinationFileName As String, overwrite As Boolean, Optional cancellationToken As CancellationToken = Nothing) As Task

パラメーター

destinationFileName

String

コピー先ファイルへのパス。

overwrite

Boolean

trueこのメソッドがパスfalseにある既存のファイルシステムオブジェクトを上書きするdestinationFileName必要がある場合は 。上書きを防ぐためです。

cancellationToken

CancellationToken

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

戻り値

Task

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

例外

ArgumentNullException

destinationFileName が nullです。

ArgumentException

destinationFileName が空です。

IOException

の親ディレクトリ destinationFileName が存在しません。

または

overwrite は false で、ファイルは に既に destinationFileName存在します。

または

ディレクトリは と同じ名前 destinationFileNameで存在します。

または

I/O の問題が発生しました。

InvalidOperationException

エントリの種類はサポートされていません。

UnauthorizedAccessException

アクセス許可が不十分です。

OperationCanceledException

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

注釈

、CharacterDevice、または Fifo 型BlockDeviceのファイルは、Unix プラットフォームでのみ抽出できます。

または CharacterDevice をディスクに抽出BlockDeviceするには、昇格が必要です。

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