HttpListener.Realm プロパティ

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

HttpListener.Realm プロパティ

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

この HttpListener オブジェクトに関連付けられているレルム (リソース パーティション) を取得または設定します。

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

Visual Basic (宣言)

Public Property Realm As
 String

Visual Basic (使用法)

Dim instance As HttpListener
Dim value As String

value = instance.Realm

instance.Realm = value

C#

public string Realm { get;
 set; }

C++

public:
property String^ Realm {
    String^ get ();
    void set (String^ value);
}

J#

/** @property */
public String get_Realm ()

/** @property */
public void set_Realm (String value)

JScript

public function get Realm
 () : String

public function set Realm
 (value : String)

プロパティ値
HttpListener オブジェクトに関連付けられているレルムの名前が格納された String 値。

例外

例外の種類	条件
ObjectDisposedException	このオブジェクトは閉じられています。

解説

サーバーは、レルムを使用して、保護されたリソースをパーティションに分割します。パーティションごとに、認証方式と承認データベースの両方、またはそのいずれかを指定できます。レルムは、基本認証およびダイジェスト認証だけに使用されます。クライアントが正常に認証されると、その認証は特定のレルムのすべてのリソースに対して有効となります。レルムの詳細については、http://www.ietf.org の RFC 2617 を参照してください。

HttpListener のインスタンスには、1 つのレルムだけが関連付けられます。

使用例

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

C#

public static void ConfigureListener1(HttpListener
 listener)
{
    // Specify an authentication realm.
    listener.Realm = "ExampleRealm";
}

プラットフォーム

Windows 98, Windows Server 2003, Windows XP Media Center Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
HttpListener クラス
HttpListener メンバ
System.Net 名前空間