EventClass.FieldTypeMods Method

Article
12/03/2008

Gets the field modifiers of a field in the event class.

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

Syntax

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

public string FieldTypeMods (
    int fieldOrdinal
)

public:
virtual String^ FieldTypeMods (
    int fieldOrdinal
) sealed

public final String FieldTypeMods (
    int fieldOrdinal
)

public final function FieldTypeMods (
    fieldOrdinal : int
) : String

Parameters

fieldOrdinal
The zero-based ordinal of a field in the event class definition.

Return Value

A String containing the field modifiers for this data field, if any are specified. Field modifiers include such information as whether the field accepts null values or has a default value.

Example

The following examples show how to use the FieldTypeMods method to get the field modifiers of an event class 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 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 FieldTypeMods method to get a field's modifiers.
Dim fieldTypeMods As String = _
    myEventClass.FieldTypeMods(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 EventClassEnumeration object.
EventClassEnumeration myEventClassEnumeration = 
    new EventClassEnumeration(myApplication);

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

//Use the FieldTypeMods method to get a field's modifiers.
string fieldTypeMods = 
    myEventClass.FieldTypeMods(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