IDTSEvents.OnCustomEvent Method
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
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 IDTSEvents
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)
void OnCustomEvent(
TaskHost taskHost,
string eventName,
string eventText,
ref Object[] arguments,
string subComponent,
ref bool fireAgain
)
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
function OnCustomEvent(
taskHost : TaskHost,
eventName : String,
eventText : String,
arguments : Object[],
subComponent : String,
fireAgain : boolean
)
Parameters
- taskHost
Type: Microsoft.SqlServer.Dts.Runtime.TaskHost
The task that is hosting the current task.
- eventName
Type: System.String
The name of the event.
- eventText
Type: System.String
The text that describes the event.
- 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.