Share via

  • Article

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)

Syntax

'Declaration
Sub FireCustomEvent ( _
    eventName As String, _
    eventText As String, _
    ByRef arguments As Object(), _
    subComponent As String, _
    ByRef fireAgain As Boolean _
)
'Usage
Dim instance As IDTSComponentEvents
Dim eventName As String
Dim eventText As String
Dim arguments As Object()
Dim subComponent As String
Dim fireAgain As Boolean

instance.FireCustomEvent(eventName, eventText, _
    arguments, subComponent, fireAgain)

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

void FireCustomEvent(
    String^ eventName, 
    String^ eventText, 
    array<Object^>^% arguments, 
    String^ subComponent, 
    bool% fireAgain
)

abstract FireCustomEvent : 
        eventName:string * 
        eventText:string * 
        arguments:Object[] byref * 
        subComponent:string * 
        fireAgain:bool byref -> unit 

function FireCustomEvent(
    eventName : String, 
    eventText : String, 
    arguments : Object[], 
    subComponent : String, 
    fireAgain : boolean
)

Parameters

  • arguments
    Type: array<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.

Remarks

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.