IEnumerator.Reset Méthode

Définition

Rétablit l'énumérateur à sa position initiale, qui précède le premier élément de la collection.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

La collection a été modifiée après la création de l'énumérateur.The collection was modified after the enumerator was created.

Exemples

L’exemple de code suivant illustre l’implémentation des IEnumerator interfaces pour une collection personnalisée.The following code example demonstrates the implementation of the IEnumerator interfaces for a custom collection. Dans cet exemple, Reset n’est pas appelé explicitement, mais il est implémenté pour prendre en charge foreach l'for each utilisation de (dans Visual Basic).In this example, Reset is not explicitly called, but it is implemented to support the use of foreach (for each in Visual Basic). Cet exemple de code fait partie d’un exemple plus complet IEnumerator pour l’interface.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

Remarques

Si des modifications sont apportées à la collection, telles que l’ajout, la modification ou la suppression d' Reset éléments, le comportement de n’est pas défini.If changes are made to the collection, such as adding, modifying, or deleting elements, the behavior of Reset is undefined.

La Reset méthode est fournie pour l’interopérabilité COM.The Reset method is provided for COM interoperability. Elle n’a pas nécessairement besoin d’être implémentée; au lieu de cela, l’implémenteur peut NotSupportedExceptionsimplement lever une.It does not necessarily need to be implemented; instead, the implementer can simply throw a NotSupportedException.

Notes pour les responsables de l’implémentation

Tous les appels Reset() à doivent donner le même État pour l’énumérateur.All calls to Reset() must result in the same state for the enumerator. L’implémentation par défaut consiste à déplacer l’énumérateur au début de la collection, avant le premier élément.The preferred implementation is to move the enumerator to the beginning of the collection, before the first element. Cela invalide l’énumérateur si la collection a été modifiée depuis la création de l’énumérateur, ce qui est cohérent avec MoveNext() et Current.This invalidates the enumerator if the collection has been modified since the enumerator was created, which is consistent with MoveNext() and Current.

S’applique à

Voir aussi