WebClient.OpenReadAsync Method (Uri)

 

Opens a readable stream containing the specified resource. This method does not block the calling thread.

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

[HostProtectionAttribute(SecurityAction.LinkDemand, ExternalThreading = true)]
public void OpenReadAsync(
	Uri address
)

Parameters

address
Type: System.Uri

The URI of the resource to retrieve.

Exception Condition
ArgumentNullException

The address parameter is null.

WebException

The URI formed by combining BaseAddress and address is invalid.

-or-

An error occurred while downloading the resource.

-or-

An error occurred while opening the stream.

This method retrieves a Stream instance used to access the resource specified by the address parameter. The stream is obtained using thread resources that are automatically allocated from the thread pool. To receive notification when the stream is available, add an event handler to the OpenReadCompleted event.

System_CAPS_noteNote

You must call Stream.Close when you are finished with the Stream to avoid running out of system resources.

This method does not block the calling thread while the stream is opening. To block while waiting for the stream, use the OpenReadAsync method.

Asynchronous operations that have not completed can be canceled using the CancelAsync method.

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 resource. If the QueryString property is not null, 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.

System_CAPS_noteNote

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

.NET Framework
Available since 2.0
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Return to top
Show: