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 屬性是未定義的。 因此，您必須先呼叫 MoveNext 方法，將列舉值前移至集合的第一個專案，然後再讀取 的值 Current。

Current 會傳回相同的物件直到呼叫 MoveNext 或 Reset。 MoveNext 會將 Current 設定為下一個項目。

如果 MoveNext 傳遞集合結尾，列舉值會放在集合的最後一個專案後面，並 MoveNext 傳 false回 。 當列舉值位於這個位置時，後續呼叫 MoveNext 也會傳回 false。 如果最後一次呼叫傳MoveNextfalse回 ，Current則為未定義。 若要再次將 Current 設定為集合的第一個元素，您可以在呼叫 Reset 之後，接著呼叫 MoveNext。

如果對集合進行變更，例如新增、修改或刪除專案，則列舉值的行為是未定義的。

列舉程式沒有集合的獨佔存取權，因此，列舉集合內容本質上並不是安全的執行緒程序。 若要確保列舉期間的執行緒安全性，您可以在整個列舉期間鎖定集合。 若要讓多重執行緒能夠存取集合以便進行讀取和寫入，您必須實作自己的同步處理。

適用於

另請參閱

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