Export (0) Print
Expand All

HttpWebResponse.StatusDescription Property

Gets the status description returned with the response.

[Visual Basic]
Public ReadOnly Property StatusDescription As String
[C#]
public string StatusDescription {get;}
[C++]
public: __property String* get_StatusDescription();
[JScript]
public function get StatusDescription() : String;

Property Value

A string describing the status of the response.

Exceptions

Exception Type Condition
ObjectDisposedException The current instance has been disposed.

Remarks

A common status message is OK.

Example

[Visual Basic, C#, C++] The following example uses StatusDescription to verify that the status of the HttpWebResponse is OK.

[Visual Basic] 
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 

[C#] 
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 occured : {0}",e.Status); 
       }
    catch(Exception e)
    {
        Console.WriteLine("\nThe following Exception was raised : {0}",e.Message);
    }
}

[C++] 
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);
   }
}

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, .NET Compact Framework, Common Language Infrastructure (CLI) Standard

See Also

HttpWebResponse Class | HttpWebResponse Members | System.Net Namespace

Show:
© 2014 Microsoft