IEnumeratorContract<T> Interface

Definition

Namespace:

System.AddIn.Contract

Assembly:

System.AddIn.Contract.dll

Enumerates the elements in an IListContract<T> collection.

generic <typename T>
public interface class IEnumeratorContract : IDisposable

public interface IEnumeratorContract<T> : IDisposable

type IEnumeratorContract<'T> = interface
    interface IDisposable

Public Interface IEnumeratorContract(Of T)
Implements IDisposable

Type Parameters

T

The type of objects being enumerated.

Implements

IDisposable

Remarks

Enumerators can be used to read the data in the collection, but they cannot be used to modify the collection.

Initially, the enumerator is positioned before the first element in the collection. At this position, the return value of GetCurrent is undefined. Therefore, you must call MoveNext to advance the enumerator to the first element of the collection before calling GetCurrent.

GetCurrent returns the same object until MoveNext is called. MoveNext sets the return value of GetCurrent 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, the return value of GetCurrent is undefined.

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.

Methods

Dispose()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable)
GetCurrent()	Returns the object in the collection at the current position of the enumerator.
MoveNext()	Advances the enumerator to the next element of the collection.
Reset()	Sets the enumerator to its initial position, which is before the first element in the collection.