HttpWebResponse.StatusDescription Property

Definition

Gets the status description returned with the response.

public:
 virtual property System::String ^ StatusDescription { System::String ^ get(); };
public:
 property System::String ^ StatusDescription { System::String ^ get(); };
public virtual string StatusDescription { get; }
public string StatusDescription { get; }
member this.StatusDescription : string
Public Overridable ReadOnly Property StatusDescription As String
Public ReadOnly Property StatusDescription As String

Property Value

String

A string that describes the status of the response.

Exceptions

The current instance has been disposed.

Examples

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 occurred : {0}", e->Status );
   }
   catch ( Exception^ e ) 
   {
      Console::WriteLine( "\nThe following Exception was raised : {0}", e->Message );
   }
}
public static void GetPage(String url)
{
    try
      {	
            // Creates an HttpWebRequest for the specified URL.
            HttpWebRequest myHttpWebRequest = (HttpWebRequest)WebRequest.Create(url);
            // Sends the HttpWebRequest and waits for a response.
            HttpWebResponse myHttpWebResponse = (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 occurred : {0}",e.Status);
       }
    catch(Exception e)
    {
        Console.WriteLine("\nThe following Exception was raised : {0}",e.Message);
    }
}
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 occurred : {0}", e.Status)
    Catch e As Exception
        Console.WriteLine(ControlChars.NewLine + "The following exception was raised : {0}", e.Message)
    End Try
End Sub 

Remarks

A common status message is OK.

Applies to