Export (0) Print
Expand All
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)

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

value = instance.StatusDescription

/** @property */
public String get_StatusDescription ()

public function get StatusDescription () : String

Not applicable.

Property Value

A string that describes the status of the response.
Exception typeCondition

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 

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.get_StatusCode().Equals(HttpStatusCode.OK)) {
            Console.WriteLine("\r\nResponse Status Code is OK and "
                + "StatusDescription is: {0}", 
                myHttpWebResponse.get_StatusDescription());
        }
        // Releases the resources of the response.
        myHttpWebResponse.Close();
    }
    catch (WebException e) {
        Console.WriteLine("\r\nWebException Raised. The "
            + "following error occured : {0}", e.get_Status());
    }
    catch (System.Exception e) {
        Console.WriteLine("\nThe following Exception was raised : {0}",
            e.get_Message());
    }
} //GetPage

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

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.