SubscriberEnumeration.GetEnumerator Method

Article
12/03/2008

Gets an IEnumerator interface that allows you to iterate through the collection of subscribers represented by the SubscriberEnumeration object.

Namespace: Microsoft.SqlServer.NotificationServices
Assembly: Microsoft.SqlServer.NotificationServices (in microsoft.sqlserver.notificationservices.dll)

Syntax

'Declaration
Public Function GetEnumerator As IEnumerator

public IEnumerator GetEnumerator ()

public:
virtual IEnumerator^ GetEnumerator () sealed

public final IEnumerator GetEnumerator ()

public final function GetEnumerator () : IEnumerator

Return Value

An IEnumerator interface for the SubscriberEnumeration object.

Remarks

Use this method to return an IEnumerator interface that allows you to iterate through the subscribers in a SubscriberEnumeration object. An initialized SubscriberEnumeration object represents the collection of subscribers in a specified Notification Services instance.

Example

The following examples show how to use a SubscriberEnumeration object to iterate through a set of subscribers. The GetEnumerator method makes the For Each and foreach statements possible.

Dim instanceName As String = "MyInstanceName"

'Create an NSInstance object.
Dim myInstance As New NSInstance(instanceName)

'Create a SubscriberEnumeration object.
Dim mySubscriberEnumeration As _
    New SubscriberEnumeration(myInstance)

'Iterate through the subscribers.
Dim subscriber As Subscriber
For Each subscriber In mySubscriberEnumeration
    Console.WriteLine("Subscriber ID: {0}", _
    subscriber.SubscriberId)
Next subscriber

string instanceName = "MyInstanceName";

//Create an NSInstance object.
NSInstance myInstance = new NSInstance(instanceName);

//Create a SubscriberEnumeration object.
SubscriberEnumeration mySubscriberEnumeration = 
    new SubscriberEnumeration(myInstance);

//Iterate through the subscribers.
foreach (Subscriber subscriber in mySubscriberEnumeration)
{
    Console.WriteLine("Subscriber ID: {0}", 
        subscriber.SubscriberId);
}

Thread Safety

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

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms