Dictionary<TKey,TValue>.Enumerator Struktura

Definice

Obor názvů:

System.Collections.Generic

Sestavení:

System.Collections.dll

Zdroj:

Dictionary.cs

Vytvoří výčet prvků objektu Dictionary<TKey,TValue>.

public: value class Dictionary<TKey, TValue>::Enumerator : System::Collections::Generic::IEnumerator<System::Collections::Generic::KeyValuePair<TKey, TValue>>, System::Collections::IDictionaryEnumerator

public struct Dictionary<TKey,TValue>.Enumerator : System.Collections.Generic.IEnumerator<System.Collections.Generic.KeyValuePair<TKey,TValue>>, System.Collections.IDictionaryEnumerator

type Dictionary<'Key, 'Value>.Enumerator = struct
    interface IEnumerator<KeyValuePair<'Key, 'Value>>
    interface IEnumerator
    interface IDisposable
    interface IDictionaryEnumerator

Public Structure Dictionary(Of TKey, TValue).Enumerator
Implements IDictionaryEnumerator, IEnumerator(Of KeyValuePair(Of TKey, TValue))

Parametry typu

TKey

TValue

Dědičnost

Object

ValueType

Dictionary<TKey,TValue>.Enumerator

Implementuje

IEnumerator<KeyValuePair<TKey,TValue>> IDictionaryEnumerator IEnumerator IDisposable

Poznámky

Příkaz foreach jazyka C# (for each v jazyce C++, For Each v jazyce Visual Basic) skrývá složitost enumerátorů. Proto se doporučuje použít foreach místo přímé manipulace s enumerátorem.

Enumerátory lze používat ke čtení dat v kolekci, nikoli však k úpravě zdrojové kolekce.

Zpočátku je enumerátor umístěn před prvním prvkem v kolekci. Na této pozici Current není definován. Před čtením hodnoty Currentje nutné volat MoveNext pro přechod enumerátoru na první prvek kolekce.

Current vrátí stejný objekt, dokud MoveNext není volána. MoveNext nastaví Current na další prvek.

Pokud MoveNext projde konec kolekce, enumerátor se umístí za poslední prvek v kolekci a MoveNext vrátí false. Když je enumerátor na této pozici, následné volání také MoveNext vrátí false. Pokud je poslední volání MoveNext vráceno false, Current není definováno. Nelze znovu nastavit Current na první prvek kolekce; místo toho musíte vytvořit novou instanci enumeratoru.

Enumerátor zůstane platný, dokud kolekce zůstane beze změny. Pokud jsou provedeny změny kolekce, například přidání prvků nebo změna kapacity, je výčet nenávratně zneplatněný a další volání MoveNext nebo IEnumerator.Reset vyvolá InvalidOperationException.

Pouze .NET Core 3.0+: Jediné metody mutace, které neaktivují výčty, jsou Remove a Clear.

Enumerátor nemá výhradní přístup ke kolekci; proto výčet prostřednictvím kolekce není vnitřně procedurou bezpečnou pro přístup z více vláken. Chcete-li zajistit bezpečnost vláken během výčtu, můžete uzamknout kolekci během celého výčtu. Chcete-li více vláknům umožnit přístup ke kolekci pro čtení a zápis, musíte implementovat svou vlastní synchronizaci.

Výchozí implementace kolekcí v nástroji System.Collections.Generic se nesynchronují.

Vlastnosti

Current

Získá prvek na aktuální pozici enumerátoru.

Metody

Dispose()	Uvolní všechny prostředky používané nástrojem Dictionary<TKey,TValue>.Enumerator.
MoveNext()	Posune enumerátor na další prvek objektu Dictionary<TKey,TValue>.

Explicitní implementace rozhraní

IDictionaryEnumerator.Entry	Získá prvek na aktuální pozici enumerátoru.
IDictionaryEnumerator.Key	Získá klíč prvku na aktuální pozici enumerátoru.
IDictionaryEnumerator.Value	Získá hodnotu prvku na aktuální pozici enumerátoru.
IEnumerator.Current	Získá prvek na aktuální pozici enumerátoru.
IEnumerator.Reset()	Nastaví enumerátor na jeho počáteční pozici, která je před prvním prvkem v kolekci.

Viz také

• Dictionary<TKey,TValue>.KeyCollection.Enumerator
• Dictionary<TKey,TValue>.ValueCollection.Enumerator
• IEnumerable<T>
• IEnumerator<T>