System.Net.WebClient.DownloadFileAsync Method

Downloads, to a local file, the resource with the specified URI. This method does not block the calling thread.

Syntax

public void DownloadFileAsync (Uri address, string fileName)

Parameters

address
The URI of the resource to download.
fileName
The name of the file to be placed on the local computer.

Remarks

This method downloads the resource at the URI specified by in the address parameter. 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. To receive notification when the file is available, add an event handler to the WebClient.DownloadFileCompleted event.

This method does not block the calling thread while the resource is being downloaded. To block while waiting for the download to complete, use one of the erload:System.Net.WebClient.DownloadFile methods.

You can use the WebClient.CancelAsync method to cancel asynchronous operations that have not completed.

If the WebClient.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 WebClient.BaseAddress to form the absolute URI of the requested data. If the WebClient.QueryString property is not an empty string, it is appended to address.

This method uses the RETR command to download an FTP resource. For an HTTP resource, the GET method is used.

Note:

This member outputs trace information when you enable network tracing in your application. For more information, see Network Tracing.

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.

Requirements

Namespace: System.Net
Assembly: System (in System.dll)
Assembly Versions: 2.0.0.0, 4.0.0.0