HttpListener.Realm Property

Note: This property is new in the .NET Framework version 2.0.

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

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

Public Property Realm As String
Dim instance As HttpListener
Dim value As String

value = instance.Realm

instance.Realm = value
/** @property */
public String get_Realm ()

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

public function get Realm () : String

public function set Realm (value : String)

Property Value

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

Exception typeCondition


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

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";

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

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0