IDTSComponentMetaData90.FireCustomEvent Method

Article
12/03/2008

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
<DispIdAttribute(130)> _
Sub FireCustomEvent ( _
    <InAttribute> EventName As String, _
    <InAttribute> EventText As String, _
    <InAttribute> ByRef ppsaArguments As Object(), _
    <InAttribute> SubComponent As String, _
    <InAttribute> <OutAttribute> ByRef pbFireAgain As Boolean _
)

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

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

/** @attribute DispIdAttribute(130) */ 
void FireCustomEvent (
    /** @attribute InAttribute() */ String EventName, 
    /** @attribute InAttribute() */ String EventText, 
    /** @attribute InAttribute() */ /** @ref */ Object[] ppsaArguments, 
    /** @attribute InAttribute() */ String SubComponent, 
    /** @attribute InAttribute() */ /** @attribute OutAttribute() */ /** @ref */ boolean pbFireAgain
)

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

Parameters

EventName
The name of the custom event.

EventText
The text that describes the event.

ppsaArguments
The array of arguments that match the arguments defined when the custom event is defined.

SubComponent
The name of the component that raises the custom event.

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

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

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Share via