WebClient.DownloadFileAsync メソッド

定義

名前空間:

System.Net

アセンブリ:

System.Net.WebClient.dll

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

オーバーロード

DownloadFileAsync(Uri, String)	指定した URI を持つリソースをローカル ファイルにダウンロードします。 このメソッドは、呼び出し元のスレッドをブロックしません。
DownloadFileAsync(Uri, String, Object)	指定した URI を持つリソースをローカル ファイルにダウンロードします。 このメソッドは、呼び出し元のスレッドをブロックしません。

DownloadFileAsync(Uri, String)

ソース:

WebClient.cs

指定した URI を持つリソースをローカル ファイルにダウンロードします。 このメソッドは、呼び出し元のスレッドをブロックしません。

public:
 void DownloadFileAsync(Uri ^ address, System::String ^ fileName);

public void DownloadFileAsync (Uri address, string fileName);

member this.DownloadFileAsync : Uri * string -> unit

Public Sub DownloadFileAsync (address As Uri, fileName As String)

パラメーター

address

Uri

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

fileName

String

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

例外

ArgumentNullException

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

または

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

WebException

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

- または -

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

InvalidOperationException

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

注釈

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

このメソッドは、リソースのダウンロード中に呼び出し元のスレッドをブロックしません。 ダウンロードの完了を待っている間にブロックするには、いずれかの方法を DownloadFile 使用します。

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

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

DownloadFileAsync(Uri, String, Object)

ソース:

WebClient.cs

指定した URI を持つリソースをローカル ファイルにダウンロードします。 このメソッドは、呼び出し元のスレッドをブロックしません。

public:
 void DownloadFileAsync(Uri ^ address, System::String ^ fileName, System::Object ^ userToken);

public void DownloadFileAsync (Uri address, string fileName, object? userToken);

member this.DownloadFileAsync : Uri * string * obj -> unit

Public Sub DownloadFileAsync (address As Uri, fileName As String, userToken As Object)

パラメーター

address

Uri

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

fileName

String

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

userToken

Object

非同期操作の完了時に呼び出されるメソッドに渡されるユーザー定義のオブジェクト。

例外

ArgumentNullException

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

または

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

WebException

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

- または -

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

InvalidOperationException

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

注釈

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

このメソッドは、リソースのダウンロード中に呼び出し元のスレッドをブロックしません。 ダウンロードの完了を待っている間にブロックするには、いずれかの方法を DownloadFile 使用します。

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