Dictionary<TKey,TValue>.IDictionary.GetEnumerator Dictionary<TKey,TValue>.IDictionary.GetEnumerator Dictionary<TKey,TValue>.IDictionary.GetEnumerator Method

定義

IDictionaryEnumeratorIDictionaryを返します。Returns an IDictionaryEnumerator for the IDictionary.

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

戻り値

実装

次のコード例では、列挙子の使用を非foreach表示にするステートメント (For Each Visual Basic for eachではC++) を使用して、ディクショナリ内のキーと値のペアを列挙する方法を示します。The following code example shows how to enumerate the key/value pairs in the dictionary by using the foreach statement (For Each in Visual Basic, for each in C++), which hides the use of the enumerator. 特に、 System.Collections.IDictionaryインターフェイスの列挙子はKeyValuePair<TKey,TValue>オブジェクトではDictionaryEntryなくオブジェクトを返すことに注意してください。In particular, note that the enumerator for the System.Collections.IDictionary interface returns DictionaryEntry objects rather than KeyValuePair<TKey,TValue> objects.

このコード例は、 IDictionary.Addメソッドに指定された出力を含む、より大きな例の一部です。The code example is part of a larger example, including output, provided for the IDictionary.Add method.

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

注釈

列挙型の場合、各項目はDictionaryEntry構造体です。For purposes of enumeration, each item is a DictionaryEntry structure.

C#言語foreachのステートメントfor each (でC++は、 For Each Visual Basic) は、列挙子の複雑さを隠蔽します。The foreach statement of the C# language (for each in C++, For Each in Visual Basic) hides the complexity of enumerators. したがって、列挙子を直接操作するのではなく、foreach を使用することをお勧めします。Therefore, using foreach is recommended, instead of directly manipulating the enumerator.

列挙子を使用すると、コレクション内のデータを読み取ることができますが、基になるコレクションを変更することはできません。Enumerators can be used to read the data in the collection, but they cannot be used to modify the underlying collection.

最初に、列挙子はコレクション内の 1 番目の要素の前に位置付けられます。Initially, the enumerator is positioned before the first element in the collection. Reset メソッドは、この位置に列挙子を戻します。The Reset method also brings the enumerator back to this position. この位置では、Entry は未定義です。At this position, Entry is undefined. そのため、Entry の値を読み取る前に、MoveNext メソッドを呼び出し、列挙子をコレクションの最初の要素に進める必要があります。Therefore, you must call the MoveNext method to advance the enumerator to the first element of the collection before reading the value of Entry.

プロパティは、メソッドMoveNextまたはResetメソッドが呼び出されるまで、同じ要素を返します。 EntryThe Entry property returns the same element until either the MoveNext or Reset method is called. MoveNext は、Entry を次の要素に設定します。MoveNext sets Entry to the next element.

MoveNext がコレクションの末尾を通過した場合、列挙子がコレクション内の最後の要素の後に配置され、MoveNextfalse を返します。If MoveNext passes the end of the collection, the enumerator is positioned after the last element in the collection and MoveNext returns false. 列挙子がこの位置にある場合、後続の MoveNext 呼び出しも false を返します。When the enumerator is at this position, subsequent calls to MoveNext also return false. の最後の呼び出しMoveNextが返さfalseれた場合、 Entryが未定義になります。If the last call to MoveNext returned false, Entry is undefined. Entry をコレクションの最初の要素にもう一度設定するには、Reset を呼び出してから MoveNext を呼び出します。To set Entry to the first element of the collection again, you can call Reset followed by MoveNext.

コレクションが変更されない限り、列挙子は有効です。An enumerator remains valid as long as the collection remains unchanged. 要素の追加、変更、削除などの変更がコレクションに対して行われた場合、列挙子はなりにMoveNext無効化され、次のまたはResetの呼び出しでがスロー InvalidOperationExceptionされます。If changes are made to the collection, such as adding, modifying, or deleting elements, the enumerator is irrecoverably invalidated and the next call to MoveNext or Reset throws an InvalidOperationException.

列挙子にはコレクションへの排他アクセス権限はないため、コレクションの列挙処理は本質的にスレッド セーフな処理ではありません。The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. 列挙処理でスレッド セーフを確保するために、列挙処理が終わるまでコレクションをロックできます。To guarantee thread safety during enumeration, you can lock the collection during the entire enumeration. コレクションに対し複数のスレッドがアクセスして読み取りや書き込みを行うことができるようにするには、独自に同期化を実装する必要があります。To allow the collection to be accessed by multiple threads for reading and writing, you must implement your own synchronization.

System.Collections.Generic 名前空間のコレクションの既定の実装は同期されません。Default implementations of collections in the System.Collections.Generic namespace are not synchronized.

このメソッドは、O(1) 操作です。This method is an O(1) operation.

適用対象

こちらもご覧ください