HttpListenerResponse.StatusCode 屬性

  • 參考

定義

命名空間:
System.Net
組件:
System.Net.HttpListener.dll
組件:
System.dll
組件:
netstandard.dll
來源:
HttpListenerResponse.Managed.cs
來源:
HttpListenerResponse.Managed.cs
來源:
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

Int32 值，指定所要求之資源的 HTTP 狀態碼。 預設值為 OK，指出伺服器成功處理用戶端的要求，並在回應主體中包含所要求的資源。

例外狀況

ObjectDisposedException

這個物件已經關閉。

ProtocolViolationException

指定給設定作業的值無效。 有效值介於 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 列舉。

適用於

另請參閱