IEnumerator<T> IEnumerator<T> IEnumerator<T> IEnumerator<T> Interface

Definition

Unterstützt eine einfache Iteration durch eine generische Auflistung.Supports a simple iteration over a generic collection.

generic <typename T>
public interface class IEnumerator : IDisposable, System::Collections::IEnumerator
public interface IEnumerator<out T> : IDisposable, System.Collections.IEnumerator
type IEnumerator<'T> = interface
    interface IDisposable
    interface IEnumerator
Public Interface IEnumerator(Of Out T)
Implements IDisposable, IEnumerator

Typparameter

T

Der Typ der aufzulistenden Objekte.The type of objects to enumerate.

Abgeleitet
Implementiert

Beispiele

Das folgende Beispiel zeigt eine Implementierung der IEnumerator<T> -Schnittstelle für eine Auflistungsklasse benutzerdefinierter Objekte.The following example shows an implementation of the IEnumerator<T> interface for a collection class of custom objects. Das benutzerdefinierte Objekt ist eine Instanz des Typs Box, und die Auflistungsklasse ist BoxCollection.The custom object is an instance of the type Box, and the collection class is BoxCollection. Dieses Codebeispiel ist Teil eines umfangreicheren Beispiels für die ICollection<T> Schnittstelle.This code example is part of a larger example provided for the ICollection<T> interface.


// Defines the enumerator for the Boxes collection.
// (Some prefer this class nested in the collection class.)
public class BoxEnumerator : IEnumerator<Box>
{
    private BoxCollection _collection;
    private int curIndex;
    private Box curBox;


    public BoxEnumerator(BoxCollection collection)
    {
        _collection = collection;
        curIndex = -1;
        curBox = default(Box);

    }

    public bool MoveNext()
    {
        //Avoids going beyond the end of the collection.
        if (++curIndex >= _collection.Count)
        {
            return false;
        }
        else
        {
            // Set current box to next item in collection.
            curBox = _collection[curIndex];
        }
        return true;
    }

    public void Reset() { curIndex = -1; }

    void IDisposable.Dispose() { }

    public Box Current
    {
        get { return curBox; }
    }


    object IEnumerator.Current
    {
        get { return Current; }
    }

}
' Defines the enumerator for the Boxes collection.
' (Some prefer this class nested in the collection class.)
Public Class BoxEnumerator
    Implements IEnumerator(Of Box)
    Private _collection As BoxCollection
    Private curIndex As Integer
    Private curBox As Box


    Public Sub New(ByVal collection As BoxCollection)
        MyBase.New()
        _collection = collection
        curIndex = -1
        curBox = Nothing

    End Sub

    Private Property Box As Box
    Public Function MoveNext() As Boolean _
        Implements IEnumerator(Of Box).MoveNext
        curIndex = curIndex + 1
        If curIndex = _collection.Count Then
            ' Avoids going beyond the end of the collection.
            Return False
        Else
            'Set current box to next item in collection.
            curBox = _collection(curIndex)
        End If
        Return True
    End Function

    Public Sub Reset() _
        Implements IEnumerator(Of Box).Reset
        curIndex = -1
    End Sub

    Public Sub Dispose() _
        Implements IEnumerator(Of Box).Dispose

    End Sub

    Public ReadOnly Property Current() As Box _
        Implements IEnumerator(Of Box).Current

        Get
            If curBox Is Nothing Then
                Throw New InvalidOperationException()
            End If

            Return curBox
        End Get
    End Property

    Private ReadOnly Property Current1() As Object _
        Implements IEnumerator.Current

        Get
            Return Me.Current
        End Get
    End Property
End Class

' Defines two boxes as equal if they have the same dimensions.
Public Class BoxSameDimensions
    Inherits EqualityComparer(Of Box)

    Public Overrides Function Equals(ByVal b1 As Box, ByVal b2 As Box) As Boolean
        If b1.Height = b2.Height And b1.Length = b2.Length And b1.Width = b2.Width Then
            Return True
        Else
            Return False
        End If
    End Function

    Public Overrides Function GetHashCode(ByVal bx As Box) As Integer
        Dim hCode As Integer = bx.Height ^ bx.Length ^ bx.Width
        Return hCode.GetHashCode()
    End Function
End Class

Hinweise

IEnumerator<T> ist die Basisschnittstelle für alle generischen Enumeratoren.IEnumerator<T> is the base interface for all generic enumerators.

Die foreach -Anweisung der c#-Sprache (for each in C++ For Each in Visual Basic) verbirgt die Komplexität der Enumeratoren.The foreach statement of the C# language (for each in C++, For Each in Visual Basic) hides the complexity of the enumerators. Daher empfiehlt es sich, foreach zu verwenden und den Enumerator nicht direkt zu ändern.Therefore, using foreach is recommended, instead of directly manipulating the enumerator.

