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

要求されたリソースの HTTP ステータス コードを示す Int32 値。 既定値は 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 参照してください。

適用対象

こちらもご覧ください