System.Net.WebClient.OpenRead Method

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

Syntax

public System.IO.Stream OpenRead (string address)

Parameters

address
The URI specified as a string from which to download data.

Returns

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

Exceptions

TypeReason
System.Net.WebException

The absolute URI is not valid.

-or-

An error occurred while downloading data.

Remarks

The WebClient.OpenRead(string) method creates a System.IO.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 erload:System.Net.WebClient.OpenReadAsync methods.

If the WebClient.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 WebClient.BaseAddress to form the absolute URI of the requested data. If the WebClient.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.

Note:

You must call System.IO.Stream.Close when finished with the System.IO.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.

Requirements

Namespace: System.Net
Assembly: System (in System.dll)
Assembly Versions: 1.0.5000.0, 2.0.0.0, 4.0.0.0