Export (0) Print
Expand All
0 out of 2 rated this helpful - Rate this topic

WebClient.OpenRead Method (String)

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

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

public Stream OpenRead (
	string address
)
public Stream OpenRead (
	String address
)
public function OpenRead (
	address : String
) : Stream

Parameters

address

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

Return Value

A Stream used to read data from a resource.
Exception typeCondition

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 a null reference (Nothing in Visual Basic), 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.

NoteNote

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

The following code example opens the resource identified by uriString and displays the results on the system console. Note that the Stream returned by OpenRead is closed when the data has been read.

// Create a new WebClient instance.
WebClient myWebClient = new WebClient();
// Download home page data. 
Console.WriteLine("Accessing {0} ...",  uriString);                        
// Open a stream to point to the data stream coming from the Web resource.
Stream myStream = myWebClient.OpenRead(uriString);

Console.WriteLine("\nDisplaying Data :\n");
StreamReader sr = new StreamReader(myStream);
Console.WriteLine(sr.ReadToEnd());


// Close the stream. 
myStream.Close();

// Create a new WebClient instance.
WebClient myWebClient = new WebClient();
// Download home page data. 
Console.WriteLine("Accessing {0} ...", uriString);
// Open a stream to point to the data stream coming from
// the Web resource.
Stream myStream = myWebClient.OpenRead(uriString);

Console.WriteLine("\nDisplaying Data :\n");
StreamReader sr = new StreamReader(myStream);
Console.WriteLine(sr.ReadToEnd());
// Close the stream. 
myStream.Close();

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0, 1.1, 1.0
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.