Export (0) Print
Expand All

HttpListenerResponse.StatusCode Property

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

Gets or sets the HTTP status code to be returned to the client.

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

public int StatusCode { get; set; }
/** @property */
public int get_StatusCode ()

/** @property */
public void set_StatusCode (int value)

public function get StatusCode () : int

public function set StatusCode (value : int)

Property Value

An Int32 value that specifies the HTTP status code for the requested resource. The default is OK, indicating that the server successfully processed the client's request and included the requested resource in the response body.

Exception typeCondition

ObjectDisposedException

This object is closed.

ProtocolViolationException

The value specified for a set operation is not valid. Valid values are between 100 and 999 inclusive.

Clients use the status code returned by the server to decide how to proceed. A value of OK indicates that the server successfully processed the client's request and included the requested resource in the response body. Other common status codes include NotFound, indicating that the requested resource was not found on the server, and NotModified, indicating that it was unnecessary to return the requested resource in the response body because the client's cached copy of the resource is up-to-date.

For a complete list of possible status codes, see the HttpStatusCode enumeration.

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

public static string[] CopyPrefixes (HttpListener listener)
{
     HttpListenerPrefixCollection prefixes = listener.Prefixes;
     string[] prefixArray = new string[prefixes.Count];
     prefixes.CopyTo(prefixArray, 0);
     return prefixArray;
}

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