Dictionary<TKey,TValue>.IDictionary.GetEnumerator Método

Definição

Namespace:

System.Collections.Generic

Assembly:

System.Collections.dll

Origem:

Dictionary.cs

Retorna um IDictionaryEnumerator para o IDictionary.

 virtual System::Collections::IDictionaryEnumerator ^ System.Collections.IDictionary.GetEnumerator() = System::Collections::IDictionary::GetEnumerator;

System.Collections.IDictionaryEnumerator IDictionary.GetEnumerator ();

abstract member System.Collections.IDictionary.GetEnumerator : unit -> System.Collections.IDictionaryEnumerator
override this.System.Collections.IDictionary.GetEnumerator : unit -> System.Collections.IDictionaryEnumerator

Function GetEnumerator () As IDictionaryEnumerator Implements IDictionary.GetEnumerator

Retornos

IDictionaryEnumerator

Um IDictionaryEnumerator para o IDictionary.

Implementações

GetEnumerator()

Exemplos

O exemplo de código a seguir mostra como enumerar os pares chave/valor no dicionário usando a foreach instrução (For Each no Visual Basic, for each em C++), que oculta o uso do enumerador. Em particular, observe que o enumerador para a System.Collections.IDictionary interface retorna DictionaryEntry objetos em vez de KeyValuePair<TKey,TValue> objetos.

O exemplo de código faz parte de um exemplo maior, inclusive saída, fornecido para o método IDictionary.Add.

using System;
using System.Collections;
using System.Collections.Generic;

public class Example
{
    public static void Main()
    {
        // Create a new dictionary of strings, with string keys,
        // and access it using the IDictionary interface.
        //
        IDictionary openWith = new Dictionary<string, string>();

        // Add some elements to the dictionary. There are no
        // duplicate keys, but some of the values are duplicates.
        // IDictionary.Add throws an exception if incorrect types
        // are supplied for key or value.
        openWith.Add("txt", "notepad.exe");
        openWith.Add("bmp", "paint.exe");
        openWith.Add("dib", "paint.exe");
        openWith.Add("rtf", "wordpad.exe");

Imports System.Collections
Imports System.Collections.Generic

Public Class Example
    
    Public Shared Sub Main() 

        ' Create a new dictionary of strings, with string keys,
        ' and access it using the IDictionary interface.
        '
        Dim openWith As IDictionary = _
            New Dictionary(Of String, String)
        
        ' Add some elements to the dictionary. There are no 
        ' duplicate keys, but some of the values are duplicates.
        ' IDictionary.Add throws an exception if incorrect types
        ' are supplied for key or value.
        openWith.Add("txt", "notepad.exe")
        openWith.Add("bmp", "paint.exe")
        openWith.Add("dib", "paint.exe")
        openWith.Add("rtf", "wordpad.exe")

// When you use foreach to enumerate dictionary elements
// with the IDictionary interface, the elements are retrieved
// as DictionaryEntry objects instead of KeyValuePair objects.
Console.WriteLine();
foreach( DictionaryEntry de in openWith )
{
    Console.WriteLine("Key = {0}, Value = {1}",
        de.Key, de.Value);
}

' When you use foreach to enumerate dictionary elements
' with the IDictionary interface, the elements are retrieved
' as DictionaryEntry objects instead of KeyValuePair objects.
Console.WriteLine()
For Each de As DictionaryEntry In openWith
    Console.WriteLine("Key = {0}, Value = {1}", _
        de.Key, de.Value)
Next

    }
}

    End Sub

End Class

Comentários

Para fins de enumeração, cada item é uma DictionaryEntry estrutura.

A instrução foreach da linguagem C# (for each em C++, For Each no Visual Basic) oculta a complexidade de enumeradores. Portanto, o uso de foreach é recomendado, em vez de manipular diretamente o enumerador.

Os enumeradores podem ser usados para ler os dados na coleção, mas não podem ser usados para modificar a coleção subjacente.

Inicialmente, o enumerador é posicionado antes do primeiro elemento da coleção. O método Reset também retorna o enumerador a essa posição. Nesta posição, Entry está indefinido. Por isso, você deve chamar o método MoveNext para avançar o enumerador até o primeiro elemento da coleção antes de ler o valor de Entry.

A Entry propriedade retorna o mesmo elemento até que o MoveNext método ou Reset seja chamado. MoveNext define Entry como o próximo elemento.

Caso MoveNext passe o final da coleção, o enumerador é posicionado após o último elemento na coleção e MoveNext retorna false. Quando o enumerador está nessa posição, as chamadas subsequentes para MoveNext também retornam false. Caso a última chamada para MoveNext tenha retornado false, Entry está indefinido. Para definir Entry como o primeiro elemento da coleção novamente, é possível chamar Reset seguido de MoveNext.

Um enumerador permanece válido desde que a coleção permaneça inalterada. Se forem feitas alterações na coleção, como adicionar elementos ou alterar a capacidade, o enumerador será invalidado irrecuperavelmente e a próxima chamada para MoveNext ou IEnumerator.Reset gerará um InvalidOperationException.

Somente .NET Core 3.0+: os únicos métodos de mutação que não invalidam enumeradores são Remove e Clear.

O enumerador não tem acesso exclusivo à coleção; por isso, a enumeração por meio de uma coleção não é um procedimento thread-safe intrínseco. Para garantir acesso thread-safe durante a enumeração, é possível bloquear a coleção durante toda a enumeração. Para permitir que a coleção seja acessada por vários threads para leitura e gravação, você deve implementar sua própria sincronização.

As implementações padrão de coleções no namespace System.Collections.Generic não são sincronizadas.

Este método é uma operação O(1).

Confira também

• IDictionaryEnumerator
• IEnumerator