WebClient.DownloadFileAsync メソッド

定義

非同期操作として指定されたリソースをローカル ファイルにダウンロードします。Downloads the specified resource to a local file as an asynchronous operation. これらのメソッドは、呼び出し元のスレッドをブロックしません。These methods do not block the calling thread.

オーバーロード

DownloadFileAsync(Uri, String)

指定した URI を持つリソースをローカル ファイルにダウンロードします。Downloads, to a local file, the resource with the specified URI. このメソッドは、呼び出し元のスレッドをブロックしません。This method does not block the calling thread.

DownloadFileAsync(Uri, String, Object)

指定した URI を持つリソースをローカル ファイルにダウンロードします。Downloads, to a local file, the resource with the specified URI. このメソッドは、呼び出し元のスレッドをブロックしません。This method does not block the calling thread.

DownloadFileAsync(Uri, String)

指定した URI を持つリソースをローカル ファイルにダウンロードします。Downloads, to a local file, the resource with the specified URI. このメソッドは、呼び出し元のスレッドをブロックしません。This method does not block the calling thread.

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。The URI of the resource to download.

fileName
String

ローカル コンピューターに配置されるファイルの名前。The name of the file to be placed on the local computer.

例外

address パラメーターが null です。The address parameter is null.

- または --or-

fileName パラメーターが null です。The fileName parameter is null.

BaseAddress および address を組み合わせて形成された URI が無効です。The URI formed by combining BaseAddress and address is invalid.

- または --or-

リソースのダウンロード中にエラーが発生しました。An error occurred while downloading the resource.

fileName によって指定されたローカルファイルは別のスレッドで使用されています。The local file specified by fileName is in use by another thread.

注釈

このメソッドは、パラメーターので指定された URI にリソースをダウンロードし address ます。This method downloads the resource at the URI specified by in the address parameter. ダウンロードが正常に完了すると、ダウンロードしたファイルの名前は fileName ローカルコンピューターになります。When the download completes successfully, the downloaded file is named fileName on the local computer. このファイルは、スレッドプールから自動的に割り当てられたスレッドリソースを使用して非同期的にダウンロードされます。The file is downloaded asynchronously using thread resources that are automatically allocated from the thread pool. ファイルが使用可能になったときに通知を受け取るには、イベントにイベントハンドラーを追加し DownloadFileCompleted ます。To receive notification when the file is available, add an event handler to the DownloadFileCompleted event.

このメソッドは、リソースのダウンロード中に、呼び出し元のスレッドをブロックしません。This method does not block the calling thread while the resource is being downloaded. ダウンロードの完了を待機している間にブロックするには、いずれかのメソッドを使用し DownloadFile ます。To block while waiting for the download to complete, use one of the DownloadFile methods.

.NET Framework と .NET Core 1.0 では、メソッドを呼び出して、完了していない非同期操作を取り消すことができ CancelAsync ます。In .NET Framework and .NET Core 1.0, you can cancel asynchronous operations that have not completed by calling the CancelAsync method.

BaseAddressプロパティが空の文字列 ("") ではなく、絶対 uri も指定されていない場合 address 、は、 address 要求された BaseAddress データの絶対 uri を形成するためにと組み合わせられる相対 uri である必要があります。If the BaseAddress property is not an empty string ("") and address does not specify an absolute URI, address must be a relative URI that is combined with BaseAddress to form the absolute URI of the requested data. QueryStringプロパティが空の文字列でない場合は、に追加され address ます。If the QueryString property is not an empty string, it is appended to address.

このメソッドは、RETR コマンドを使用して FTP リソースをダウンロードします。This method uses the RETR command to download an FTP resource. HTTP リソースの場合は、GET メソッドが使用されます。For an HTTP resource, the GET method is used.

注意

このメンバーは、アプリケーションでネットワーク トレースが有効にされている場合にトレース情報を出力します。This member outputs trace information when you enable network tracing in your application. 詳細については、「 .NET Framework のネットワークトレース」を参照してください。For more information, see Network Tracing in .NET Framework.

