PipelineComponent.EventInfos Property

Definition

Important

This API is not CLS-compliant.

Gets the IDTSEventInfos100 collection of the PipelineComponent object.

public:
 property Microsoft::SqlServer::Dts::Runtime::Wrapper::IDTSEventInfos100 ^ EventInfos { Microsoft::SqlServer::Dts::Runtime::Wrapper::IDTSEventInfos100 ^ get(); };
[System.CLSCompliant(false)]
public Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSEventInfos100 EventInfos { get; }
[<System.CLSCompliant(false)>]
member this.EventInfos : Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSEventInfos100
Public ReadOnly Property EventInfos As IDTSEventInfos100

Property Value

The IDTSEventInfos100 object provided to the PipelineComponent object.

Attributes

Remarks

Component developers create and expose custom events by using the EventInfos collection. The collection is provided to the component by the data flow task. Custom events are first created, or defined, by calling the Add method. The custom event is raised during package execution by calling the FireCustomEvent method of the ComponentMetaData.

If you specify true in the AllowEventHandlers parameter when calling Add, the Event Handlers tab in SSIS Designer, in SQL Server Data Tools (SSDT), shows the custom event in the Event Handler drop down box.

For more information, see Raising and Defining Events in a Data Flow Component.

Applies to