Export (0) Print
Expand All

HttpListenerResponse.StatusDescription Property

Note: This property is new in the .NET Framework version 2.0.

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

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

public:
property String^ StatusDescription {
	String^ get ();
	void set (String^ value);
}
/** @property */
public String get_StatusDescription ()

/** @property */
public void set_StatusDescription (String value)

public function get StatusDescription () : String

public function set StatusDescription (value : String)

Property Value

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.

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 == null)
{
    message.Append ("<HTML><BODY><p> Hello local user! </p></BODY></HTML>");
}
else
{
    // Get the requester's identity.
    System.Security.Principal.WindowsIdentity identity = 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>");
}

// Configure the response.
HttpListenerResponse response = context.Response;

// Use the encoding from the response if one has been set.
// Otherwise, use UTF8.
System.Text.Encoding encoding = response.ContentEncoding;
if (encoding == null)
{
    encoding = System.Text.Encoding.UTF8;
    response.ContentEncoding = encoding;
}
byte[] buffer = encoding.GetBytes (message.ToString ());
response.ContentLength64 = buffer.Length;
response.StatusCode = (int) 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.
System.IO.Stream stream = response.OutputStream;
stream.Write(buffer, 0, buffer.Length);

Windows 98, Windows Server 2003, Windows XP Media Center Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0

Community Additions

ADD
Show:
© 2014 Microsoft