ASP.NET ページでこのメソッドを使用すると、ページが実行されるアカウントにローカルファイルへのアクセス許可がない場合に、エラーが表示されます。When using this method in an ASP.NET page, you will receive an error if the account that the page executes under does not have permission to access the local file.

適用対象

DownloadFileAsync(Uri, String, Object)

指定した URI を持つリソースをローカル ファイルにダウンロードします。Downloads, to a local file, the resource with the specified URI. このメソッドは、呼び出し元のスレッドをブロックしません。This method does not block the calling thread.

public:
 void DownloadFileAsync(Uri ^ address, System::String ^ fileName, System::Object ^ userToken);
public void DownloadFileAsync (Uri address, string fileName, 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。The URI of the resource to download.

fileName
String

ローカル コンピューターに配置されるファイルの名前。The name of the file to be placed on the local computer.

userToken
Object

非同期操作の完了時に呼び出されるメソッドに渡されるユーザー定義のオブジェクト。A user-defined object that is passed to the method invoked when the asynchronous operation completes.

例外

address パラメーターが null です。The address parameter is null.

- または --or-

fileName パラメーターが null です。The fileName parameter is null.

BaseAddress および address を組み合わせて形成された URI が無効です。The URI formed by combining BaseAddress and address is invalid.

- または --or-

リソースのダウンロード中にエラーが発生しました。An error occurred while downloading the resource.

fileName によって指定されたローカルファイルは別のスレッドで使用されています。The local file specified by fileName is in use by another thread.

注釈

このメソッドは、パラメーターので指定された URI にリソースをダウンロードし address ます。This method downloads the resource at the URI specified by in the address parameter. ダウンロードが正常に完了すると、ダウンロードしたファイルの名前は fileName ローカルコンピューターになります。When the download completes successfully, the downloaded file is named fileName on the local computer. このファイルは、スレッドプールから自動的に割り当てられたスレッドリソースを使用して非同期的にダウンロードされます。The file is downloaded asynchronously using thread resources that are automatically allocated from the thread pool. ファイルが使用可能になったときに通知を受け取るには、イベントにイベントハンドラーを追加し DownloadFileCompleted ます。To receive notification when the file is available, add an event handler to the DownloadFileCompleted event.

このメソッドは、リソースのダウンロード中に、呼び出し元のスレッドをブロックしません。This method does not block the calling thread while the resource is being downloaded. ダウンロードの完了を待機している間にブロックするには、いずれかのメソッドを使用し DownloadFile ます。To block while waiting for the download to complete, use one of the DownloadFile methods.

.NET Framework と .NET Core 1.0 では、メソッドを呼び出して、完了していない非同期操作を取り消すことができ CancelAsync ます。In .NET Framework and .NET Core 1.0, you can cancel asynchronous operations that have not completed by calling the CancelAsync method.

BaseAddressプロパティが空の文字列 ("") ではなく、絶対 uri も指定されていない場合 address 、は、 address 要求された BaseAddress データの絶対 uri を形成するためにと組み合わせられる相対 uri である必要があります。If the BaseAddress property is not an empty string ("") and address does not specify an absolute URI, address must be a relative URI that is combined with BaseAddress to form the absolute URI of the requested data. QueryStringプロパティが空の文字列でない場合は、に追加され address ます。If the QueryString property is not an empty string, it is appended to address.

このメソッドは、RETR コマンドを使用して FTP リソースをダウンロードします。This method uses the RETR command to download an FTP resource. HTTP リソースの場合は、GET メソッドが使用されます。For an HTTP resource, the GET method is used.

注意

このメンバーは、アプリケーションでネットワーク トレースが有効にされている場合にトレース情報を出力します。This member outputs trace information when you enable network tracing in your application. 詳細については、「 .NET Framework のネットワークトレース」を参照してください。For more information, see Network Tracing in .NET Framework.

ASP.NET ページでこのメソッドを使用すると、ページが実行されるアカウントにローカルファイルへのアクセス許可がない場合に、エラーが表示されます。When using this method in an ASP.NET page, you will receive an error if the account that the page executes under does not have permission to access the local file.

適用対象