WebClient.OpenReadAsync Method (Uri, Object)

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

Opens a readable stream to the specified resource.

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

Syntax

Public Sub OpenReadAsync ( _
    address As Uri, _
    userToken As Object _
)
public void OpenReadAsync(
    Uri address,
    Object userToken
)

Parameters

  • address
    Type: System..::.Uri
    The location of the resource to be downloaded.
  • userToken
    Type: System..::.Object
    Provides a user-specified identifier for the asynchronous task.

Exceptions

Exception Condition
ArgumentNullException

The address parameter is nullNothingnullptra null reference (Nothing in Visual Basic).

OutOfMemoryException

There is not enough memory to continue the execution of the program.

StackOverflowException

The execution stack overflowed because it contains too many nested method calls.

ThreadAbortException

A call was made to the Thread..::.Abort method to destroy a thread.

Remarks

This method retrieves the specified resource using the GET method. The resource is downloaded asynchronously. If the AllowReadStreamBuffering property is true, then the OpenReadCompleted event is raised once the entire response stream has been received and buffered into memory. Otherwise, the OpenReadCompleted event is raised as soon as the response stream is available for reading even if all data has not yet arrived.

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

You cannot call the OpenReadAsync method again on the same WebClient object, until the first download operation is completed. Doing this causes an exception.

If the BaseAddress property is not an empty string and the address does not contain an absolute URI, the address must be a relative URI that is combined with BaseAddress to form the absolute URI of the requested data.

Retrieve the userToken as the UserState property of the AsyncCompletedEventArgs passed to the method invoked when the asynchronous operation is completed.

Version Information

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Platforms

Windows Phone

See Also

Reference

WebClient Class

OpenReadAsync Overload

System.Net Namespace