Export (0) Print
Expand All

WebClient::DownloadDataTaskAsync Method (Uri)

.NET Framework 4.5

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

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

[ComVisibleAttribute(false)]
[HostProtectionAttribute(SecurityAction::LinkDemand, ExternalThreading = true)]
public:
Task<array<unsigned char>^>^ DownloadDataTaskAsync(
	Uri^ address
)

Parameters

address
Type: System::Uri

The URI of the resource to download.

Return Value

Type: System.Threading.Tasks::Task<array<Byte>>
Returns Task<TResult>.
The task object representing the asynchronous operation. The Result property on the task object returns a Byte array containing the downloaded resource.

ExceptionCondition
ArgumentNullException

The address parameter is nullptr.

WebException

The URI formed by combining BaseAddress and address is invalid.

-or-

An error occurred while downloading the resource.

This operation will not block. The returned Task<TResult> object will complete after the data resource has been downloaded.

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

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.

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

NoteNote

The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: ExternalThreading. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Show:
© 2014 Microsoft