State Info Collection. Get Enumerator Method
Returns a standard enumerator capable of iterating over the collection. This method cannot be inherited.
public: virtual System::Collections::IEnumerator ^ GetEnumerator();
public System.Collections.IEnumerator GetEnumerator ();
abstract member GetEnumerator : unit -> System.Collections.IEnumerator override this.GetEnumerator : unit -> System.Collections.IEnumerator
Public Function GetEnumerator () As IEnumerator
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. The Reset method also brings the enumerator back to this position. 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. For more information on enumerators, see IEnumerator.
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.
foreach statement of the C# language (
for each in Visual Basic) hides the complexity of the enumerators. Therefore, using
foreach is recommended, instead of directly manipulating the enumerator.
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.