PipelineComponent.EventInfos Property

  • Article

 

Applies To: SQL Server 2016 Preview

Gets the IDTSEventInfos100 collection of the PipelineComponent object.

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

Syntax

[CLSCompliantAttribute(false)]
public IDTSEventInfos100 EventInfos { get; }

public:
[CLSCompliantAttribute(false)]
property IDTSEventInfos100^ EventInfos {
    IDTSEventInfos100^ get();
}

[<CLSCompliantAttribute(false)>]
member EventInfos : IDTSEventInfos100 with get

<CLSCompliantAttribute(False)>
Public ReadOnly Property EventInfos As IDTSEventInfos100

Property Value

Type: Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSEventInfos100

The IDTSEventInfos100 object provided to the PipelineComponent object.

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.

See Also

PipelineComponent Class
Microsoft.SqlServer.Dts.Pipeline Namespace

Return to top