Export (0) Print
Expand All

Dictionary(TKey, TValue).IDictionary.GetEnumerator Method

Returns an IDictionaryEnumerator for the IDictionary.

Namespace:  System.Collections.Generic
Assembly:  mscorlib (in mscorlib.dll)

private abstract GetEnumerator : unit -> IDictionaryEnumerator  
private override GetEnumerator : unit -> IDictionaryEnumerator

Implements

IDictionary.GetEnumerator()

For purposes of enumeration, each item is a KeyValuePair(TKey, TValue) structure representing a value and its key.

The foreach statement of the C# language (for each in C++, For Each in Visual Basic) hides the complexity of enumerators. 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. The Reset method also brings the enumerator back to this position. At this position, the Entry property is undefined. Therefore, you must call the MoveNext method to advance the enumerator to the first element of the collection before reading the value of Entry.

The Entry property returns the same element until either the MoveNext or Reset method is called. MoveNext sets Entry to the next element.

If MoveNext passes the end of the collection, the enumerator is positioned after the last element in the collection and MoveNext returns false. When the enumerator is at this position, subsequent calls to MoveNext also return false. If the last call to MoveNext returned false, Entry is undefined. 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. If changes are made to the collection, such as adding, modifying, or deleting elements, the enumerator is irrecoverably invalidated and its behavior is undefined.

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.

Default implementations of collections in the System.Collections.Generic namespace are not synchronized.

This method is an O(1) operation.

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. In particular, note that the enumerator for the System.Collections.IDictionary interface returns DictionaryEntry objects rather than KeyValuePair(TKey, TValue) objects.

The code example is part of a larger example, including output, provided for the IDictionary.Add method.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft