Export (0) Print
Expand All

HttpListener.Realm Property

Gets or sets the realm, or resource partition, associated with this HttpListener object.

Namespace: System.Net
Assembly: System (in system.dll)

public:
property String^ Realm {
	String^ get ();
	void set (String^ value);
}
/** @property */
public String get_Realm ()

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

public function get Realm () : String

public function set Realm (value : String)

Not applicable.

Property Value

A String value that contains the name of the realm associated with the HttpListener object.

Exception typeCondition

ObjectDisposedException

This object has been closed.

Servers use realms to partition protected resources; each partition can have its own authentication scheme and/or authorization database. Realms are used only for basic and digest authentication. After a client successfully authenticates, the authentication is valid for all resources in a given realm. For a detailed description of realms, see RFC 2617 at http://www.ietf.org.

An instance of HttpListener has only one associated realm.

The following code example demonstrates setting the Realm property.

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

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

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

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions

ADD
Show:
© 2015 Microsoft