HttpListener.Realm Property


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

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

Property Value

Type: System.String

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

Exception Condition

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

.NET Framework
Available since 2.0
Return to top