SortedDictionary<TKey,TValue>.GetEnumerator Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Returns an enumerator that iterates through the SortedDictionary<TKey,TValue>.
public:
System::Collections::Generic::SortedDictionary<TKey, TValue>::Enumerator GetEnumerator();public System.Collections.Generic.SortedDictionary<TKey,TValue>.Enumerator GetEnumerator ();member this.GetEnumerator : unit -> System.Collections.Generic.SortedDictionary<'Key, 'Value>.EnumeratorPublic Function GetEnumerator () As SortedDictionary(Of TKey, TValue).EnumeratorReturns
A SortedDictionary<TKey,TValue>.Enumerator for the SortedDictionary<TKey,TValue>.
Remarks
For purposes of enumeration, each item is a KeyValuePair<TKey,TValue> structure representing a value and its key.
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.
The dictionary is maintained in a sorted order using an internal tree. Every new element is positioned at the correct sort position, and the tree is adjusted to maintain the sort order whenever an element is removed. While enumerating, the sort order is maintained.
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.
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 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.
This method is an O(log n) operation, where n is count.
