IDTSEvents100.OnCustomEvent Method

  • Article

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

Called by tasks to raise custom task-defined events.

Namespace:  Microsoft.SqlServer.Dts.Runtime.Wrapper
Assembly:  Microsoft.SqlServer.DTSRuntimeWrap (in Microsoft.SqlServer.DTSRuntimeWrap.dll)

Syntax

'Declaration
Sub OnCustomEvent ( _
    pTaskHost As IDTSTaskHost100, _
    EventName As String, _
    EventText As String, _
    ByRef ppsaArguments As Object(), _
    SubComponent As String, _
    <OutAttribute> ByRef pbFireAgain As Boolean _
)
'Usage
Dim instance As IDTSEvents100 
Dim pTaskHost As IDTSTaskHost100 
Dim EventName As String 
Dim EventText As String 
Dim ppsaArguments As Object()
Dim SubComponent As String 
Dim pbFireAgain As Boolean

instance.OnCustomEvent(pTaskHost, EventName, _
    EventText, ppsaArguments, SubComponent, _
    pbFireAgain)

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

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

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

function OnCustomEvent(
    pTaskHost : IDTSTaskHost100, 
    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[]%
    An array of arguments to pass to the event.
  • SubComponent
    Type: System.String
    A String that contains more detail about the event source.
  • pbFireAgain
    Type: System.Boolean%
    A Boolean that indicates this should continue firing or stop firing. A value of true indicates that it should continue firing.

Remarks

For more information, see IDTSEvents.

See Also

Reference

IDTSEvents100 Interface

Microsoft.SqlServer.Dts.Runtime.Wrapper Namespace