DefaultEvents.OnCustomEvent Method

Article
12/03/2008

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 _
)

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
)

public void OnCustomEvent (
    TaskHost taskHost, 
    String eventName, 
    String eventText, 
    /** @ref */ Object[] arguments, 
    String subComponent, 
    /** @ref */ boolean fireAgain
)

JScript does not support passing value-type arguments by reference.

Parameters

taskHost
The task that is hosting the current task.

eventName
The name of the event.

eventText
The text describing the event.

arguments
An array of arguments to pass to the event.

subComponent
A string that contains more detail about the event source.

fireAgain
A Boolean that indicates whether this should continue firing or stop firing. A value of true indicates that it should continue firing.

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.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Share via