HttpListener.Prefixes Property

Definition

Namespace:

System.Net

Assembly:

System.Net.HttpListener.dll

Source:

HttpListener.cs

Gets the Uniform Resource Identifier (URI) prefixes handled by this HttpListener object.

public:
 property System::Net::HttpListenerPrefixCollection ^ Prefixes { System::Net::HttpListenerPrefixCollection ^ get(); };

public System.Net.HttpListenerPrefixCollection Prefixes { get; }

member this.Prefixes : System.Net.HttpListenerPrefixCollection

Public ReadOnly Property Prefixes As HttpListenerPrefixCollection

Property Value

HttpListenerPrefixCollection

An HttpListenerPrefixCollection that contains the URI prefixes that this HttpListener object is configured to handle.

Exceptions

ObjectDisposedException

This object has been closed.

Examples

The following code example demonstrates using the Prefixes property to obtain and print the URI prefixes that are handled.

public static void DisplayPrefixesAndState(HttpListener listener)
{
    // List the prefixes to which the server listens.
    HttpListenerPrefixCollection prefixes = listener.Prefixes;
    if (prefixes.Count == 0)
    {
        Console.WriteLine("There are no prefixes.");
    }
    foreach(string prefix in prefixes)
    {
        Console.WriteLine(prefix);
    }
    // Show the listening state.
    if (listener.IsListening)
    {
        Console.WriteLine("The server is listening.");
    }
}

Public Shared Sub DisplayPrefixesAndState(ByVal listener As HttpListener)
    ' List the prefixes to which the server listens.
    Dim prefixes As HttpListenerPrefixCollection = listener.Prefixes

    If prefixes.Count = 0 Then
        Console.WriteLine("There are no prefixes.")
    End If

    For Each prefix As String In prefixes
        Console.WriteLine(prefix)
    Next

    ' Show the listening state.
    If listener.IsListening Then
        Console.WriteLine("The server is listening.")
    End If
End Sub

Remarks

The prefixes are in canonical form. For a detailed description of prefixes, see the HttpListener class overview.