Export (0) Print
Expand All

EventInfos.Add Method

Adds an EventInfo object to the current EventInfos collection.

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

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

Parameters

eventName
Type: String
The name of the custom event.
description
Type: String
A String that contains a description of the event.
allowEventHandlers
Type: 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: String[]
An array of parameters passed to the event.
parameterTypes
Type: TypeCode[]
The type of each parameter in the parameterNames array.
parameterDescriptions
Type: String[]
An array that contains descriptions for each of the parameters in parameterNames.

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

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"];
}

Community Additions

ADD
Show:
© 2014 Microsoft