SortedDictionary<TKey,TValue>.Enumerator Struct

Definition

Namespace:

System.Collections.Generic

Assembly:

System.Collections.dll

Source:

SortedDictionary.cs

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

public: value class SortedDictionary<TKey, TValue>::Enumerator : System::Collections::Generic::IEnumerator<System::Collections::Generic::KeyValuePair<TKey, TValue>>, System::Collections::IDictionaryEnumerator

public struct SortedDictionary<TKey,TValue>.Enumerator : System.Collections.Generic.IEnumerator<System.Collections.Generic.KeyValuePair<TKey,TValue>>, System.Collections.IDictionaryEnumerator

type SortedDictionary<'Key, 'Value>.Enumerator = struct
    interface IEnumerator<KeyValuePair<'Key, 'Value>>
    interface IEnumerator
    interface IDisposable
    interface IDictionaryEnumerator

Public Structure SortedDictionary(Of TKey, TValue).Enumerator
Implements IDictionaryEnumerator, IEnumerator(Of KeyValuePair(Of TKey, TValue))

Type Parameters

TKey

TValue

Inheritance

Object

ValueType

SortedDictionary<TKey,TValue>.Enumerator

Implements

IEnumerator<KeyValuePair<TKey,TValue>> IDictionaryEnumerator IEnumerator IDisposable

Remarks

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. You must call the MoveNext method to advance the enumerator to the first element of the collection before reading the value of Current.

The Current property 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 the next call to MoveNext or IEnumerator.Reset throws an InvalidOperationException.

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.

Properties

Current

Gets the element at the current position of the enumerator.

Methods

Dispose()	Releases all resources used by the SortedDictionary<TKey,TValue>.Enumerator.
MoveNext()	Advances the enumerator to the next element of the SortedDictionary<TKey,TValue>.

Explicit Interface Implementations

IDictionaryEnumerator.Entry	Gets the element at the current position of the enumerator as a DictionaryEntry structure.
IDictionaryEnumerator.Key	Gets the key of the element at the current position of the enumerator.
IDictionaryEnumerator.Value	Gets the value of the element at the current position of the enumerator.
IEnumerator.Current	Gets the element at the current position of the enumerator.
IEnumerator.Reset()	Sets the enumerator to its initial position, which is before the first element in the collection.

See also

• SortedDictionary<TKey,TValue>.KeyCollection.Enumerator
• SortedDictionary<TKey,TValue>.ValueCollection.Enumerator
• IEnumerable<T>
• IEnumerator<T>