通过

HttpListenerResponse.StatusCode 属性

  • 参考

定义

命名空间:
System.Net
程序集:
System.Net.HttpListener.dll
程序集:
System.dll
程序集:
netstandard.dll
Source:
HttpListenerResponse.Managed.cs
Source:
HttpListenerResponse.Managed.cs
Source:
HttpListenerResponse.Managed.cs

获取或设置返回给客户端的 HTTP 状态代码。

public:
 property int StatusCode { int get(); void set(int value); };
public int StatusCode { get; set; }
member this.StatusCode : int with get, set
Public Property StatusCode As Integer

属性值

Int32

为请求的资源指定 HTTP 状态代码的 Int32 值。 默认值为 OK，指示服务器成功处理了客户端的请求并将请求的资源包括在响应正文中。

例外

ObjectDisposedException

此对象已关闭。

ProtocolViolationException

为设置操作指定的值无效。 有效值介于 100 和 999 之间（包含 100 和 999）。

示例

下面的代码示例演示如何设置此属性的值。


// 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);


' 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)

注解

客户端使用服务器返回的状态代码来决定如何继续。 值 指示 OK 服务器已成功处理客户端的请求，并在响应正文中包含请求的资源。 其他常见状态代码包括 NotFound，指示在服务器上找不到请求的资源，以及 NotModified，指示不需要在响应正文中返回请求的资源，因为客户端的资源缓存副本是最新的。

有关可能的状态代码的完整列表，请参阅 HttpStatusCode 枚举。

适用于

另请参阅