IDTSEventInfos100.Add Method (String, String, Boolean, String[], UInt16[], String )

Applies To: SQL Server 2016 Preview

This API supports the product 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

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

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

[<DispIdAttribute(2)>]
abstract Add : 
        EventName:string *
        Description:string *
        AllowEventHandlers:bool *
        ParamNames:string[] byref *
        ParamTypes:uint16[] byref *
        ParamDescs:string[] byref -> unit

<DispIdAttribute(2)>
Sub Add (
    EventName As String,
    Description As String,
    AllowEventHandlers As Boolean,
    <InAttribute> ByRef ParamNames As String(),
    <InAttribute> ByRef ParamTypes As UShort(),
    <InAttribute> ByRef ParamDescs As 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: System.String[]

  An array of parameters passed to the event.

• ParamTypes
  Type: System.UInt16[]

  The type of each parameter in the ParamNames array.

• ParamDescs
  Type: System.String[]

  An array that contains descriptions for each of the parameters in ParamNames.

Remarks

For more information, see EventInfos.

See Also

IDTSEventInfos100 Interface
Microsoft.SqlServer.Dts.Runtime.Wrapper Namespace

Return to top