EventInfos.Add Method (String, String, Boolean, String[], TypeCode[], String )

Article
07/16/2015

Applies To: SQL Server 2016 Preview

Adds an EventInfo object to the current EventInfos collection.

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

Syntax

public void Add(
    string eventName,
    string description,
    bool allowEventHandlers,
    string[] parameterNames,
    TypeCode[] parameterTypes,
    string[] parameterDescriptions
)

public:
void Add(
    String^ eventName,
    String^ description,
    bool allowEventHandlers,
    array<String^>^ parameterNames,
    array<TypeCode>^ parameterTypes,
    array<String^>^ parameterDescriptions
)

member Add : 
        eventName:string *
        description:string *
        allowEventHandlers:bool *
        parameterNames:string[] *
        parameterTypes:TypeCode[] *
        parameterDescriptions:string[] -> unit

Public Sub Add (
    eventName As String,
    description As String,
    allowEventHandlers As Boolean,
    parameterNames As String(),
    parameterTypes As TypeCode(),
    parameterDescriptions As String()
)

Parameters

eventName
Type: System.String

The name of the custom event.

description
Type: System.String

A String that contains a description of the event.

allowEventHandlers
Type: System.Boolean

A Boolean that indicates if the development tool will allow event handler objects to be created for the event. If true, event handler objects can be created for the event.

parameterNames
Type: System.String[]

An array of parameters passed to the event.

parameterTypes
Type: System.TypeCode[]

The type of each parameter in the parameterNames array.

parameterDescriptions
Type: System.String[]

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

Remarks

For an example of the EventInfos collection and the Addmethod, see Developing a Custom Task.

Examples

Legacy Code Example

The following example shows a custom event being added to the EventInfos collection.

public override void InitializeTask(Connections connections, VariableDispenser variables, IDTSInfoEvents events, IDTSLogging log, EventInfos eventInfos, LogEntryInfos logEntryInfos, ObjectReferenceTracker refTracker)
{
    this.eventInfos = eventInfos;
    string[] paramNames = new string[1];
    TypeCode[] paramTypes = new TypeCode[1]{TypeCode.Int32};
    string[] paramDescriptions = new string[1];

    paramNames[0] = "InitialValue";
    paramDescriptions[0] = "The value before increment.";

    this.eventInfos.Add("OnBeforeIncrement","Fires before the task increments the value.",true,paramNames,paramTypes,paramDescriptions);
    this.onBeforeIncrement = this.eventInfos["OnBeforeIncrement"];

    paramDescriptions[0] = "The value after increment.";
    this.eventInfos.Add("OnAfterIncrement","Fires after the initial value is updated.",true,paramNames, paramTypes,paramDescriptions);
    this.onAfterIncrement = this.eventInfos["OnAfterIncrement"];
}

Public Overrides Sub InitializeTask(ByVal connections As Connections, ByVal variables As VariableDispenser, ByVal events As IDTSInfoEvents, ByVal log As IDTSLogging, ByVal eventInfos As EventInfos, ByVal logEntryInfos As LogEntryInfos, ByVal refTracker As ObjectReferenceTracker) 
    Me.eventInfos = eventInfos
    Dim paramNames(0) As String
    Dim paramTypes(0) As TypeCode = {TypeCode.Int32}
    Dim paramDescriptions(0) As String
    
    paramNames(0) = "InitialValue"
    paramDescriptions(0) = "The value before increment."
    
    Me.eventInfos.Add("OnBeforeIncrement", "Fires before the task increments the value.", True, paramNames, paramTypes, paramDescriptions)
    Me.onBeforeIncrement = Me.eventInfos("OnBeforeIncrement")
    
    paramDescriptions(0) = "The value after increment."
    Me.eventInfos.Add("OnAfterIncrement", "Fires after the initial value is updated.", True, paramNames, paramTypes, paramDescriptions)
    Me.onAfterIncrement = Me.eventInfos("OnAfterIncrement")
End Sub