IDTSEventInfos100.Add Method

This API supports the SQL Server 2012 infrastructure and is not intended to be used directly from your code.

Adds an IDTSEventInfo100 object to the current collection.

Namespace:  Microsoft.SqlServer.Dts.Runtime.Wrapper
Assembly:  Microsoft.SqlServer.DTSRuntimeWrap (in Microsoft.SqlServer.DTSRuntimeWrap.dll)

Syntax

'Declaration
Sub Add ( _
    EventName As String, _
    Description As String, _
    AllowEventHandlers As Boolean, _
    ByRef ParamNames As String(), _
    ByRef ParamTypes As UShort(), _
    ByRef ParamDescs As String() _
)
'Usage
Dim instance As IDTSEventInfos100 
Dim EventName As String 
Dim Description As String 
Dim AllowEventHandlers As Boolean 
Dim ParamNames As String()
Dim ParamTypes As UShort()
Dim ParamDescs As String()

instance.Add(EventName, Description, AllowEventHandlers, _
    ParamNames, ParamTypes, ParamDescs)

void Add(
    string EventName,
    string Description,
    bool AllowEventHandlers,
    ref string[] ParamNames,
    ref ushort[] ParamTypes,
    ref string[] ParamDescs
)

void Add(
    [InAttribute] String^ EventName, 
    [InAttribute] String^ Description, 
    [InAttribute] bool AllowEventHandlers, 
    [InAttribute] array<String^>^% ParamNames, 
    [InAttribute] array<unsigned short>^% ParamTypes, 
    [InAttribute] array<String^>^% ParamDescs
)

abstract Add : 
        EventName:string * 
        Description:string * 
        AllowEventHandlers:bool * 
        ParamNames:string[] byref * 
        ParamTypes:uint16[] byref * 
        ParamDescs:string[] byref -> unit

function Add(
    EventName : String, 
    Description : String, 
    AllowEventHandlers : boolean, 
    ParamNames : String[], 
    ParamTypes : ushort[], 
    ParamDescs : String[]
)

Parameters

• EventName
  Type: System.String
  The name of the custom event.

• Description
  Type: System.String
  The description of the event.

• AllowEventHandlers
  Type: System.Boolean
  true to indicate that the event handler objects can be created for the event; otherwise, false.

• ParamNames
  Type: array<System.String[]%
  An array of parameters passed to the event.

• ParamTypes
  Type: array<System.UInt16[]%
  The type of each parameter in the ParamNames array.

• ParamDescs
  Type: array<System.String[]%
  An array that contains descriptions for each of the parameters in ParamNames.

Remarks

For more information, see EventInfos.

See Also

Reference

IDTSEventInfos100 Interface

Microsoft.SqlServer.Dts.Runtime.Wrapper Namespace