IEnumerator.Reset Метод

Определение

Пространство имен:

System.Collections

Сборка:

System.Runtime.dll

Устанавливает перечислитель в его начальное положение, т. е. перед первым элементом коллекции.

public:
 void Reset();

public void Reset ();

abstract member Reset : unit -> unit

Public Sub Reset ()

Исключения

InvalidOperationException

После создания перечислителя семейство было изменено.

NotSupportedException

Перечислитель не поддерживает сброс.

Примеры

В следующем примере кода демонстрируется реализация IEnumerator интерфейсов для пользовательской коллекции. В этом примере Reset не вызывается явным образом, но реализуется для поддержки foreach использования (for each в Visual Basic). Этот пример кода является частью более крупного примера для 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

Комментарии

Если в коллекцию вносятся изменения, такие как добавление, изменение или удаление элементов, поведение Reset не определено.

Метод Reset предоставляется для com-взаимодействия. Он не обязательно должен быть реализован; Вместо этого реализующий объект может просто создать исключение NotSupportedException.

Примечания для тех, кто реализует этот метод

Все вызовы должны приводить к Reset() одному и тому же состоянию для перечислителя. Предпочтительной реализацией является перемещение перечислителя в начало коллекции перед первым элементом. Это делает перечислитель недействительным, если коллекция была изменена с момента создания перечислителя, что согласуется с MoveNext() и Current.

См. также раздел

• MoveNext()
• Current