Collection.GetEnumerator Método

Definição

Namespace:

Microsoft.VisualBasic

Assembly:

Microsoft.VisualBasic.Core.dll

Origem:

Collection.vb

Retorna um enumerador que itera pela coleção.

public:
 System::Collections::IEnumerator ^ GetEnumerator();

public System.Collections.IEnumerator GetEnumerator ();

member this.GetEnumerator : unit -> System.Collections.IEnumerator

Public Function GetEnumerator () As IEnumerator

Retornos

IEnumerator

Um enumerador que pode ser usado para iterar pela coleção.

Exemplos

O exemplo a seguir mostra como usar GetEnumerator para recuperar todos os elementos de um Collection objeto .

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 constrói e retorna um objeto enumerador, que implementa a IEnumerator interface do System.Collections namespace. O objeto enumerador expõe a Current propriedade e os MoveNext métodos e Reset . Para obter mais informações, consulte Instrução For Each...Next.

Comentários

O para cada... Next Statement chama GetEnumerator para obter um objeto enumerador para dar suporte à iteração sobre os elementos de uma coleção. Normalmente, você usa um For Eachloop ...Next para percorrer uma coleção ou matriz e não precisa chamar GetEnumerator explicitamente.

Se você precisar de um controle mais próximo sobre a iteração do que as For Eachinstruções ...Next fornecem, poderá usar o GetEnumerator método para executar uma passagem personalizada. Veja a seguir alguns casos em que talvez seja necessário fazer isso.

• Talvez você queira retornar ao início da coleção e iniciar a iteração novamente antes que ela seja concluída.

• Talvez você queira ignorar um ou mais elementos por vários motivos.

• Talvez seja necessário alterar os elementos da coleção no meio de uma passagem. Nesse caso, você deve obter um novo objeto enumerador porque o anterior é invalidado.