ReferralCollection.GetEnumerator Method

Gets an IEnumerator that can iterate through the ReferralCollection.

Namespace: Microsoft.Web.Services3.Referral
Assembly: Microsoft.Web.Services3 (in microsoft.web.services3.dll)

Usage

'Usage
Dim returnValue As IEnumerator
Dim referralCollection1 As ReferralCollection
returnValue = referralCollection1.GetEnumerator()

Syntax

'Declaration
Public Function GetEnumerator() As IEnumerator

public IEnumerator GetEnumerator();

public:
virtual IEnumerator^ arbitrary-name();

public IEnumerator GetEnumerator();

public final function GetEnumerator() : IEnumerator;

Return Value

An IEnumerator that iterates through the ReferralCollection.

Remarks

Enumerators only allow reading the data in the collection. Enumerators cannot be used to modify the underlying collection.

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.

The enumerator does not have exclusive access to the collection; therefore, enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads could still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads.

Thread Safety

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

Platforms

Development Platforms

Windows XP Home Edition, Windows XP Professional, Windows Server 2003, Windows 2000, Windows 2000 Server, Windows 2000 Advanced Server

Target Platforms

See Also

Reference

ReferralCollection Class
ReferralCollection Members
Microsoft.Web.Services3.Referral Namespace