This documentation is archived and is not being maintained.

HttpWebResponse.StatusDescription Property

Gets the status description returned with the response.

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

'Declaration
Public ReadOnly Property StatusDescription As String
'Usage
Dim instance As HttpWebResponse 
Dim value As String 

value = instance.StatusDescription

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.

Public Shared Sub GetPage(url As [String])
   Try 
        ' Creates an HttpWebRequest with the specified URL. 
        Dim myHttpWebRequest As HttpWebRequest = CType(WebRequest.Create(url), HttpWebRequest)
        ' Sends the request and waits for a response. 
        Dim myHttpWebResponse As HttpWebResponse = CType(myHttpWebRequest.GetResponse(), HttpWebResponse)
        If myHttpWebResponse.StatusCode = HttpStatusCode.OK Then
            Console.WriteLine(ControlChars.Lf + ControlChars.NewLine + "Response Status Code is OK and StatusDescription is: {0}", myHttpWebResponse.StatusDescription)
        End If 
        ' Release the resources of the response.
        myHttpWebResponse.Close()

    Catch e As WebException
        Console.WriteLine(ControlChars.Lf + ControlChars.NewLine + "Exception Raised. The following error occured : {0}", e.Status)
    Catch e As Exception
        Console.WriteLine(ControlChars.NewLine + "The following exception was raised : {0}", e.Message)
    End Try 
End Sub
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(S"\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(S"\r\nWebException Raised. The following error occured : {0}",
         __box(e->Status));
   } catch (Exception* e) {
      Console::WriteLine(S"\nThe following Exception was raised : {0}",
         e->Message);
   }
}

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC

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

.NET Framework

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

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0
Show: