Event.GetFieldOrdinal Method

Article
12/03/2008

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

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

Syntax

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

public int GetFieldOrdinal (
    string fieldName
)

public:
virtual int GetFieldOrdinal (
    String^ fieldName
) sealed

public final int GetFieldOrdinal (
    String fieldName
)

public final function GetFieldOrdinal (
    fieldName : String
) : int

Parameters

fieldName
The name of the event field for which you want the ordinal returned.

Return Value

An integer representing the zero-based field ordinal.

Example

The following examples show how to use the GetFieldOrdinal method to get the ordinal of an event 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 Event object.
Dim myEvent As New Microsoft.SqlServer.NotificationServices.Event( _
    myApplication, eventClassName)

'Use the GetFieldOrdinal method to get a field ordinal.
Dim fieldOrdinal As Integer = myEvent.GetFieldOrdinal(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 Event object.
Event myEvent = new Event(myApplication, eventClassName);

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