This topic has not yet been rated - Rate this topic

HttpWebResponse::StatusDescription Property

Gets the status description returned with the response.

Namespace:  System.Net
Assembly:  System (in System.dll)
public:
virtual property String^ StatusDescription {
	String^ get ();
}

Property Value

Type: System::String
A string that describes the status of the response.
ExceptionCondition
ObjectDisposedException

The current instance has been disposed.

A common status message is OK.

The following example uses StatusDescription to verify that the status of the HttpWebResponse is OK.

void GetPage( String^ url )
{
   try
   {
      // Creates an HttpWebRequest for the specified URL.
      HttpWebRequest^ myHttpWebRequest = dynamic_cast<HttpWebRequest^>(WebRequest::Create( url ));
      // Sends the HttpWebRequest and waits for a response.
      HttpWebResponse^ myHttpWebResponse = dynamic_cast<HttpWebResponse^>(myHttpWebRequest->GetResponse());
      if ( myHttpWebResponse->StatusCode == HttpStatusCode::OK )
      {
         Console::WriteLine( "\r\nResponse Status Code is OK and StatusDescription is: {0}",
            myHttpWebResponse->StatusDescription );
      }
      // Releases the resources of the response.
      myHttpWebResponse->Close();
   }
   catch ( WebException^ e ) 
   {
      Console::WriteLine( "\r\nWebException Raised. The following error occured : {0}", e->Status );
   }
   catch ( Exception^ e ) 
   {
      Console::WriteLine( "\nThe following Exception was raised : {0}", e->Message );
   }
}

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Did you find this helpful?
(1500 characters remaining)
© 2013 Microsoft. All rights reserved.