FireCustomEvent Method

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

 

Raises a custom event defined by a component.

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

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

Parameters

EventName
Type: System.String

The name of the custom event.

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.

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.

Return to top
Show:
© 2016 Microsoft