System.Net.WebClient.DownloadFile Method

Downloads the resource with the specified URI to a local file.

Syntax

public void DownloadFile (string address, string fileName)

Parameters

address
The URI from which to download data.
fileName
The name of the local file that is to receive the data.

Exceptions

TypeReason
System.Net.WebException

The absolute URI is not valid.

-or-

filename is null or string.Empty or contains invalid characters, or the specified path to the file does not exist.

-or-

An error occurred while downloading data.

System.Security.SecurityExceptionThe caller does not have permission to write to local files.

Remarks

The WebClient.DownloadFile(string, string) method downloads to a local file data from the URI specified by in the address parameter. This method blocks while downloading the resource. To download a resource and continue executing while waiting for the server's response, use one of the erload:System.Net.WebClient.DownloadFileAsync methods.

If the WebClient.BaseAddress property is not an empty string ("") and address does not contain 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 a middle tier application, such as an ASP.NET page, you will receive an error if the account under which the application executes does not have permission to access the file.

Permissions

Requirements

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