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

注釈

注意

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

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

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

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

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

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

手記

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

注釈

注意

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

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

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

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

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

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

手記

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

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