IEnumerator.Reset Méthode

Définition

Espace de noms:

System.Collections

Assembly:

System.Runtime.dll

Rétablit l'énumérateur à sa position initiale, qui précède le premier élément de la collection.

public:
 void Reset();

public void Reset ();

abstract member Reset : unit -> unit

Public Sub Reset ()

Exceptions

InvalidOperationException

La collection a été modifiée après la création de l'énumérateur.

NotSupportedException

L’énumérateur ne prend pas en charge la réinitialisation.

Exemples

L’exemple de code suivant illustre l’implémentation des IEnumerator interfaces pour une collection personnalisée. Dans cet exemple, Reset n’est pas appelé explicitement, mais il est implémenté pour prendre en charge l’utilisation de foreach (for each en Visual Basic). Cet exemple de code fait partie d’un exemple plus grand pour l’interface IEnumerator .

// 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’éléments, le comportement de Reset n’est pas défini.

La Reset méthode est fournie pour l’interopérabilité COM. Elle n’a pas nécessairement besoin d’être implémentée ; au lieu de cela, l’implémenteur peut simplement lever un NotSupportedException.

Notes pour les responsables de l’implémentation

Tous les appels à Reset() doivent aboutir au même état pour l’énumérateur. L’implémentation préférée consiste à déplacer l’énumérateur vers le début de la collection, avant le premier élément. 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.

Voir aussi

• MoveNext()
• Current