NotificationClass.NotificationFieldOrdinal Method

Article
12/03/2008

Returns the zero-based ordinal of a developer-defined notification field.

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

Syntax

'Declaration
Public Function NotificationFieldOrdinal ( _
    fieldName As String _
) As Integer

public int NotificationFieldOrdinal (
    string fieldName
)

public:
virtual int NotificationFieldOrdinal (
    String^ fieldName
) sealed

public final int NotificationFieldOrdinal (
    String fieldName
)

public final function NotificationFieldOrdinal (
    fieldName : String
) : int

Parameters

fieldName
The name of a developer-defined field.

Return Value

An Int32 representing the zero-based ordinal of a notification field.

Remarks

For more information about notification fields, see Defining the Notification Schema.

Example

Dim instanceName As String = "MyInstanceName"
Dim applicationName As String = "MyApplicationName"
Dim notificationClassName As String = "MyNotificationClassName"
Dim fieldName As String = "MyNotificationFieldName"

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

'Create an NSApplication object.
Dim myApplication As New NSApplication(myInstance, applicationName)

'Create a NotificationClassEnumeration object.
Dim myNotificationClassEnumeration As _
    New NotificationClassEnumeration(myApplication)

'Use the NotificationClassEnumeration.Item 
'to return a NotificationClass object.
Dim myNotificationClass As NotificationClass = _
    myNotificationClassEnumeration(notificationClassName)

'Use the NotificationFieldOrdinal method to get a field ordinal.
Dim fieldOrdinal As Integer = _
    myNotificationClass.NotificationFieldOrdinal(fieldName)

string instanceName = "MyInstanceName";
string applicationName = "MyApplicationName";
string notificationClassName = "MyNotificationClassName";
string fieldName = "MyComputedFieldName";

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

//Create an NSApplication object.
NSApplication myApplication = 
    new NSApplication(myInstance, applicationName);

//Create a NotificationClassEnumeration object.
NotificationClassEnumeration myNotificationClassEnumeration = 
    new NotificationClassEnumeration(myApplication);

//Use the NotificationClassEnumeration.Item 
//to return a NotificationClass object.
NotificationClass myNotificationClass = 
    myNotificationClassEnumeration[notificationClassName];

//Get a field ordinal.
int fieldOrdinal = 
    myNotificationClass.NotificationFieldOrdinal(fieldName);

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