Export (0) Print
Expand All

WebClient.OpenRead Method (Uri)

Opens a readable stream for the data downloaded from a resource with the URI specified as a Uri

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

public Stream OpenRead(
	Uri address
)

Parameters

address
Type: System.Uri

The URI specified as a Uri from which to download data.

Return Value

Type: System.IO.Stream
A Stream used to read data from a resource.

ExceptionCondition
ArgumentNullException

The address parameter is null.

WebException

The URI formed by combining BaseAddress, address is invalid.

-or-

An error occurred while downloading data.

The OpenRead method creates a Stream instance used to read the contents of the resource specified by the address parameter. This method blocks while opening the stream. To continue executing while waiting for the stream, use one of the OpenReadAsync methods.

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

NoteNote

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

Note   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

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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