IEnumerator.Reset IEnumerator.Reset IEnumerator.Reset IEnumerator.Reset Method

Definición

Establece el enumerador en su posición inicial (antes del primer elemento de la colección).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 ()

Excepciones

La colección se modificó después de que el enumerador se creara.The collection was modified after the enumerator was created.

Ejemplos

En el ejemplo de código siguiente se muestra la IEnumerator implementación de las interfaces para una colección personalizada.The following code example demonstrates the implementation of the IEnumerator interfaces for a custom collection. En este ejemplo, Reset no se llama explícitamente, pero se implementa para admitir el uso de foreach (for each en 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). Este ejemplo de código forma parte de un ejemplo más grande IEnumerator de la interfaz.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

Comentarios

Si se realizan cambios en la colección, como agregar, modificar o eliminar elementos, el comportamiento de Reset no está definido.If changes are made to the collection, such as adding, modifying, or deleting elements, the behavior of Reset is undefined.

El Reset método se proporciona para la interoperabilidad com.The Reset method is provided for COM interoperability. No es necesario que se implemente necesariamente; en su lugar, el implementador simplemente puede producir NotSupportedExceptionuna excepción.It does not necessarily need to be implemented; instead, the implementer can simply throw a NotSupportedException.

Notas a los implementadores

Todas las llamadas Reset() a deben tener como resultado el mismo estado para el enumerador.All calls to Reset() must result in the same state for the enumerator. La implementación preferida es trasladar el enumerador al principio de la colección, antes del primer elemento.The preferred implementation is to move the enumerator to the beginning of the collection, before the first element. Esto invalida el enumerador si la colección se ha modificado desde que se creó el enumerador, que es coherente MoveNext() con Currenty.This invalidates the enumerator if the collection has been modified since the enumerator was created, which is consistent with MoveNext() and Current.

Se aplica a

Consulte también: