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 未显式调用 ，但实现它以支持在 Visual Basic) 中使用 foreach (for each 。 此代码示例是 接口的更大示例的 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