BrokerResponseEnumerator.GetEnumerator Method

Gets an enumerator that you can use to enumerate the items in the collection.

Namespace: Microsoft.Hpc.Scheduler.Session
Assembly: Microsoft.Hpc.Scheduler.Session (in Microsoft.Hpc.Scheduler.Session.dll)

Dim instance As BrokerResponseEnumerator(Of TMessage)
Dim returnValue As IEnumerator(Of BrokerResponse(Of TMessage))

returnValue = instance.GetEnumerator

public IEnumerator<BrokerResponse<TMessage>> GetEnumerator ()
public final IEnumerator<BrokerResponse<TMessage>> GetEnumerator ()
public final function GetEnumerator () : IEnumerator<BrokerResponse<TMessage>>

Return Value

An IEnumerator that you can use to iterate through the collection.

The foreach statement of the C# language (for each in C++, For Each in Visual Basic) hides the complexity of the enumerators. Therefore, using foreach is recommended instead of directly manipulating the enumerator.

You can use enumerators to read the data in the collection, but not to modify the underlying collection.

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

Current returns the same object until you call MoveNext. 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 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.

Platform Note: This method was introduced in Windows HPC Server 2008 R2 and is not supported in earlier versions.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Development Platforms

Windows XP, Windows Vista, Windows 7, Windows 8, Windows Server 2003, Windows Server 2008, Windows Server 2008 R2, Windows Server 2012

Target Platforms

Windows XP, Windows Vista, Windows 7, Windows 8, Windows Server 2003, Windows Server 2003 R2, Windows Server 2008, Windows Server 2008 R2, Windows Server 2012, with HPC Pack Client Utilities

Build Date: