IDTSComponentMetaData100.FireCustomEvent Method (String, String, Object , String, Boolean)

  • Article

 

Applies To: SQL Server 2016 Preview

Raises a custom event defined by a component.

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

Syntax

[DispIdAttribute(130)]
void FireCustomEvent(
    string EventName,
    string EventText,
    [InAttribute] ref object[] ppsaArguments,
    string SubComponent,
    ref bool pbFireAgain
)

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

[<DispIdAttribute(130)>]
abstract FireCustomEvent : 
        EventName:string *
        EventText:string *
        ppsaArguments:Object[] byref *
        SubComponent:string *
        pbFireAgain:bool byref -> unit

<DispIdAttribute(130)>
Sub FireCustomEvent (
    EventName As String,
    EventText As String,
    <InAttribute> ByRef ppsaArguments As Object(),
    SubComponent As String,
    ByRef pbFireAgain As Boolean
)

Parameters

  • EventText
    Type: System.String

    The text that describes the event.

  • ppsaArguments
    Type: 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.

See Also

IDTSComponentMetaData100 Interface
Microsoft.SqlServer.Dts.Pipeline.Wrapper Namespace

Return to top