EventClass.FieldOrdinal Method

Article
12/03/2008

Returns the zero-based ordinal of a field in the event class.

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

Syntax

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

public int FieldOrdinal (
    string fieldName
)

public:
virtual int FieldOrdinal (
    String^ fieldName
) sealed

public final int FieldOrdinal (
    String fieldName
)

public final function FieldOrdinal (
    fieldName : String
) : int

Parameters

fieldName
The name of a field in the event class definition.

Return Value

An integer representing the zero-based field ordinal.

Example

The following examples show how to use the FieldOrdinal method to get the ordinal of an event class field by providing the field name.

These examples use the Microsoft.SqlServer.NotificationServices namespace.

Dim instanceName As String = "MyInstanceName"
Dim applicationName As String = "MyApplicationName"
Dim eventClassName As String = "MyEventClassName"
Dim fieldName As String = "MyEventFieldName"

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

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

'Create an EventClassEnumeration object.
Dim myEventClassEnumeration As _
    New EventClassEnumeration(myApplication)

'Use the EventClassEnumeration.Item 
'to return an EventClass object.
Dim myEventClass As EventClass = _
    myEventClassEnumeration(eventClassName)

'Use the FieldOrdinal method to get a field ordinal.
Dim fieldOrdinal As Integer = myEventClass.FieldOrdinal(fieldName)

string instanceName = "MyInstanceName";
string applicationName = "MyApplicationName";
string eventClassName = "MyEventClassName";
string fieldName = "MyEventFieldName";

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

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

//Create an EventClassEnumeration object.
EventClassEnumeration myEventClassEnumeration = 
    new EventClassEnumeration(myApplication);

//Use the EventClassEnumeration.Item 
//to return an EventClass object.
EventClass myEventClass = 
    myEventClassEnumeration[eventClassName];

//Use the FieldOrdinal method to get a field ordinal.
int fieldOrdinal = myEventClass.FieldOrdinal(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