IEnumerator.Reset Metoda

  • Reference

Definice

Obor názvů:
System.Collections
Sestavení:
System.Runtime.dll
Sestavení:
mscorlib.dll
Sestavení:
netstandard.dll

Nastaví enumerátor na jeho počáteční pozici, která je před prvním prvkem v kolekci.

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

Výjimky

InvalidOperationException

Kolekce byla změněna po vytvoření enumerátoru.

NotSupportedException

Enumerátor nepodporuje resetování.

Příklady

Následující příklad kódu ukazuje implementaci IEnumerator rozhraní pro vlastní kolekci. V tomto příkladu Reset není explicitně volána, ale je implementována pro podporu použití foreach (for each v jazyce Visual Basic). Tento příklad kódu je součástí většího příkladu IEnumerator pro rozhraní.

// 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

Poznámky

Pokud jsou v kolekci provedeny změny, například přidání, úprava nebo odstranění prvků, chování objektu Reset není definováno.

Metoda Reset je poskytována pro interoperabilitu modelu COM. Nemusí být nutně implementována; místo toho může implementátor jednoduše hodit NotSupportedException.

Poznámky pro implementátory

Všechna volání Reset() musí mít za následek stejný stav pro enumerátor. Upřednostňovanou implementací je přesunutí enumerátoru na začátek kolekce před první prvek. To zruší platnost enumerátoru, pokud byla kolekce změněna od vytvoření enumerátoru, což je konzistentní s MoveNext() a Current.

Platí pro

Viz také