Export (0) Print
Expand All

WebClient.DownloadFile Method (String, String)

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

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

public void DownloadFile (
	string address,
	string fileName
)
public void DownloadFile (
	String address, 
	String fileName
)
public function DownloadFile (
	address : String, 
	fileName : String
)

Parameters

address

The URI from which to download data.

fileName

The name of the local file that is to receive the data.

Exception typeCondition

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.

The following code example downloads a file from http://www.contoso.com to the local hard drive.

string remoteUri = "http://www.contoso.com/library/homepage/images/";
string fileName = "ms-banner.gif", myStringWebResource = null;
// Create a new WebClient instance.
WebClient myWebClient = new WebClient();
// Concatenate the domain with the Web resource filename.
myStringWebResource = remoteUri + fileName;
Console.WriteLine("Downloading File \"{0}\" from \"{1}\" .......\n\n", fileName, myStringWebResource);
// Download the Web resource and save it into the current filesystem folder.
myWebClient.DownloadFile(myStringWebResource,fileName);        
Console.WriteLine("Successfully Downloaded File \"{0}\" from \"{1}\"", fileName, myStringWebResource);
Console.WriteLine("\nDownloaded file saved in the following file system folder:\n\t" + Application.StartupPath);

String remoteUri = "http://www.contoso.com/library/homepage/images/";
String fileName = "ms-banner.gif";
String myStringWebResource = null;
// Create a new WebClient instance.
WebClient myWebClient = new WebClient();
// Concatenate the domain with the Web resource filename.
myStringWebResource = remoteUri + fileName;
Console.WriteLine("Downloading File \"{0}\" from \"{1}\" .......\n\n",
    fileName, myStringWebResource);
// Download the Web resource and save it into the current
// filesystem folder.
myWebClient.DownloadFile(myStringWebResource, fileName);
Console.WriteLine("Successfully Downloaded File \"{0}\" from \"{1}\"",
    fileName, myStringWebResource);
Console.WriteLine("\nDownloaded file saved in the following file" 
    + " system folder:\n\t" + Application.get_StartupPath());

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0, 1.1, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft