IEnumerator.Reset Método

  • Referencia

Definición

Espacio de nombres:
System.Collections
Ensamblado:
System.Runtime.dll
Ensamblado:
mscorlib.dll
Ensamblado:
netstandard.dll

Establece el enumerador en su posición inicial (antes del primer elemento de la colección).

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

Excepciones

InvalidOperationException

La colección se modificó después de que el enumerador se creara.

NotSupportedException

El enumerador no admite el restablecimiento.

Ejemplos

En el ejemplo de código siguiente se muestra la implementación de las IEnumerator interfaces de una colección personalizada. En este ejemplo, Reset no se llama explícitamente, pero se implementa para admitir el uso de foreach (for each en Visual Basic). Este ejemplo de código forma parte de un ejemplo más grande para la IEnumerator interfaz .

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

El Reset método se proporciona para la interoperabilidad COM. No es necesario implementar necesariamente; en su lugar, el implementador simplemente puede iniciar un NotSupportedException.

Notas a los implementadores

Todas las llamadas a Reset() deben dar como resultado el mismo estado para el enumerador. La implementación preferida es mover el enumerador al principio de la colección, antes del primer elemento. Esto invalida el enumerador si la colección se ha modificado desde que se creó el enumerador, que es coherente con MoveNext() y Current.

Se aplica a

Consulte también