• Article

IDTSComponentMetaData100.FireCustomEvent Method

Raises a custom event defined by a component.

Namespace:  Microsoft.SqlServer.Dts.Pipeline.Wrapper
Assembly:  Microsoft.SqlServer.DTSPipelineWrap (in Microsoft.SqlServer.DTSPipelineWrap.dll)

Syntax

'Declaration
Sub FireCustomEvent ( _
    EventName As String, _
    EventText As String, _
    ByRef ppsaArguments As Object(), _
    SubComponent As String, _
    <OutAttribute> ByRef pbFireAgain As Boolean _
)
'Usage
Dim instance As IDTSComponentMetaData100
Dim EventName As String
Dim EventText As String
Dim ppsaArguments As Object()
Dim SubComponent As String
Dim pbFireAgain As Boolean

instance.FireCustomEvent(EventName, EventText, _
    ppsaArguments, SubComponent, pbFireAgain)

void FireCustomEvent(
    string EventName,
    string EventText,
    ref Object[] ppsaArguments,
    string SubComponent,
    out bool pbFireAgain
)

void FireCustomEvent(
    [InAttribute] String^ EventName, 
    [InAttribute] String^ EventText, 
    [InAttribute] array<Object^>^% ppsaArguments, 
    [InAttribute] String^ SubComponent, 
    [InAttribute] [OutAttribute] bool% pbFireAgain
)

abstract FireCustomEvent : 
        EventName:string * 
        EventText:string * 
        ppsaArguments:Object[] byref * 
        SubComponent:string * 
        pbFireAgain:bool byref -> unit 

function FireCustomEvent(
    EventName : String, 
    EventText : String, 
    ppsaArguments : Object[], 
    SubComponent : String, 
    pbFireAgain : boolean
)

Parameters

  • EventText
    Type: System.String
    The text that describes the event.
  • ppsaArguments
    Type: array<System.Object[]%
    The array of arguments that match the arguments defined when the custom event is defined.
  • SubComponent
    Type: System.String
    The name of the component that raises the custom event.
  • pbFireAgain
    Type: System.Boolean%
    Specifies whether the event should be raised again in the future.

Remarks

The FireCustomEvent method is used to raise a custom event that is defined by the component. The EventName and ppsaArguments parameters must match the name and parameter definitions of the custom event as they were defined when created by the component during the RegisterEvents method.