HttpWebResponse::StatusDescription Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets the status description returned with the response.

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

public:
property String^ StatusDescription {
	virtual String^ get();
}

Property Value

Type: System::String^

A string that describes the status of the response.

Exception Condition
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 );
   }
}

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