Partager via

Collection.GetEnumerator, méthode

  • Article

Récupère une référence à un objet d'énumérateur, qui est utilisée pour parcourir Collection, objet (Visual Basic).

Espace de noms : Microsoft.VisualBasic
Assembly : Microsoft.VisualBasic (dans microsoft.visualbasic.dll)

Syntaxe

'Déclaration
Public Function GetEnumerator As IEnumerator
'Utilisation
Dim instance As Collection
Dim returnValue As IEnumerator

returnValue = instance.GetEnumerator

public IEnumerator GetEnumerator ()

public:
IEnumerator^ GetEnumerator ()

public IEnumerator GetEnumerator ()

public function GetEnumerator () : IEnumerator

Valeur de retour

Récupère une référence à un objet d'énumérateur, qui est utilisée pour parcourir Collection, objet (Visual Basic).

Notes

Pour plus d'informations, consultez la rubrique Visual Basic GetEnumerator, méthode (objet Collection).

L'instruction For Each...Next, instruction (Visual Basic) appelle GetEnumerator pour obtenir un objet énumérateur destiné à prendre en charge l'itération sur les éléments d'une collection. Normalement, vous utilisez une boucle For Each...Next pour parcourir une collection ou un tableau et vous n'avez pas besoin d'appeler GetEnumerator explicitement.

Si vous avez besoin d'un contrôle plus rapproché de l'itération que celui que les instructions For Each... Next fournissent, vous pouvez utiliser la méthode GetEnumerator pour effectuer un parcours personnalisé. Il peut s'avérer nécessaire de procéder ainsi dans les cas suivants.

  • Vous pouvez souhaiter retourner au début de la collection et redémarrer l'itération avant qu'elle soit finie.

  • Vous pouvez souhaiter ignorer un ou plusieurs éléments pour diverses raisons.

  • Vous pouvez avoir besoin de modifier les éléments de la collection au milieu d'un parcours. Dans ce cas, vous devez obtenir un nouvel objet énumérateur, parce que le précédent est invalidé.

Exemple

L'exemple suivant indique comment utiliser GetEnumerator pour récupérer tous les éléments d'un objet Collection.

Dim customers As New Collection
' Insert code to add elements to the customers collection.
Dim custEnum As IEnumerator = customers.GetEnumerator()
custEnum.Reset()
Dim thisCustomer As Object
While custEnum.MoveNext()
    thisCustomer = custEnum.Current()
    ' Insert code to process this element of the collection.
End While

GetEnumerator construit et retourne un objet énumérateur, qui implémente l'interface IEnumerator de l'espace de noms System.Collections. L'objet énumérateur expose la propriété Current et les méthodes MoveNext et Reset. Pour plus d'informations, consultez For Each...Next, instruction (Visual Basic).

Plates-formes

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile pour Pocket PC, Windows Mobile pour Smartphone, Windows Server 2003, Windows XP Édition Media Center, Windows XP Professionnel Édition x64, Windows XP SP2, Windows XP Starter Edition

Le .NET Framework ne prend pas en charge toutes les versions de chaque plate-forme. Pour obtenir la liste des versions prises en charge, consultez Configuration requise.

Informations de version

.NET Framework

Prise en charge dans : 2.0, 1.1, 1.0

.NET Compact Framework

Prise en charge dans : 2.0, 1.0

Voir aussi

Référence

Collection, classe
Membres Collection
Microsoft.VisualBasic, espace de noms

Autres ressources

GetEnumerator, méthode (objet Collection)
Collection, objet (Visual Basic)