SubscriptionClass.FieldTypeMods Method

Article
12/03/2008

Gets the field modifiers of a field in the subscription 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 developer-defined field in the subscription class.

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 specified.

Example

The following examples show how to use the FieldTypeMods method to get the field modifiers of a subscription field by providing the field ordinal:

Dim instanceName As String = "MyInstanceName"
Dim applicationName As String = "MyApplicationName"
Dim subscriptionClassName As String = "MySubscriptionClassName"
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 SubscriptionClassEnumeration object.
Dim mySubscriptionClassEnumeration As _
    New SubscriptionClassEnumeration(myApplication)

'Use the SubscriptionClassEnumeration.Item 
'to return a SubscriptionClass object.
Dim mySubscriptionClass As SubscriptionClass = _
    mySubscriptionClassEnumeration(subscriptionClassName)

'Use the FieldTypeMods method to get a field's modifiers.
Dim fieldTypeMods As String = _
    mySubscriptionClass.FieldTypeMods(fieldOrdinal)

string instanceName = "MyInstanceName";
string applicationName = "MyApplicationName";
string subscriptionClassName = "MySubscriptionClassName";
int fieldOrdinal = 0;

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

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

//Create a SubscriptionClassEnumeration object.
SubscriptionClassEnumeration mySubscriptionClassEnumeration = 
    new SubscriptionClassEnumeration(myApplication);

//Use the SubscriptionClassEnumeration.Item 
//to return a SubscriptionClass object.
SubscriptionClass mySubscriptionClass = 
    mySubscriptionClassEnumeration[subscriptionClassName];

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