Click to Rate and Give Feedback
This page is specific to
Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:
.NET Framework Class Library
Dictionary<(Of <(TKey, TValue>)>)..::.Enumerator Structure

Updated: November 2007

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

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

Visual Basic (Declaration)
<SerializableAttribute> _
Public Structure Enumerator _
    Implements IEnumerator(Of KeyValuePair(Of TKey, TValue)),  _
    IDisposable, IDictionaryEnumerator, IEnumerator
Visual Basic (Usage)
Dim instance As Dictionary.Enumerator
C#
[SerializableAttribute]
public struct Enumerator : IEnumerator<KeyValuePair<TKey, TValue>>, 
    IDisposable, IDictionaryEnumerator, IEnumerator
Visual C++
[SerializableAttribute]
public value class Enumerator : IEnumerator<KeyValuePair<TKey, TValue>>, 
    IDisposable, IDictionaryEnumerator, IEnumerator
J#
/** @attribute SerializableAttribute */ 
public final class Enumerator extends ValueType implements IEnumerator<KeyValuePair<TKey, TValue>>, 
    IDisposable, IDictionaryEnumerator, IEnumerator
JScript
JScript supports the use of structures, but not the declaration of new ones.

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.

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

Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360

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

.NET Framework

Supported in: 3.5, 3.0, 2.0

.NET Compact Framework

Supported in: 3.5, 2.0

XNA Framework

Supported in: 2.0, 1.0
Tags What's this?: Add a tag
Community Content   What is Community Content?
Add new content RSS  Annotations
Processing
© 2008 Microsoft Corporation. All rights reserved. Terms of Use  |  Trademarks  |  Privacy Statement
Page view tracker