NotificationClass.NotificationFieldName Method

Article
12/03/2008

Returns the name of a developer-defined notification class field.

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

Syntax

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

public string NotificationFieldName (
    int fieldOrdinal
)

public:
virtual String^ NotificationFieldName (
    int fieldOrdinal
) sealed

public final String NotificationFieldName (
    int fieldOrdinal
)

public final function NotificationFieldName (
    fieldOrdinal : int
) : String

Parameters

fieldOrdinal
The zero-based ordinal of a developer-defined field in the notification class.

Return Value

A string containing the name of the 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 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 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 NotificationFieldName method to get a notification field name.
Dim fieldName As String = _
    myNotificationClass.NotificationFieldName(fieldOrdinal)

string instanceName = "MyInstanceName";
string applicationName = "MyApplicationName";
string notificationClassName = "MyNotificationClassName";
int fieldOrdinal = 0;

//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];

//Use the NotificationFieldName method to get a notification field name.
string fieldName = myNotificationClass.NotificationFieldName(
    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