Dictionary<TKey,TValue>.GetEnumerator Méthode

Définition

Retourne un énumérateur qui itère au sein de 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

Retours

Structure Dictionary<TKey,TValue>.Enumerator pour l'objet Dictionary<TKey,TValue>.

Remarques

À des fins d’énumération, chaque élément est une KeyValuePair<TKey,TValue> structure représentant une valeur et sa clé.

L’instruction foreach du langage C# (for each en C++, For Each en Visual Basic) masque la complexité des énumérateurs. Il est donc recommandé d'utiliser foreach plutôt que de manipuler l'énumérateur directement.

Les énumérateurs peuvent être utilisés pour lire les données de la collection, mais ils ne permettent pas de modifier la collection sous-jacente.

Au départ, l'énumérateur est positionné avant le premier élément de la collection. À cette position, Current n'est pas défini. Vous devez appeler la MoveNext méthode pour avancer l’énumérateur vers le premier élément de la collection avant de lire la valeur de Current.

La Current propriété retourne le même élément jusqu’à ce que la MoveNext méthode soit appelée. MoveNext affecte l'élément suivant à Current.

Si MoveNext passe la fin de la collection, l’énumérateur est positionné après le dernier élément de la collection et MoveNext retourne false. Lorsque l’énumérateur se trouve à cette position, les appels suivants retournent MoveNextfalseégalement . Si le dernier appel à MoveNext retourné false, Current n’est pas défini. Vous ne pouvez pas attribuer de nouveau Current au premier élément de la collection ; vous devez créer une nouvelle instance de l’énumérateur à la place.

Un énumérateur reste valide aussi longtemps que la collection demeure inchangée. Si des modifications sont apportées à la collection, telles que l’ajout d’éléments ou la modification de la capacité, l’énumérateur est irrécupérablement invalidé et l’appel suivant à MoveNext ou IEnumerator.Reset lève un InvalidOperationException.

.NET Core 3.0+ uniquement : les seules méthodes de mutation qui n’invalident pas les énumérateurs sont Remove et Clear.

Comme l’énumérateur ne dispose pas d’un accès exclusif à la collection, l’énumération d’une collection n’est pas intrinsèquement une procédure thread-safe. Pour garantir la sécurité des threads pendant l'énumération, vous pouvez verrouiller la collection tout au long de cette opération. Pour permettre à plusieurs threads d’accéder en lecture et en écriture à la collection, vous devez implémenter votre propre synchronisation.

Les implémentations par défaut de collections dans l'espace de noms System.Collections.Generic ne sont pas synchronisées.

Cette méthode est une opération O(1).

S’applique à

Voir aussi