Mit Enumeratoren können die Daten in der Auflistung zwar gelesen, jedoch nicht zum Ändern der zugrunde liegenden Auflistung verwendet werden.Enumerators can be used to read the data in the collection, but they cannot be used to modify the underlying collection.

Zu Beginn wird der Enumerator vor das erste Element in der Auflistung positioniert.Initially, the enumerator is positioned before the first element in the collection. An dieser Position ist Current nicht definiert.At this position, Current is undefined. Daher muss der Enumerator durch einen Aufruf von MoveNext auf das erste Element der Auflistung gesetzt werden, bevor der Wert von Current gelesen werden kann.Therefore, you must call MoveNext to advance the enumerator to the first element of the collection before reading the value of Current.

Current gibt solange dasselbe Objekt zurück, bis MoveNext aufgerufen wird.Current returns the same object until MoveNext is called. MoveNext legt Current auf das nächste Element fest.MoveNext sets Current to the next element.

Wenn MoveNext das Ende der Auflistung übergibt, wird der Enumerator hinter dem letzten Element in der Auflistung platziert, und MoveNext gibt false zurück.If MoveNext passes the end of the collection, the enumerator is positioned after the last element in the collection and MoveNext returns false. Wenn sich der Enumerator an dieser Position befindet, geben nachfolgende Aufrufe von MoveNext auch false zurück.When the enumerator is at this position, subsequent calls to MoveNext also return false. Wenn der letzte Aufruf MoveNext zurückgegebene false, Current ist nicht definiert.If the last call to MoveNext returned false, Current is undefined. Sie können Current nicht erneut auf das erste Element der Auflistung festlegen, sondern müssen eine neue Enumeratorinstanz erstellen.You cannot set Current to the first element of the collection again; you must create a new enumerator instance instead.

Die Reset Methode wird bereitgestellt, für COM-Interoperabilität.The Reset method is provided for COM interoperability. Es muss nicht unbedingt implementiert werden; Stattdessen kann der Implementierer einfach Auslösen einer NotSupportedException.It does not necessarily need to be implemented; instead, the implementer can simply throw a NotSupportedException. Allerdings möchten Sie dazu, stellen Sie sicher keine Aufrufer setzen auf die Reset Funktion.However, if you choose to do this, you should make sure no callers are relying on the Reset functionality.

Wenn Änderungen, auf die Auflistung, z. B. hinzufügen vorgenommen werden, ändern oder Löschen von Elementen, ist das Verhalten des Enumerators nicht definiert.If changes are made to the collection, such as adding, modifying, or deleting elements, the behavior of the enumerator is undefined.

Der Enumerator hat keinen exklusiven Zugriff auf die Auflistung; daher ist die Enumeration einer Auflistung systembedingt kein threadsicheres Verfahren.The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Um während der Enumeration Threadsicherheit zu garantieren, können Sie die Auflistung während der gesamten Enumeration sperren.To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. Um den Lese- und Schreibzugriff auf diese Auflistung durch mehrere Threads zuzulassen, müssen Sie eine eigene Synchronisierung implementieren.To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization.

Standardimplementierungen der Auflistungen im System.Collections.Generic-Namespace werden nicht synchronisiert.Default implementations of collections in the System.Collections.Generic namespace are not synchronized.

Hinweise für Ausführende

Implementierung dieser Schnittstelle muss die nicht generische Implementierung IEnumerator Schnittstelle. Die MoveNext() und Reset() Methoden hängen nicht T, und nur in der nicht generischen Schnittstelle angezeigt. Die Current -Eigenschaft ist in beiden Schnittstellen und verfügt über verschiedene Rückgabetypen. Implementieren Sie die nicht generische Current wie eine explizite Implementierung. Dies ermöglicht es jedem Consumer der nicht generischen Schnittstelle, die generische Schnittstelle verwenden. Darüber hinaus IEnumerator<T> implementiert IDisposable, die Implementierung erfordert die Dispose() Methode. Dadurch schließen Datenbankverbindungen oder Dateihandles oder ähnlichen Vorgängen freigeben, wenn Sie andere Ressourcen verwenden. Sind keine zusätzlichen Ressourcen freigeben, geben Sie ein leeres Dispose() Implementierung.

Implementing this interface requires implementing the nongeneric IEnumerator interface. The MoveNext() and Reset() methods do not depend on T, and appear only on the nongeneric interface. The Current property appears on both interfaces, and has different return types. Implement the nongeneric Current property as an explicit interface implementation. This allows any consumer of the nongeneric interface to consume the generic interface. In addition, IEnumerator<T> implements IDisposable, which requires you to implement the Dispose() method. This enables you to close database connections or release file handles or similar operations when using other resources. If there are no additional resources to dispose of, provide an empty Dispose() implementation.

Eigenschaften

Current Current Current Current

Ruft das Element in der Auflistung an der aktuellen Position des Enumerators ab.Gets the element in the collection at the current position of the enumerator.

Gilt für:

Siehe auch