IEnumerable.GetEnumerator 方法

定义

命名空间:

System.Collections

程序集:

System.Runtime.dll

返回循环访问集合的枚举数。

C#

public System.Collections.IEnumerator GetEnumerator ();

返回

IEnumerator

一个可用于循环访问集合的 IEnumerator 对象。

示例

下面的代码示例演示自定义集合接口 IEnumerable 的实现。 在此示例中， GetEnumerator 未显式调用 ，但实现它以支持在 Visual Basic) 中使用 foreach (For Each 。 此代码示例是 接口的较大示例的 IEnumerable 一部分。

C#

using System;
using System.Collections;

// Simple business object.
public class Person
{
    public Person(string fName, string lName)
    {
        this.firstName = fName;
        this.lastName = lName;
    }

    public string firstName;
    public string lastName;
}

// Collection of Person objects. This class
// implements IEnumerable so that it can be used
// with ForEach syntax.
public class People : IEnumerable
{
    private Person[] _people;
    public People(Person[] pArray)
    {
        _people = new Person[pArray.Length];

        for (int i = 0; i < pArray.Length; i++)
        {
            _people[i] = pArray[i];
        }
    }

// Implementation for the GetEnumerator method.
    IEnumerator IEnumerable.GetEnumerator()
    {
       return (IEnumerator) GetEnumerator();
    }

    public PeopleEnum GetEnumerator()
    {
        return new PeopleEnum(_people);
    }
}

// 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();
            }
        }
    }
}

class App
{
    static void Main()
    {
        Person[] peopleArray = new Person[3]
        {
            new Person("John", "Smith"),
            new Person("Jim", "Johnson"),
            new Person("Sue", "Rabon"),
        };

        People peopleList = new People(peopleArray);
        foreach (Person p in peopleList)
            Console.WriteLine(p.firstName + " " + p.lastName);
    }
}

/* This code produces output similar to the following:
 *
 * John Smith
 * Jim Johnson
 * Sue Rabon
 *
 */

注解

C# 语言的 foreach 语句（在 Visual Basic 中为 For Each）隐藏了枚举数的复杂性。 因此，建议使用 foreach，而不是直接操作枚举数。

枚举器可用于读取集合中的数据，但不能用于修改基础集合。

最初，枚举数定位在集合中第一个元素的前面。 方法 Reset 还会将枚举器带回此位置。 在此位置， Current 属性未定义。 因此，在读取 的值Current之前，必须调用 MoveNext 方法以将枚举器推进到集合的第一个元素。

在调用 Current 或 MoveNext 之前，Reset 返回同一对象。 MoveNext 将 Current 设置为下一个元素。

如果 MoveNext 传递集合的末尾，则枚举器位于集合中的最后一个元素之后，并 MoveNext 返回 false。 当枚举器位于此位置时，对 MoveNext 的后续调用也会返回 false。 如果最后一次调用 MoveNext 返回 false， Current 则为未定义。 若要再次将 Current 设置为集合的第一个元素，可以调用 Reset 并接着调用 MoveNext。

如果对集合进行了更改（例如添加、修改或删除元素），则枚举器的行为是未定义的。

枚举数没有对集合的独占访问权；因此，从头到尾对一个集合进行枚举在本质上不是一个线程安全的过程。 若要确保枚举过程中的线程安全性，可以在整个枚举过程中锁定集合。 若要允许多个线程访问集合以进行读写操作，则必须实现自己的同步。

适用于

另请参阅

• IEnumerator
• 迭代器 (C#)
• 迭代器 (Visual Basic)