SubscriberDeviceEnumeration.GetEnumerator Method

Article
12/03/2008

Gets an IEnumerator interface that allows you to iterate through the collection of subscriber devices represented by the SubscriberDeviceEnumeration 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 SubscriberDeviceEnumeration object.

Remarks

Use this method to return an IEnumerator interface that allows you to iterate through the subscriber devices in a SubscriberDeviceEnumeration object. An initialized SubscriberDeviceEnumeration object represents the collection of devices for one subscriber in a specified Notification Services instance.

Example

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

Dim instanceName As String = "MyInstanceName"
Dim subscriberId As String = "MySubscriberID"

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

'Create a SubscriberDeviceEnumeration object.
Dim mySubscriberDeviceEnumeration As _
    New SubscriberDeviceEnumeration(myInstance, subscriberId)

'Iterate through the subscriber devices.
Dim subscriberDevice As SubscriberDevice
For Each subscriberDevice In mySubscriberDeviceEnumeration
    Console.WriteLine("Device Name: {0}", _
    subscriberDevice.DeviceName)
Next subscriberDevice

string instanceName = "MyInstanceName";
string subscriberId = "MySubscriberID";

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

//Create a SubscriberDeviceEnumeration object.
SubscriberDeviceEnumeration mySubscriberDeviceEnumeration = 
    new SubscriberDeviceEnumeration(myInstance, subscriberId);

//Iterate through the subscriber devices.
foreach (SubscriberDevice subscriberDevice 
    in mySubscriberDeviceEnumeration)
{
    Console.WriteLine("Device Name: {0}", 
        subscriberDevice.DeviceName);
}

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