WebResponse.GetResponseStream Method

Definition

Namespace:

System.Net

Assembly:

System.Net.Requests.dll

Source:

WebResponse.cs

When overridden in a descendant class, returns the data stream from the Internet resource.

public:
 virtual System::IO::Stream ^ GetResponseStream();

public virtual System.IO.Stream GetResponseStream ();

abstract member GetResponseStream : unit -> System.IO.Stream
override this.GetResponseStream : unit -> System.IO.Stream

Public Overridable Function GetResponseStream () As Stream

Returns

Stream

An instance of the Stream class for reading data from the Internet resource.

Exceptions

NotSupportedException

Any attempt is made to access the method, when the method is not overridden in a descendant class.

Examples

The following example uses GetResponseStream to return a StreamReader instance. A small local buffer is used to read data from the StreamReader and output it to the console.

// Create a 'WebRequest' object with the specified url.
WebRequest^ myWebRequest = WebRequest::Create( "http://www.contoso.com" );

// Send the 'WebRequest' and wait for response.
WebResponse^ myWebResponse = myWebRequest->GetResponse();

// Obtain a 'Stream' object associated with the response object.
Stream^ ReceiveStream = myWebResponse->GetResponseStream();

Encoding^ encode = System::Text::Encoding::GetEncoding( "utf-8" );

// Pipe the stream to a higher level stream reader with the required encoding format.
StreamReader^ readStream = gcnew StreamReader( ReceiveStream,encode );
Console::WriteLine( "\nResponse stream received" );
array<Char>^ read = gcnew array<Char>(256);

// Read 256 charcters at a time.
int count = readStream->Read( read, 0, 256 );
Console::WriteLine( "HTML...\r\n" );

while ( count > 0 )
{
   // Dump the 256 characters on a string and display the string onto the console.
   String^ str = gcnew String( read,0,count );
   Console::Write( str );
   count = readStream->Read( read, 0, 256 );
}

Console::WriteLine( "" );
// Release the resources of stream object.
readStream->Close();

// Release the resources of response object.
myWebResponse->Close();

// Create a 'WebRequest' object with the specified url. 
WebRequest myWebRequest = WebRequest.Create("http://www.contoso.com");

// Send the 'WebRequest' and wait for response.
using WebResponse myWebResponse = myWebRequest.GetResponse();

// Obtain a 'Stream' object associated with the response object.
Stream ReceiveStream = myWebResponse.GetResponseStream();

Encoding encode = System.Text.Encoding.GetEncoding("utf-8");

// Pipe the stream to a higher level stream reader with the required encoding format. 
StreamReader readStream = new StreamReader(ReceiveStream, encode);
Console.WriteLine("\nResponse stream received");
Char[] read = new Char[256];

// Read 256 charcters at a time.    
int count = readStream.Read(read, 0, 256);
Console.WriteLine("HTML...\r\n");

while (count > 0)
{
    // Dump the 256 characters on a string and display the string onto the console.
    String str = new String(read, 0, count);
    Console.Write(str);
    count = readStream.Read(read, 0, 256);
}
Console.WriteLine();

' Create a 'WebRequest' object with the specified url 
Dim myWebRequest As WebRequest = WebRequest.Create("www.contoso.com")

' Send the 'WebRequest' and wait for response.
Using myWebResponse As WebResponse = myWebRequest.GetResponse()

    ' Call method 'GetResponseStream' to obtain stream associated with the response object
    Dim ReceiveStream As Stream = myWebResponse.GetResponseStream()
    
    Dim encode As Encoding = System.Text.Encoding.GetEncoding("utf-8")

    ' Pipe the stream to a higher level stream reader with the required encoding format.
    Dim readStream As New StreamReader(ReceiveStream, encode)
    Console.WriteLine(ControlChars.Cr + "Response stream received")
    Dim read(256) As [Char]

    ' Read 256 charcters at a time    .
    Dim count As Integer = readStream.Read(read, 0, 256)
    Console.WriteLine("HTML..." + ControlChars.Lf + ControlChars.Cr)
    While count > 0

        ' Dump the 256 characters on a string and display the string onto the console.
        Dim str As New [String](read, 0, count)
        Console.Write(str)
        count = readStream.Read(read, 0, 256)

    End While
    Console.WriteLine("")
End Using

Remarks

The GetResponseStream method returns the data stream from the Internet resource.

Note

The response stream must be closed to avoid running out of system resources. The response stream can be closed by calling Stream.Close or Close

See also

• Using Streams on the Network