Share via

  • Article

DefaultEvents.OnCustomEvent Method

This method is called by tasks to raise custom task-defined events.

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

Syntax

'Declaration
Public Overridable Sub OnCustomEvent ( _
    taskHost As TaskHost, _
    eventName As String, _
    eventText As String, _
    ByRef arguments As Object(), _
    subComponent As String, _
    ByRef fireAgain As Boolean _
)
'Usage
Dim instance As DefaultEvents
Dim taskHost As TaskHost
Dim eventName As String
Dim eventText As String
Dim arguments As Object()
Dim subComponent As String
Dim fireAgain As Boolean

instance.OnCustomEvent(taskHost, eventName, _
    eventText, arguments, subComponent, _
    fireAgain)

public virtual void OnCustomEvent(
    TaskHost taskHost,
    string eventName,
    string eventText,
    ref Object[] arguments,
    string subComponent,
    ref bool fireAgain
)

public:
virtual void OnCustomEvent(
    TaskHost^ taskHost, 
    String^ eventName, 
    String^ eventText, 
    array<Object^>^% arguments, 
    String^ subComponent, 
    bool% fireAgain
)

abstract OnCustomEvent : 
        taskHost:TaskHost * 
        eventName:string * 
        eventText:string * 
        arguments:Object[] byref * 
        subComponent:string * 
        fireAgain:bool byref -> unit 
override OnCustomEvent : 
        taskHost:TaskHost * 
        eventName:string * 
        eventText:string * 
        arguments:Object[] byref * 
        subComponent:string * 
        fireAgain:bool byref -> unit 

public function OnCustomEvent(
    taskHost : TaskHost, 
    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 whether this should continue firing or stop firing. A value of true indicates that it should continue firing.

Implements

IDTSEvents.OnCustomEvent(TaskHost, String, String, array<Object[]%, String, Boolean%)

Remarks

OnCustomEvent may be called at any time during the validation or execution of the task. It allows flexibility in the kinds of events that a task may raise.