Export (0) Print
Expand All

IDTSComponentEvents.FireCustomEvent Method

Occurs when tasks raise custom task-defined events.

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

void FireCustomEvent(
	string eventName,
	string eventText,
	ref Object[] arguments,
	string subComponent,
	ref bool fireAgain
)

Parameters

eventName
Type: System.String
The name of the event to raise.
eventText
Type: System.String
The text describing the event.
arguments
Type: System.Object[]%
An array of arguments to pass to the event.
subComponent
Type: System.String
A String that contains more detail about the event source.
fireAgain
Type: System.Boolean%
A Boolean that indicates this should continue firing or stop firing. A value of true indicates that it should continue firing.

Because firing of an event may be expensive, the run-time engine provides a mechanism for suppressing events that you are not interested in. Every event firing method has a FireAgain parameter. If the value of this variable is false, then after the method returns, the caller will not fire this event again for the duration of the current execution.

Several of the events have a subComponent parameter that allows for even greater granularity in event source identification.

Community Additions

ADD
Show:
© 2014 Microsoft