Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

IDictionaryEnumerator Interface

Enumerates the elements of a nongeneric dictionary.

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

[<ComVisibleAttribute(true)>]
type IDictionaryEnumerator =  
    interface 
        interface IEnumerator 
    end

The IDictionaryEnumerator type exposes the following members.

  NameDescription
Public propertySupported by the XNA FrameworkSupported by Portable Class LibraryCurrentGets the current element in the collection. (Inherited from IEnumerator.)
Public propertySupported by the XNA FrameworkSupported by Portable Class LibraryEntryGets both the key and the value of the current dictionary entry.
Public propertySupported by the XNA FrameworkSupported by Portable Class LibraryKeyGets the key of the current dictionary entry.
Public propertySupported by the XNA FrameworkSupported by Portable Class LibraryValueGets the value of the current dictionary entry.
Top

  NameDescription
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryMoveNextAdvances the enumerator to the next element of the collection. (Inherited from IEnumerator.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryResetSets the enumerator to its initial position, which is before the first element in the collection. (Inherited from IEnumerator.)
Top

[Visual Basic, C#]

The foreach statement of the C# language (for each in Visual Basic) hides the complexity of the 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, calling the Current property throws an exception. Therefore, you must call the MoveNext method to advance the enumerator to the first element of the collection before reading the value of Current.

Current returns the same object until either MoveNext or Reset is called. MoveNext sets Current 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, calling Current throws an exception. To set Current 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 the next call to MoveNext or Reset throws an InvalidOperationException. If the collection is modified between MoveNext and Current, Current returns the element that it is set to, even if the enumerator is already invalidated.

The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads can still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads.

Notes to Implementers

The Current property that is inherited from IEnumerator returns an Object that is a boxed DictionaryEntry, similar to the return value of the Entry property.

This code example shows how to define a dictionary enumerator that implements the IDictionaryEnumerator interface.

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

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

XNA Framework

Supported in: 3.0, 2.0, 1.0

Portable Class Library

Supported in: Portable Class Library

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8
Show:
© 2015 Microsoft