IEnumerable.GetEnumerator IEnumerable.GetEnumerator IEnumerable.GetEnumerator IEnumerable.GetEnumerator Method


傳回逐一查看集合的列舉值。Returns an enumerator that iterates through a collection.

 System::Collections::IEnumerator ^ GetEnumerator();
public System.Collections.IEnumerator GetEnumerator ();
abstract member GetEnumerator : unit -> System.Collections.IEnumerator
Public Function GetEnumerator () As IEnumerator


IEnumerator 物件,可用於逐一查看集合。An IEnumerator object that can be used to iterate through the collection.


下列程式碼範例示範實作IEnumerable介面之自訂集合。The following code example demonstrates the implementation of the IEnumerable interfaces for a custom collection. 在此範例中,GetEnumerator不會明確呼叫,但它實作為支援使用foreach(For Each Visual Basic 中)。In this example, GetEnumerator is not explicitly called, but it is implemented to support the use of foreach (For Each in Visual Basic). 這個程式碼範例是針對較大範例的一部分IEnumerable介面。This code example is part of a larger example for the IEnumerable interface.

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()
        return (position < _people.Length);

    public void Reset()
        position = -1;

    object IEnumerator.Current
            return Current;

    public Person Current
                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
Imports System
Imports System.Collections

' Simple business object.
Public Class Person

    Public Sub New(ByVal fName As String, ByVal lName As String)
        Me.firstName = fName
        Me.lastName = lName
    End Sub

    Public firstName As String
    Public lastName As String
End Class

' Collection of Person objects, which implements IEnumerable so that
' it can be used with ForEach syntax.
Public Class People
    Implements IEnumerable

    Private _people() As Person

    Public Sub New(ByVal pArray() As Person)
        _people = New Person(pArray.Length - 1) {}

        Dim i As Integer
        For i = 0 To pArray.Length - 1
            _people(i) = pArray(i)
        Next i
    End Sub

    ' Implementation of GetEnumerator.
    Public Function GetEnumerator() As IEnumerator _
      Implements IEnumerable.GetEnumerator

        Return New PeopleEnum(_people)
    End Function

End Class

' 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
                Return _people(position)
            Catch ex As IndexOutOfRangeException
                Throw New InvalidOperationException()
            End Try
        End Get
    End Property
End Class

Class App
    Shared Sub Main()
        Dim peopleArray() As Person = { _
            New Person("John", "Smith"), _
            New Person("Jim", "Johnson"), _
            New Person("Sue", "Rabon")}

        Dim peopleList As New People(peopleArray)
        Dim p As Person
        For Each p In peopleList
            Console.WriteLine(p.firstName + " " + p.lastName)

    End Sub
End Class

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


C# 語言的 foreach 陳述式 (在 Visual Basic 中為 For Each) 會隱藏列舉值的複雜度。The foreach statement of the C# language (For Each in Visual Basic) hides the complexity of the enumerators. 因此,建議您使用 foreach,而不要直接使用列舉值。Therefore, using foreach is recommended, instead of directly manipulating the enumerator.

列舉程式可以用來讀取集合中的資料,但是無法用來修改基礎集合。Enumerators can be used to read the data in the collection, but they cannot be used to modify the underlying collection.

一開始,列舉程式位在集合中的第一個項目之前。Initially, the enumerator is positioned before the first element in the collection. Reset方法也會列舉值帶回至這個位置。The Reset method also brings the enumerator back to this position. 在這個位置,Current未定義屬性。At this position, the Current property is undefined. 因此,您必須呼叫MoveNext列舉值前進到第一個項目,再讀取的值集合的方法CurrentTherefore, you must call the MoveNext method to advance the enumerator to the first element of the collection before reading the value of Current.

Current 會傳回相同的物件直到呼叫 MoveNextResetCurrent returns the same object until either MoveNext or Reset is called. MoveNext 會將 Current 設定為下一個項目。MoveNext sets Current to the next element.

如果MoveNext集合,也就是列舉值的結尾是否位於集合中的最後一個元素之後的階段和MoveNext傳回falseIf MoveNext passes the end of the collection, the enumerator is positioned after the last element in the collection and MoveNext returns false. 列舉值位於此位置,後續呼叫MoveNext也會傳回falseWhen the enumerator is at this position, subsequent calls to MoveNext also return false. 如果上次呼叫MoveNext會傳回falseCurrent是未定義。If the last call to MoveNext returns false, Current is undefined. 若要再次將 Current 設定為集合的第一個元素,您可以在呼叫 Reset 之後,接著呼叫 MoveNextTo set Current to the first element of the collection again, you can call Reset followed by MoveNext.

如果變更的集合,例如加入、 修改或刪除元素,列舉值的行為是未定義。If changes are made to the collection, such as adding, modifying, or deleting elements, the behavior of the enumerator is undefined.

列舉程式沒有集合的獨佔存取權,因此,列舉集合內容本質上並不是安全的執行緒程序。The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. 若要確保列舉期間的執行緒安全性,您可以在整個列舉期間鎖定集合。To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. 若要讓多重執行緒能夠存取集合以便進行讀取和寫入,您必須實作自己的同步處理。To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization.