HttpListenerResponse.StatusCode プロパティとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

HttpListenerResponse.StatusCode プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

クライアントへ返される HTTP ステータスコードを取得または設定します。

名前空間: System.Net
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

Public Property StatusCode As
 Integer

Visual Basic (使用法)

Dim instance As HttpListenerResponse
Dim value As Integer

value = instance.StatusCode

instance.StatusCode = value

public int StatusCode { get;
 set; }

C++

public:
property int StatusCode {
    int get ();
    void set (int value);
}

/** @property */
public int get_StatusCode ()

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

JScript

public function get StatusCode
 () : int

public function set StatusCode
 (value : int)

プロパティ値
要求されたリソースの HTTP ステータスコードを示す Int32 値。既定値は OK で、サーバーがクライアントの要求を正常に処理し、要求されたリソースを応答本体に挿入したことを示します。

例外

例外の種類	条件
ObjectDisposedException	オブジェクトが閉じています。
ProtocolViolationException	設定操作として指定した値が無効です。有効値は 100 ～ 999 の範囲です。

解説

クライアントは、サーバーから返されたステータスコードを使用して、その後の処理を決定します。OK の値は、サーバーが正常にクライアントの要求を処理し、要求されたリソースを応答本体に挿入したことを示します。他に一般的なステータスコードとして、要求されたリソースがサーバーにないことを示す NotFound や、クライアントにあるリソースのキャッシュコピーが最新であるために要求されたリソースを応答本体に挿入する必要がないことを示す NotModified などがあります。

使用される可能性のあるステータスコードの完全な一覧については、HttpStatusCode 列挙体を参照してください。

使用例

このプロパティの値を設定するコード例を次に示します。

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