Share via

EventFieldCollection.Add Method (EventField, Int32)

  • Article

Adds an EventField at the specified position in the EventFieldCollection.

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

Syntax

'Declaration
Public Sub Add ( _
    eventField As EventField, _
    insertAtPosition As Integer _
)

public void Add (
    EventField eventField,
    int insertAtPosition
)

public:
void Add (
    EventField^ eventField, 
    int insertAtPosition
)

public void Add (
    EventField eventField, 
    int insertAtPosition
)

public function Add (
    eventField : EventField, 
    insertAtPosition : int
)

Parameters

  • eventField
    The EventField to add to the collection.
  • insertAtPosition
    An Int32 value that specifies the position to add the EventField object to the collection.

Remarks

Each EventField must have a unique name.

You add each EventField at a specific position in the collection. An event field at the specified position, and all subsequent event fields, will be moved one index value higher in the collection.

The order of the fields is maintained.

If you add event fields to an application after deploying the application, you must Update the instance to apply the changes.

Example

The following examples show how to define an event field and then add it to an event class at a specific position:

// Define a price field and add it at position 1
EventField eventPrice = new EventField(flightEvents, "Price");
eventPrice.Type = "float";
flightEvents.EventFields.Add(eventPrice, 1);

' Define a price field and add it at position 1.
Dim eventPrice As EventField = _
    New EventField(flightEvents, "Price")
eventPrice.Type = "float"
flightEvents.EventFields.Add(eventPrice, 1)

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

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

See Also

Reference

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

Other Resources

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