Event.GetFieldName Method

Article
12/03/2008

Gets the name of a field in the event record.

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

Syntax

'Declaration
Public Function GetFieldName ( _
    fieldOrdinal As Integer _
) As String

public string GetFieldName (
    int fieldOrdinal
)

public:
virtual String^ GetFieldName (
    int fieldOrdinal
) sealed

public final String GetFieldName (
    int fieldOrdinal
)

public final function GetFieldName (
    fieldOrdinal : int
) : String

Parameters

fieldOrdinal
The zero-based ordinal of the event field for which you want the name returned.

Return Value

A string containing the field name.

Example

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

These examples use the Microsoft.SqlServer.NotificationServices namespace.

Dim instanceName As String = "MyInstanceName"
Dim applicationName As String = "MyApplicationName"
Dim eventClassName As String = "MyEventClassName"
Dim fieldOrdinal As Integer = 0

'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 GetFieldName method to get a field name.
Dim fieldName As String = myEvent.GetFieldName(fieldOrdinal)

string instanceName = "MyInstanceName";
string applicationName = "MyApplicationName";
string eventClassName = "MyEventClassName";
int fieldOrdinal = 0;

//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 GetFieldName method to get a field name.
string fieldName = myEvent.GetFieldName(fieldOrdinal);

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