IEnumerator.Reset Method

Definition

Legt den Enumerator auf seine Anfangsposition vor dem ersten Element in der Auflistung fest.Sets the enumerator to its initial position, which is before the first element in the collection.

public:
 void Reset();
public void Reset ();
abstract member Reset : unit -> unit
Public Sub Reset ()

Exceptions

Die Sammlung wurde nach der Erstellung des Enumerators geändert.The collection was modified after the enumerator was created.

Examples

Im folgenden Codebeispiel wird die Implementierung der IEnumerator-Schnittstellen für eine benutzerdefinierte Auflistung veranschaulicht.The following code example demonstrates the implementation of the IEnumerator interfaces for a custom collection. In diesem Beispiel wird Reset nicht explizit aufgerufen, aber implementiert, um die Verwendung von foreach (for each in Visual Basic) zu unterstützen.In this example, Reset is not explicitly called, but it is implemented to support the use of foreach (for each in Visual Basic). Dieses Codebeispiel ist Teil eines größeren Beispiels für die IEnumerator-Schnittstelle.This code example is part of a larger example for the IEnumerator interface.

// When you implement IEnumerable, you must also implement IEnumerator.
public class PeopleEnum : IEnumerator
{
    public Person[] _people;

    // Enumerators are positioned before the first element
    // until the first MoveNext() call.
    int position = -1;

    public PeopleEnum(Person[] list)
    {
        _people = list;
    }

    public bool MoveNext()
    {
        position++;
        return (position < _people.Length);
    }

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

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

    public Person Current
    {
        get
        {
            try
            {
                return _people[position];
            }
            catch (IndexOutOfRangeException)
            {
                throw new InvalidOperationException();
            }
        }
    }
}
' When you implement IEnumerable, you must also implement IEnumerator.
Public Class PeopleEnum
    Implements IEnumerator

    Public _people() As Person

    ' Enumerators are positioned before the first element
    ' until the first MoveNext() call.
    Dim position As Integer = -1

    Public Sub New(ByVal list() As Person)
        _people = list
    End Sub

    Public Function MoveNext() As Boolean Implements IEnumerator.MoveNext
        position = position + 1
        Return (position < _people.Length)
    End Function

    Public Sub Reset() Implements IEnumerator.Reset
        position = -1
    End Sub

    Public ReadOnly Property Current() As Object Implements IEnumerator.Current
        Get
            Try
                Return _people(position)
            Catch ex As IndexOutOfRangeException
                Throw New InvalidOperationException()
            End Try
        End Get
    End Property
End Class

Remarks

Wenn Änderungen an der Auflistung vorgenommen werden, z. b. das Hinzufügen, ändern oder Löschen von Elementen, ist das Verhalten von Reset nicht definiert.If changes are made to the collection, such as adding, modifying, or deleting elements, the behavior of Reset is undefined.

Die Reset-Methode wird für die COM-Interoperabilität bereitgestellt.The Reset method is provided for COM interoperability. Es muss nicht unbedingt implementiert werden. Stattdessen kann der Implementierer einfach eine NotSupportedExceptionauslösen.It does not necessarily need to be implemented; instead, the implementer can simply throw a NotSupportedException.

Notes to Implementers

Alle Aufrufe von Reset() müssen denselben Status für den Enumerator aufweisen.All calls to Reset() must result in the same state for the enumerator. Die bevorzugte Implementierung besteht darin, den Enumerator vor dem ersten Element an den Anfang der Auflistung zu verschieben.The preferred implementation is to move the enumerator to the beginning of the collection, before the first element. Dadurch wird der Enumerator ungültig, wenn die Auflistung seit der Erstellung des Enumerators geändert wurde, was mit MoveNext() und Currentkonsistent ist.This invalidates the enumerator if the collection has been modified since the enumerator was created, which is consistent with MoveNext() and Current.

Applies to

See also