Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

WebClient.DownloadStringAsync Method (Uri, Object)

Note: This method is new in the .NET Framework version 2.0.

Downloads the specified string to the specified resource. This method does not block the calling thread.

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

public void DownloadStringAsync (
	Uri address,
	Object userToken
)
public void DownloadStringAsync (
	Uri address, 
	Object userToken
)
public function DownloadStringAsync (
	address : Uri, 
	userToken : Object
)

Parameters

address

A Uri containing the URI to download.

userToken

A user-defined object that is passed to the method invoked when the asynchronous operation completes.

Exception typeCondition

WebException

The URI formed by combining BaseAddress and address is invalid.

-or-

An error occurred while downloading the resource.

This method retrieves the specified resource using the GET method. The resource is downloaded asynchronously using thread resources that are automatically allocated from the thread pool.

After downloading the resource, this method uses the encoding specified in the Encoding property to convert the resource to a String. This method does not block the calling thread while downloading the resource. To download a resource and block while waiting for the server's response, use the DownloadString method. When the download completes, the DownloadStringCompleted event is raised. Your application must handle this event to receive notification. The downloaded string is available in the Result property.

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 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.

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
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.