Dictionary<TKey,TValue>.GetEnumerator 方法

定義

命名空間:

System.Collections.Generic

組件:

System.Collections.dll

來源:

Dictionary.cs

傳回在 Dictionary<TKey,TValue> 中逐一查看的列舉值。

public:
 System::Collections::Generic::Dictionary<TKey, TValue>::Enumerator GetEnumerator();

public System.Collections.Generic.Dictionary<TKey,TValue>.Enumerator GetEnumerator ();

member this.GetEnumerator : unit -> System.Collections.Generic.Dictionary<'Key, 'Value>.Enumerator

Public Function GetEnumerator () As Dictionary(Of TKey, TValue).Enumerator

傳回

Dictionary<TKey,TValue>.Enumerator

Dictionary<TKey,TValue> 的 Dictionary<TKey,TValue>.Enumerator 結構。

備註

為了列舉的目的，每個專案都是 KeyValuePair<TKey,TValue> 表示值及其索引鍵的結構。

foreach C++ 中 C# 語言 (for each 的語句，For Each在 Visual Basic 中) 會隱藏列舉值的複雜度。 因此，建議您使用 foreach，而不要直接使用列舉值。

列舉程式可以用來讀取集合中的資料，但是無法用來修改基礎集合。

一開始，列舉程式位在集合中的第一個項目之前。 在這個位置上，Current 並未定義。 您必須先呼叫 MoveNext 方法，將列舉值前移至集合的第一個專案，才能讀取的值 Current。

屬性 Current 會傳回相同的專案，直到 MoveNext 呼叫 方法為止。 MoveNext 會將 Current 設定為下一個項目。

如果 MoveNext 傳遞集合結尾，列舉值會放在集合的最後一個專案後面，並 MoveNext 傳 false回 。 當列舉值位於這個位置時，後續呼叫 MoveNext 也會傳回 false。 如果最後一 MoveNext 次呼叫傳 false回 ， Current 則為未定義。 您不能再次將 Current 設定為集合的第一個項目；您必須建立新的列舉值執行個體。

只要集合維持不變，列舉值就仍維持有效。 如果對集合進行變更，例如加入項目或變更容量，列舉值就會無法復原，而下一次呼叫 MoveNext 或 IEnumerator.Reset 會擲回 InvalidOperationException。

僅限 .NET Core 3.0+ ：唯一不會使列舉值失效的變動方法為 Remove 和 Clear。

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

System.Collections.Generic 命名空間中集合的預設實作未同步處理。

這個方法是 O (1) 作業。

另請參閱

• Dictionary<TKey,TValue>.Enumerator
• IEnumerator<T>