IEnumerator.Reset Método

Definição

Namespace:

System.Collections

Assembly:

System.Runtime.dll

Define o enumerador com sua posição inicial, que é antes do primeiro elemento da coleção.

public:
 void Reset();

public void Reset ();

abstract member Reset : unit -> unit

Public Sub Reset ()

Exceções

InvalidOperationException

A coleção foi modificada depois da criação do enumerador.

NotSupportedException

O enumerador não dá suporte à redefinição.

Exemplos

O exemplo de código a seguir demonstra a implementação das IEnumerator interfaces para uma coleção personalizada. Neste exemplo, Reset não é chamado explicitamente, mas é implementado para dar suporte ao uso de foreach (for each no Visual Basic). Este exemplo de código faz parte de um exemplo maior para a 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

Comentários

Se forem feitas alterações na coleção, como adicionar, modificar ou excluir elementos, o comportamento de Reset será indefinido.

O Reset método é fornecido para interoperabilidade COM. Ela não precisa necessariamente ser implementada; Em vez disso, o implementador pode simplesmente lançar um NotSupportedException.

Notas aos Implementadores

Todas as chamadas para Reset() devem resultar no mesmo estado para o enumerador. A implementação preferencial é mover o enumerador para o início da coleção, antes do primeiro elemento. Isso invalida o enumerador se a coleção tiver sido modificada desde que o enumerador foi criado, o que é consistente com MoveNext() e Current.

Confira também

• MoveNext()
• Current