Share via

EventsObjectWrapper.FireCustomEvent Method

  • Article

This API supports the SQL Server 2012 infrastructure and is not intended to be used directly from your code.

Occurs when tasks raise custom task-defined events.

Namespace:  Microsoft.SqlServer.Dts.Tasks.ScriptTask
Assembly:  Microsoft.SqlServer.ScriptTask (in Microsoft.SqlServer.ScriptTask.dll)

Syntax

'Declaration
Public Sub FireCustomEvent ( _
    eventName As String, _
    eventText As String, _
    ByRef arguments As Object(), _
    subComponent As String, _
    ByRef fireAgain As Boolean _
)
'Usage
Dim instance As EventsObjectWrapper 
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)

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

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

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

public 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
    Contains more detail about the event source.
  • fireAgain
    Type: System.Boolean%
    True to continue firing; otherwise, false.

See Also

Reference

EventsObjectWrapper Class

Microsoft.SqlServer.Dts.Tasks.ScriptTask Namespace