GetResponseStream Method
Collapse the table of content
Expand the table of content

HttpWebResponse::GetResponseStream Method ()

 

Gets the stream that is used to read the body of the response from the server.

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

public:
virtual Stream^ GetResponseStream() override

Return Value

Type: System.IO::Stream^

A Stream containing the body of the response.

Exception Condition
ProtocolViolationException

There is no response stream.

ObjectDisposedException

The current instance has been disposed.

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

System_CAPS_noteNote

You must call either the Stream::Close or the HttpWebResponse::Close method to close the stream and release the connection for reuse. It is not necessary to call both Stream::Close and HttpWebResponse::Close, but doing so does not cause an error. Failure to close the stream will cause your application to run out of connections.

System_CAPS_noteNote

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

The following example demonstrates how to use GetResponseStream to return the Stream instance used to read the response from the server.

// Creates an HttpWebRequest with the specified URL.
HttpWebRequest^ myHttpWebRequest = (HttpWebRequest^)( WebRequest::Create( url ) );
// Sends the HttpWebRequest and waits for the response.
HttpWebResponse^ myHttpWebResponse = (HttpWebResponse^)( myHttpWebRequest->GetResponse() );
// Gets the stream associated with the response.
Stream^ receiveStream = myHttpWebResponse->GetResponseStream();
Encoding^ encode = System::Text::Encoding::GetEncoding( "utf-8" );
// Pipes the stream to a higher level stream reader with the required encoding format.
StreamReader^ readStream = gcnew StreamReader( receiveStream,encode );
Console::WriteLine( "\r\nResponse stream received." );
array<Char>^ read = gcnew array<Char>(256);
// Reads 256 characters at a time.
int count = readStream->Read( read, 0, 256 );
Console::WriteLine( "HTML...\r\n" );
while ( count > 0 )
{
   // Dumps the 256 characters on a String* and displays the String* to the console.
   String^ str = gcnew String( read,0,count );
   Console::Write( str );
   count = readStream->Read( read, 0, 256 );
}
Console::WriteLine( "" );
// Releases the resources of the response.
myHttpWebResponse->Close();
// Releases the resources of the Stream.
readStream->Close();

Universal Windows Platform
Available since 8
.NET Framework
Available since 1.1
Portable Class Library
Supported in: portable .NET platforms
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top
Show:
© 2016 Microsoft