Share via

EventField Constructor (EventClass, String)

  • Article

Initializes a new instance of the EventField class with an EventClass and a name.

Namespace: Microsoft.SqlServer.Management.Nmo
Assembly: Microsoft.SqlServer.Smo (in microsoft.sqlserver.smo.dll)

Syntax

'Declaration
Public Sub New ( _
    eventClass As EventClass, _
    name As String _
)

public EventField (
    EventClass eventClass,
    string name
)

public:
EventField (
    EventClass^ eventClass, 
    String^ name
)

public EventField (
    EventClass eventClass, 
    String name
)

public function EventField (
    eventClass : EventClass, 
    name : String
)

Parameters

  • eventClass
    The EventClass for the event field. This parameter sets the Parent property.

  • name
    The String of up to 256 characters that specifies the name of the event field.

    You cannot change the name. To change the event field name, you must remove the event field and the add an event field that has the new name.

Remarks

Field names can contain letters, numbers, and the special characters _, #, @, and $. They must conform to Microsoft SQL Server identifier conventions. For more information about SQL Server identifiers, see Identifiers.

You cannot name an event field EventBatchID or EventID. Microsoft SQL Server 2005 Notification Services already uses these field names internally.

Example

The following examples show how to define an event field using this event field constructor:

// Add an orgin field to the end of the field collection
EventField eventOrgin = 
    new EventField(flightEvents, "LeavingFrom");
eventOrgin.Type = "nvarchar(6)";
eventOrgin.TypeModifier = "not null";
flightEvents.EventFields.Add(eventOrgin);

' Add an orgin field to the end of the field collection.
Dim eventOrgin As EventField = _
    New EventField(flightEvents, "LeavingFrom")
eventOrgin.Type = "nvarchar(6)"
eventOrgin.TypeModifier = "not null"
flightEvents.EventFields.Add(eventOrgin)

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

See Also

Reference

EventField Class
EventField Members
Microsoft.SqlServer.Management.Nmo Namespace

Other Resources

Defining Core Event Class Properties
FieldName Element for EventClass/Schema/Field (ADF)
Schema Element for EventClass (ADF)