Export (0) Print
Expand All

Dictionary<TKey, TValue>.Enumerator Structure

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

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

public struct Enumerator : IEnumerator<KeyValuePair<TKey, TValue>>, 
	IEnumerator, IDisposable, IDictionaryEnumerator

The Dictionary<TKey, TValue>.Enumerator generic type exposes the following members.

  NameDescription
Public propertySupported by the XNA FrameworkSupported by Portable Class LibraryCurrentGets the element at the current position of the enumerator.
Top

  NameDescription
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryDisposeReleases all resources used by the Dictionary<TKey, TValue>.Enumerator.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryEqualsIndicates whether this instance and a specified object are equal. (Inherited from ValueType.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryGetHashCodeReturns the hash code for this instance. (Inherited from ValueType.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryMoveNextAdvances the enumerator to the next element of the Dictionary<TKey, TValue>.
Public methodSupported by the XNA FrameworkToStringReturns the fully qualified type name of this instance. (Inherited from ValueType.)

In XNA Framework 3.0, this member is inherited from Object.ToString().
Top

  NameDescription
Explicit interface implemetationPrivate propertySupported by the XNA FrameworkSupported by Portable Class LibraryIDictionaryEnumerator.EntryGets the element at the current position of the enumerator.
Explicit interface implemetationPrivate propertySupported by the XNA FrameworkSupported by Portable Class LibraryIDictionaryEnumerator.KeyGets the key of the element at the current position of the enumerator.
Explicit interface implemetationPrivate propertySupported by the XNA FrameworkSupported by Portable Class LibraryIDictionaryEnumerator.ValueGets the value of the element at the current position of the enumerator.
Explicit interface implemetationPrivate propertySupported by the XNA FrameworkSupported by Portable Class LibraryIEnumerator.CurrentGets the element at the current position of the enumerator.
Explicit interface implemetationPrivate methodSupported by the XNA FrameworkSupported by Portable Class LibraryIEnumerator.ResetSets the enumerator to its initial position, which is before the first element in the collection.
Top

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.

.NET Framework

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

.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

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