AFCollection(T).GetEnumerator Method
- Last UpdatedNov 18, 2025
- 3 minute read
- PI System
- AF SDK 2024 R2
- Developer
Namespace: OSIsoft.AF
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public IEnumerator<T> GetEnumerator()
Public Function GetEnumerator As IEnumerator(Of T) Dim instance As AFCollection Dim returnValue As IEnumerator(Of T) returnValue = instance.GetEnumerator()
public: virtual IEnumerator<T>^ GetEnumerator() sealed
abstract GetEnumerator : unit -> IEnumerator<'T> override GetEnumerator : unit -> IEnumerator<'T>
Return Value
Type: IEnumeratorTAn IEnumerator for the collection.
Implements
IEnumerableTGetEnumerator
Remarks
The foreach statement in 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.
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 item in the collection. At this position, Current is undefined. Therefore, you must call MoveNext to advance the enumerator to the first item of the collection before reading the value of Current.
Current returns the same object until MoveNext is called. MoveNext sets Current to the next item.
If MoveNext passes the end of the collection, the enumerator is positioned after the last item in the collection and MoveNext returns . When the enumerator is at this position, subsequent calls to MoveNext also return . If the last call to MoveNext returned , Current is undefined. You cannot set Current to the first item in 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 items, 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.
This method is an O(1) operation.