Export (0) Print
Expand All

HttpListenerResponse.StatusDescription Property

Gets or sets a text description of the HTTP status code returned to the client.

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

'Declaration
Public Property StatusDescription As String

Property Value

Type: System.String
The text description of the HTTP status code returned to the client. The default is the RFC 2616 description for the StatusCode property value, or an empty string ("") if an RFC 2616 description does not exist.

ExceptionCondition
ArgumentNullException

The value specified for a set operation is Nothing.

ArgumentException

The value specified for a set operation contains non-printable characters.

The status description typically provides details that explain the StatusCode value.

The following code example demonstrates setting the value of this property.


' When the client is not authenticated, there is no Identity. 
If context.User Is Nothing Then
    message.Append("<HTML><BODY><p> Hello local user! </p></BODY></HTML>")
Else 
    ' Get the requester's identity. 
    Dim identity As System.Security.Principal.WindowsIdentity = WindowsIdentity.GetCurrent()
    ' Construct the response body.
    message.AppendFormat("<HTML><BODY><p> Hello {0}!<br/>", identity.Name)
    message.AppendFormat("You were authenticated using {0}.</p>", identity.AuthenticationType)
    message.Append("</BODY></HTML>")
End If 

' Configure the response. 
Dim response As HttpListenerResponse = context.Response

' Use the encoding from the response if one has been set. 
' Otherwise, use UTF8. 
Dim encoding As System.Text.Encoding = response.ContentEncoding
If encoding Is Nothing Then
    encoding = System.Text.Encoding.UTF8
    response.ContentEncoding = encoding
End If 
Dim buffer() As Byte = encoding.GetBytes(message.ToString())
response.ContentLength64 = buffer.Length
response.StatusCode = CInt(HttpStatusCode.OK)
response.StatusDescription = "OK"
response.ProtocolVersion = New Version("1.1")
' Don't keep the TCP connection alive 
' We don't expect multiple requests from the same client.
response.KeepAlive = False 
' Write the response body. 
Dim stream As System.IO.Stream = response.OutputStream
stream.Write(buffer, 0, buffer.Length)

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Show:
© 2014 Microsoft