Dictionary(TKey, TValue).IEnumerable(KeyValuePair(TKey, TValue)).GetEnumerator Method (System.Collections.Generic)

IEnumerable(KeyValuePair(TKey, TValue)).GetEnum...

.NET Framework Class Library

Dictionary<(Of <(TKey, TValue>)>)..::.IEnumerable<(Of <(KeyValuePair<(Of <(TKey, TValue>)>)>)>)..::.GetEnumerator Method

Returns an enumerator that iterates through the collection.

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

Syntax

Visual Basic (Declaration)

Private Function GetEnumerator As IEnumerator(Of KeyValuePair(Of TKey, TValue))
    Implements IEnumerable(Of KeyValuePair(Of TKey, TValue)).GetEnumerator

Visual Basic (Usage)

Dim instance As Dictionary
Dim returnValue As IEnumerator(Of KeyValuePair(Of TKey, TValue))

returnValue = CType(instance, IEnumerable(Of KeyValuePair(Of TKey, TValue))).GetEnumerator()

IEnumerator<KeyValuePair<TKey, TValue>> IEnumerable<KeyValuePair<TKey, TValue>>.GetEnumerator()

Visual C++

private:
virtual IEnumerator<KeyValuePair<TKey, TValue>>^ GetEnumerator() sealed = IEnumerable<KeyValuePair<TKey, TValue>>::GetEnumerator

J# supports the use of explicit interface implementations, but not the declaration of new ones.

JScript

JScript does not support explicit interface implementations.

Return Value

Type: System.Collections.Generic..::.IEnumerator<(Of <(KeyValuePair<(Of <(TKey, TValue>)>)>)>)

An IEnumerator<(Of <(T>)>) that can be used to iterate through the collection.

Implements

IEnumerable<(Of <(T>)>)..::.GetEnumerator()()()

Remarks

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

The foreach statement of the C# language (for each in C++, For Each 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, the Current 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 Current.

Note:
For better performance, the enumerator returned by this property does not throw an exception if it is positioned before the first element or after the last element and the Current property is accessed; the value of the Current property is undefined.

The Current property returns the same element until the MoveNext method 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 the System.Collections.Generic namespace are not synchronized.

This method is an O(1) operation.

Platforms

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.

Version Information

.NET Framework

Supported in: 3.5, 3.0 SP1, 3.0, 2.0 SP1, 2.0

.NET Compact Framework

Supported in: 3.5, 2.0

XNA Framework

Supported in: 1.0

Reference

Dictionary<(Of <(TKey, TValue>)>) Class

Dictionary<(Of <(TKey, TValue>)>) Members

System.Collections.Generic Namespace

GetEnumerator

IEnumerator<(Of <(T>)>)

IEnumerator