Dictionary(TKey, TValue).ValueCollection.Enumerator Structure
Collapse the table of content
Expand the table of content

Dictionary<TKey, TValue>.ValueCollection.Enumerator Structure


Enumerates the elements of a Dictionary<TKey, TValue>.ValueCollection.

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

public struct Enumerator : IEnumerator<TValue>, IDisposable, 


Gets the element at the current position of the enumerator.


Releases all resources used by the Dictionary<TKey, TValue>.ValueCollection.Enumerator.


Indicates whether this instance and a specified object are equal.(Inherited from ValueType.)


Returns the hash code for this instance.(Inherited from ValueType.)


Gets the Type of the current instance.(Inherited from Object.)


Advances the enumerator to the next element of the Dictionary<TKey, TValue>.ValueCollection.


Returns the fully qualified type name of this instance.(Inherited from ValueType.)


Sets the enumerator to its initial position, which is before the first element in the collection.

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. At this position, Current is undefined. Therefore, you must call MoveNext to advance the enumerator to the first element of the collection before reading the value of Current.

Current returns the same object until MoveNext 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, Current is undefined. You cannot set Current to the first element of the collection again; you must create a new enumerator instance instead.

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 System.Collections.Generic are not synchronized.

Universal Windows Platform
Available since 4.5
.NET Framework
Available since 2.0
Portable Class Library
Supported in: portable .NET platforms
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
© 2015 Microsoft