Export (0) Print
Expand All

WebClient.DownloadFile Method (Uri, String)

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

Namespace:  System.Net
Assembly:  System (in System.dll)

member DownloadFile : 
        address:Uri * 
        fileName:string -> unit 

Parameters

address
Type: System.Uri
The URI specified as a String, from which to download data.
fileName
Type: System.String
The name of the local file that is to receive the data.

ExceptionCondition
ArgumentNullException

The address parameter is a null reference (Nothing in Visual Basic).

-or-

The fileName parameter is a null reference (Nothing in Visual Basic).

WebException

The URI formed by combining BaseAddress and address is invalid.

-or-

filename is a null reference (Nothing in Visual Basic) or Empty.

-or-

The file does not exist.

-or-

An error occurred while downloading data.

NotSupportedException

The method has been called simultaneously on multiple threads.

The DownloadFile 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 DownloadFileAsync methods.

If the 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 BaseAddress to form the absolute URI of the requested data. If the 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.

NoteNote

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.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Community Additions

ADD
Show:
© 2014 Microsoft