This documentation is archived and is not being maintained.

HttpListenerPrefixCollection.GetEnumerator Method

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

Returns an object that can be used to iterate through the collection.

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

Public Function GetEnumerator As IEnumerator(Of String)
Dim instance As HttpListenerPrefixCollection
Dim returnValue As IEnumerator(Of String)

returnValue = instance.GetEnumerator
public final IEnumerator<String> GetEnumerator ()
public final function GetEnumerator () : IEnumerator<String>

Return Value

An object that implements the IEnumerator interface and provides access to the strings in this collection.

The object that is returned by this method is initially positioned before the first element in this collection. You must call the MoveNext method before you can access the first element. To access the element at the current position, call the Current property.

Do not modify the collection while using the enumerator. If the collection is modified while an enumerator is in use, an attempt to set the position by calling MoveNext or Reset causes an InvalidOperationException.

For a detailed description of enumerators, see the documentation for the IEnumerator class and the GetEnumerator method.

The following code example demonstrates enumerating through a collection. Note that the Visual Basic and C# examples use language specific statements to enumerate through the collection instead of retrieving the enumerator.

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)
    // Show the listening state.
    if (listener.IsListening)
        Console.WriteLine("The server is listening.");

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 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