IDTSComponentEvents.FireCustomEvent Method

Article
12/03/2008

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

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
)

void FireCustomEvent (
    String eventName, 
    String eventText, 
    /** @ref */ Object[] arguments, 
    String subComponent, 
    /** @ref */ boolean fireAgain
)

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

Parameters

eventName
The name of the event to raise.

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 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.

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