IDTSComponentEvents Interface
Defines an interface that provides event firing.
Namespace: Microsoft.SqlServer.Dts.Runtime
Assembly: Microsoft.SqlServer.ManagedDTS (in Microsoft.SqlServer.ManagedDTS.dll)
Syntax
'Declaration
Public Interface IDTSComponentEvents
'Usage
Dim instance As IDTSComponentEvents
public interface IDTSComponentEvents
public interface class IDTSComponentEvents
type IDTSComponentEvents = interface end
public interface IDTSComponentEvents
The IDTSComponentEvents type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
FireBreakpointHit | Raises an event when a breakpoint target is hit in the package. |
|
FireCustomEvent | Occurs when tasks raise custom task-defined events. |
|
FireError | Raises an event when an error occurs. |
|
FireInformation | Raises an event containing information. |
|
FireProgress | Raises an event when measurable progress is made by the executable. |
|
FireQueryCancel | Raises an event to determine whether an executable should stop running. |
|
FireWarning | Raises an event anytime the task is in a state that does not justify an error, but does warrant alerting the client. |
Top
Remarks
The Integration Services runtime includes this event interface that is passed by the runtime to various components that execute within a package, such as tasks, enumerators, and so on. Events are raised by tasks using the IDTSComponentEvents interface that is supplied during execution and by the run-time execution engine.
The Fire<x> methods can be called at design time and during execution. Typically, during component design, the FireError, FireInformation, and FireWarning methods are called to provide user feedback when a component is incorrectly configured. Events that are raised during component design are displayed in the Task Pane. Additionally, components can define custom events and then raise them during execution using the FireCustomEvent method. For more information, see Raising and Defining Events in a Data Flow Component.