Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

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 Value

Type: System::String^

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

Exception Condition
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";
}

.NET Framework
Available since 2.0
Return to top
Show:
© 2017 Microsoft