GetEnumerator Method

HttpListenerPrefixCollection.GetEnumerator Method ()


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

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

abstract GetEnumerator : unit -> IEnumerator<string>
override GetEnumerator : unit -> IEnumerator<string>

Return Value

Type: System.Collections.Generic.IEnumerator<String>

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

.NET Framework
Available since 2.0
Return to top
© 2015 Microsoft