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

定义

 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注意的是,接口的枚举器会DictionaryEntry返回对象而KeyValuePair<TKey,TValue>不是对象。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#for each语句( C++在VisualBasic中)隐藏了枚举器的复杂性。For Each foreachThe 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.

最初,枚举数定位在集合中第一个元素的前面。Initially, the enumerator is positioned before the first element in the collection. Reset方法还将枚举器恢复到此位置。The Reset method also brings the enumerator back to this position. 在此位置上,未定义 EntryAt this position, Entry is undefined. 因此,在读取的MoveNext Entry值之前,必须调用方法,以将枚举器前进到集合的第一个元素。Therefore, you must call the MoveNext method to advance the enumerator to the first element of the collection before reading the value of Entry.

Entry调用MoveNext或方法之前,属性将返回相同的元素。ResetThe Entry property returns the same element until either the MoveNext or Reset method is called. MoveNextEntry 设置为下一个元素。MoveNext sets Entry to the next element.

如果MoveNext越过集合的末尾,则枚举器将定位在集合中最后一个元素之后,并MoveNext返回falseIf MoveNext passes the end of the collection, the enumerator is positioned after the last element in the collection and MoveNext returns false. 当枚举器位于此位置时,对MoveNext的后续调用也将返回。 falseWhen the enumerator is at this position, subsequent calls to MoveNext also return false. 如果最后一次调用MoveNext返回falseEntry则未定义。If the last call to MoveNext returned false, Entry is undefined. 若要再次将 Entry 设置为集合的第一个元素,可以调用 Reset 并接着调用 MoveNextTo 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. 如果对集合所做的更改(如添加、修改或删除元素),则枚举器将失效且不可恢复,并且对MoveNextReset的下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.

适用于

另请参阅