StatusDescription Property

HttpWebResponse.StatusDescription Property

 

Gets the status description returned with the response.

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

Public Overridable ReadOnly Property StatusDescription As String

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.

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 

Universal Windows Platform
Available since 4.5
.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:
© 2016 Microsoft