WebClient.DownloadDataAsync WebClient.DownloadDataAsync WebClient.DownloadDataAsync WebClient.DownloadDataAsync Method

Definition

Downloads the resource as a Byte array from the URI specified as an asynchronous operation. These methods do not block the calling thread.

Overloads

DownloadDataAsync(Uri) DownloadDataAsync(Uri) DownloadDataAsync(Uri) DownloadDataAsync(Uri)

Downloads the resource as a Byte array from the URI specified as an asynchronous operation.

DownloadDataAsync(Uri, Object) DownloadDataAsync(Uri, Object) DownloadDataAsync(Uri, Object) DownloadDataAsync(Uri, Object)

Downloads the resource as a Byte array from the URI specified as an asynchronous operation.

DownloadDataAsync(Uri) DownloadDataAsync(Uri) DownloadDataAsync(Uri) DownloadDataAsync(Uri)

Downloads the resource as a Byte array from the URI specified as an asynchronous operation.

public:
 void DownloadDataAsync(Uri ^ address);
[System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]
public void DownloadDataAsync (Uri address);
member this.DownloadDataAsync : Uri -> unit
Public Sub DownloadDataAsync (address As Uri)
Parameters
address
Uri Uri Uri Uri

A Uri containing the URI to download.

Exceptions

The URI formed by combining BaseAddress and address is invalid.

-or-

An error occurred while downloading the resource.

Remarks

This method retrieves the specified resource using the default method for the protocol associated with the URI scheme specified in address. The data is downloaded asynchronously using thread resources that are automatically allocated from the thread pool.

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 one of the DownloadData methods. When the download completes, the DownloadDataCompleted event is raised. Your application must handle this event to receive notification. The downloaded data is available in the Result property.

You can use the CancelAsync method to cancel asynchronous operations that have not completed.

This method uses the RETR command to download an FTP resource. For an HTTP resource, the GET method is used.

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.

Note

This member outputs trace information when you enable network tracing in your application. For more information, see Network Tracing in the .NET Framework.

DownloadDataAsync(Uri, Object) DownloadDataAsync(Uri, Object) DownloadDataAsync(Uri, Object) DownloadDataAsync(Uri, Object)

Downloads the resource as a Byte array from the URI specified as an asynchronous operation.

public:
 void DownloadDataAsync(Uri ^ address, System::Object ^ userToken);
public void DownloadDataAsync (Uri address, object userToken);
member this.DownloadDataAsync : Uri * obj -> unit
Public Sub DownloadDataAsync (address As Uri, userToken As Object)
Parameters
address
Uri Uri Uri Uri

A Uri containing the URI to download.

userToken
Object Object Object Object

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

Exceptions

The URI formed by combining BaseAddress and address is invalid.

-or-

An error occurred while downloading the resource.

Remarks

This method retrieves the specified resource using the default method for the protocol associated with the URI scheme specified in address. The data is downloaded asynchronously using thread resources that are automatically allocated from the thread pool.

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 one of the DownloadData methods. When the download completes, the DownloadDataCompleted event is raised. Your application must handle this event to receive notification. The downloaded data is available in the Result property.

You can use the CancelAsync method to cancel asynchronous operations that have not completed.

This method uses the RETR command to download an FTP resource. For an HTTP resource, the GET method is used.

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.

Note

This member outputs trace information when you enable network tracing in your application. For more information, see Network Tracing in the .NET Framework.

Applies to