IEnumerable.GetEnumerator-Methode

Artikel
08/20/2007

Gibt einen Enumerator zurück, der eine Auflistung durchläuft.

Namespace: System.Collections
Assembly: mscorlib (in mscorlib.dll)

Syntax

'Declaration
Function GetEnumerator As IEnumerator
'Usage
Dim instance As IEnumerable
Dim returnValue As IEnumerator

returnValue = instance.GetEnumerator

IEnumerator GetEnumerator ()

IEnumerator^ GetEnumerator ()

IEnumerator GetEnumerator ()

function GetEnumerator () : IEnumerator

Rückgabewert

Ein IEnumerator-Objekt, das zum Durchlaufen der Auflistung verwendet werden kann.

Hinweise

Die foreach-Anweisung der Programmiersprache C# (for each in Visual Basic) verbirgt die Komplexität der Enumeratoren. Daher wird empfohlen, foreach zu verwenden, anstatt den Enumerator direkt zu bearbeiten.

Mit Enumeratoren können die Daten in der Auflistung gelesen werden, sie können jedoch nicht zum Ändern der zugrunde liegenden Auflistung verwendet werden.

Anfangs befindet sich der Enumerator vor dem ersten Element in der Auflistung. Die Reset-Methode fügt den Enumerator auch wieder an dieser Position ein. An dieser Position ist die Current-Eigenschaft nicht definiert. Daher muss der Enumerator durch einen Aufruf der MoveNext-Methode auf das erste Element der Auflistung festgelegt werden, bevor der Wert von Current gelesen werden kann.

Current gibt so lange dasselbe Objekt zurück, bis MoveNext oder Reset aufgerufen wird. MoveNext setzt Current auf das nächste Element.

Wenn MoveNext das Ende der Auflistung erreicht, wird der Enumerator hinter dem letzten Element in der Auflistung positioniert, und MoveNext gibt false zurück. Wenn sich der Enumerator an dieser Position befindet, geben nachfolgende Aufrufe von MoveNext ebenfalls false zurück. Wenn beim letzten Aufruf von MoveNextfalse zurückgegeben wird, ist Current nicht definiert. Um Current wieder auf das erste Element der Auflistung zu setzen, können Sie Reset gefolgt von MoveNext aufrufen.

Ein Enumerator bleibt so lange gültig, bis die Auflistung geändert wird. Wenn an der Auflistung Änderungen vorgenommen werden, z. B. durch Hinzufügen, Ändern oder Löschen von Elementen, ist der Enumerator unwiderruflich ungültig und das zugehörige Verhalten nicht definiert.

Der Enumerator hat keinen exklusiven Zugriff auf die Auflistung. Daher ist die Enumeration einer Auflistung systemintern keine threadsichere Prozedur. Um Threadsicherheit während der Enumeration zu gewährleisten, können Sie die Auflistung während der gesamten Enumeration sperren. Um den Lese- und Schreibzugriff auf diese Auflistung durch mehrere Threads zuzulassen, müssen Sie eine eigene Synchronisierung implementieren.

Beispiel

Im folgenden Codebeispiel wird die Implementierung von IEnumerable-Schnittstellen für eine benutzerdefinierte Auflistung veranschaulicht. In diesem Beispiel wird GetEnumerator nicht explizit aufgerufen, sondern es wird zur Unterstützung der Verwendung von foreach (for each in Visual Basic) implementiert. Dieses Codebeispiel ist Teil eines umfangreicheren Beispiels für die IEnumerable-Schnittstelle.

Public Class People
    Implements IEnumerable

    Private _people() As Person

    Public Sub New(ByVal pArray() As Person)
        _people = New Person(pArray.Length - 1) {}

        Dim i As Integer
        For i = 0 To pArray.Length - 1
            _people(i) = pArray(i)
        Next i
    End Sub

    Public Function GetEnumerator() As IEnumerator _
      Implements IEnumerable.GetEnumerator

        Return New PeopleEnum(_people)
    End Function

End Class

public class People : IEnumerable
{
    private Person[] _people;
    public People(Person[] pArray)
    {
        _people = new Person[pArray.Length];

        for (int i = 0; i < pArray.Length; i++)
        {
            _people[i] = pArray[i];
        }
    }

    public IEnumerator GetEnumerator()
    {
        return new PeopleEnum(_people);
    }
}

Plattformen

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile für Pocket PC, Windows Mobile für Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

.NET Framework unterstützt nicht alle Versionen sämtlicher Plattformen. Eine Liste der unterstützten Versionen finden Sie unter Systemanforderungen.

Versionsinformationen

.NET Framework

Unterstützt in: 2.0, 1.1, 1.0

.NET Compact Framework

Unterstützt in: 2.0, 1.0

Siehe auch

Referenz

IEnumerable-Schnittstelle
IEnumerable-Member
System.Collections-Namespace
IEnumerator

Freigeben über