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

WebResponse.GetResponseStream Method

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

[Visual Basic]
Public Overridable Function GetResponseStream() As Stream
[C#]
public virtual Stream GetResponseStream();
[C++]
public: virtual Stream* GetResponseStream();
[JScript]
public function GetResponseStream() : Stream;

Return Value

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

Exceptions

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

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

Example

[Visual Basic, C#, C++] 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.

[Visual Basic] 

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

' Send the 'WebRequest' and wait for response.
Dim 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("")

' Release the resources of stream object.
 readStream.Close()

 ' Release the resources of response object.
myWebResponse.Close()


[C#] 

        // Create a 'WebRequest' object with the specified url. 
     WebRequest myWebRequest = WebRequest.Create("http://www.constoso.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 = 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("");
     // Release the resources of stream object.
     readStream.Close();

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


[C++] 
// Create a 'WebRequest' object with the specified url.
WebRequest* myWebRequest = WebRequest::Create(S"http://www.constoso.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(S"utf-8");

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

// Read 256 charcters at a time.
int count = readStream->Read(read, 0, 256);
Console::WriteLine(S"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(S"");
// Release the resources of stream object.
readStream->Close();

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

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, .NET Compact Framework, Common Language Infrastructure (CLI) Standard

See Also

WebResponse Class | WebResponse Members | System.Net Namespace | Using Streams on the Network

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.