SubscriberLocaleEnumeration.GetEnumerator Method

Article
12/03/2008

Gets an IEnumerator interface that allows you to iterate through the collection of subscriber locales represented by the SubscriberLocaleEnumeration.

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 SubscriberLocaleEnumeration.

Remarks

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

Example

The following examples show how to use a SubscriberLocaleEnumeration object to iterate through a set of subscriber locales. 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 SubscriberLocaleEnumeration object.
Dim mySubscriberLocaleEnumeration As _
    New SubscriberLocaleEnumeration(myInstance)

'Iterate through the subscriber locales.
Dim subscriberLocale As SubscriberLocale
For Each subscriberLocale In mySubscriberLocaleEnumeration
    Console.WriteLine("Locale: {0}", subscriberLocale.Locale)
Next subscriberLocale

string instanceName = "MyInstanceName";

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

//Create a SubscriberLocaleEnumeration object.
SubscriberLocaleEnumeration mySubscriberLocaleEnumeration = 
    new SubscriberLocaleEnumeration(myInstance);

//Iterate through the subscriber locales.
foreach (SubscriberLocale subscriberLocale 
    in mySubscriberLocaleEnumeration)
{
    Console.WriteLine("Locale: {0}", subscriberLocale.Locale);
}

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