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 によって指定されたローカル ファイルは、別のスレッドで使用されています。

注釈

注意

WebRequest、HttpWebRequest、ServicePoint、WebClient は廃止されており、新しい開発には使用しないでください。 代わりに HttpClient を使用してください。

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

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

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

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

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

手記

このメンバーは、アプリケーションでネットワーク トレースを有効にすると、トレース情報を出力します。 詳細については、「.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 によって指定されたローカル ファイルは、別のスレッドで使用されています。

注釈

注意

WebRequest、HttpWebRequest、ServicePoint、WebClient は廃止されており、新しい開発には使用しないでください。 代わりに HttpClient を使用してください。

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

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

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

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

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

手記

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

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