Share via


EventInfos.GetEnumerator Method

Definition

Returns an enumerator for use in iterating over the EventInfos collection.

public:
 Microsoft::SqlServer::Dts::Runtime::EventInfoEnumerator ^ GetEnumerator();
public Microsoft.SqlServer.Dts.Runtime.EventInfoEnumerator GetEnumerator ();
override this.GetEnumerator : unit -> Microsoft.SqlServer.Dts.Runtime.EventInfoEnumerator
Public Function GetEnumerator () As EventInfoEnumerator

Returns

An EventInfoEnumerator object.

Remarks

Enumerators are intended to be used only to read data in the collection. Enumerators cannot be used to modify the underlying collection.

The enumerator does not have exclusive access to the collection.

When an enumerator is created, it takes a snapshot of the current state of the collection. If changes are made to the collection, such as adding, modifying, or deleting elements, the snapshot gets out of synchronization and the enumerator throws an InvalidOperationException. Two enumerators created from the same collection at the same time can have different snapshots of the collection.

The enumerator is in a state that is not valid if it is positioned before the first element in the collection or after the last element in the collection. Whenever the enumerator is in a state that is not valid, calling Current throws an exception.

Initially, the enumerator is positioned before the first element in the collection. Reset also brings the enumerator back to this position. Therefore, after an enumerator is created or after Reset, MoveNext must be called to advance the enumerator to the first element of the collection before it reads the value of Current.

Current returns the same object until either MoveNext or Reset is called.

After the end of the collection is passed, the enumerator is again in a state that is not valid and calling MoveNext returns false. Calling Current throws an exception if the last call to MoveNext returned false.

Applies to