WebClient.DownloadFileTaskAsync メソッド

定義

名前空間:

System.Net

アセンブリ:

System.Net.WebClient.dll

タスク オブジェクトを使用した非同期操作として指定されたリソースをローカル ファイルにダウンロードします。 これらのメソッドは、呼び出し元のスレッドをブロックしません。

オーバーロード

DownloadFileTaskAsync(String, String)	タスク オブジェクトを使用した非同期操作として指定されたリソースをローカル ファイルにダウンロードします。
DownloadFileTaskAsync(Uri, String)	タスク オブジェクトを使用した非同期操作として指定されたリソースをローカル ファイルにダウンロードします。

DownloadFileTaskAsync(String, String)

ソース:

WebClient.cs

タスク オブジェクトを使用した非同期操作として指定されたリソースをローカル ファイルにダウンロードします。

public:
 System::Threading::Tasks::Task ^ DownloadFileTaskAsync(System::String ^ address, System::String ^ fileName);

public System.Threading.Tasks.Task DownloadFileTaskAsync (string address, string fileName);

member this.DownloadFileTaskAsync : string * string -> System.Threading.Tasks.Task

Public Function DownloadFileTaskAsync (address As String, fileName As String) As Task

パラメーター

address

String

ダウンロードするリソースの URI。

fileName

String

ローカル コンピューターに配置されるファイルの名前。

戻り値

Task

非同期操作を表すタスク オブジェクト。

例外

ArgumentNullException

address パラメーターが null です。

または

fileName パラメーターが null です。

WebException

BaseAddress および address を組み合わせて形成された URI が無効です。

- または -

リソースのダウンロード中にエラーが発生しました。

InvalidOperationException

fileName によって指定されたローカルファイルは別のスレッドで使用されています。

注釈

この操作はブロックされません。 返された Task オブジェクトは、データ リソースのダウンロード後に完了します。

このメソッドは、 パラメーターで 指定された URI でリソースを address ダウンロードします。 ダウンロードが正常に完了すると、ダウンロードしたファイルの名前がローカル コンピューターに表示 fileName されます。 ファイルは、スレッド プールから自動的に割り当てられるスレッド リソースを使用して非同期的にダウンロードされます。

.NET Framework および .NET Core 1.0 では、 メソッドを呼び出して完了していない非同期操作をCancelAsync取り消すことができます。

プロパティが空の BaseAddress 文字列 ("") address ではなく、絶対 URI を指定しない場合は、 address と組み合わせて BaseAddress 要求されたデータの絶対 URI を形成する相対 URI である必要があります。 プロパティが QueryString 空の文字列でない場合は、 に address追加されます。

この方法では、RETR コマンドを使用して FTP リソースをダウンロードします。 HTTP リソースの場合は、GET メソッドが使用されます。

Note

このメンバーは、アプリケーションでネットワーク トレースが有効にされている場合にトレース情報を出力します。 詳細については、「.NET Frameworkのネットワーク トレース」を参照してください。

ASP.NET ページでこのメソッドを使用すると、ページが実行されるアカウントにローカル ファイルへのアクセス許可がない場合にエラーが発生します。

DownloadFileTaskAsync(Uri, String)

ソース:

WebClient.cs

タスク オブジェクトを使用した非同期操作として指定されたリソースをローカル ファイルにダウンロードします。

public:
 System::Threading::Tasks::Task ^ DownloadFileTaskAsync(Uri ^ address, System::String ^ fileName);

public System.Threading.Tasks.Task DownloadFileTaskAsync (Uri address, string fileName);

member this.DownloadFileTaskAsync : Uri * string -> System.Threading.Tasks.Task

Public Function DownloadFileTaskAsync (address As Uri, fileName As String) As Task

パラメーター

address

Uri

ダウンロードするリソースの URI。

fileName

String

ローカル コンピューターに配置されるファイルの名前。

戻り値

Task

非同期操作を表すタスク オブジェクト。

例外

ArgumentNullException

address パラメーターが null です。

または

fileName パラメーターが null です。

WebException

BaseAddress および address を組み合わせて形成された URI が無効です。

- または -

リソースのダウンロード中にエラーが発生しました。

InvalidOperationException

fileName によって指定されたローカルファイルは別のスレッドで使用されています。

注釈

この操作はブロックされません。 返された Task オブジェクトは、データ リソースのダウンロード後に完了します。

このメソッドは、 パラメーターで 指定された URI でリソースを address ダウンロードします。 ダウンロードが正常に完了すると、ダウンロードしたファイルの名前がローカル コンピューターに表示 fileName されます。 ファイルは、スレッド プールから自動的に割り当てられるスレッド リソースを使用して非同期的にダウンロードされます。

.NET Framework および .NET Core 1.0 では、 メソッドを呼び出して完了していない非同期操作をCancelAsync取り消すことができます。

プロパティが空の BaseAddress 文字列 ("") address ではなく、絶対 URI を指定しない場合は、 address と組み合わせて BaseAddress 要求されたデータの絶対 URI を形成する相対 URI である必要があります。 プロパティが QueryString 空の文字列でない場合は、 に address追加されます。

この方法では、RETR コマンドを使用して FTP リソースをダウンロードします。 HTTP リソースの場合は、GET メソッドが使用されます。

Note

このメンバーは、アプリケーションでネットワーク トレースが有効にされている場合にトレース情報を出力します。 詳細については、「.NET Frameworkのネットワーク トレース」を参照してください。

ASP.NET ページでこのメソッドを使用すると、ページが実行されるアカウントにローカル ファイルへのアクセス許可がない場合にエラーが発生します。