WebClient.DownloadFileAsync Method (Uri, String, Object)
Assembly: System (in system.dll)
public function DownloadFileAsync ( address : Uri, fileName : String, userToken : Object )
The URI of the resource to download.
The name of the file to be placed on the local computer.
A user-defined object that is passed to the method invoked when the asynchronous operation completes.
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 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 DownloadFile methods.
You can use the CancelAsync method to cancel asynchronous operations that have not completed.
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. 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.
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.
Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter EditionThe Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.