IDTSEvents Interface

Defines a set of events used by the TaskHost on behalf of a task.

Namespace:  Microsoft.SqlServer.Dts.Runtime
Assembly:  Microsoft.SqlServer.ManagedDTS (in Microsoft.SqlServer.ManagedDTS.dll)

public interface class IDTSEvents

The IDTSEvents type exposes the following members.

Public methodOnBreakpointHitCalled when a breakpoint is hit within a task.
Public methodOnCustomEventCalled by tasks to raise custom task-defined events.
Public methodOnErrorCalled by a task or container when an error occurs.
Public methodOnExecutionStatusChangedCalled by a task or container when its execution status changes.
Public methodOnInformationCalled any time the task is required to provide information.
Public methodOnPostExecuteCalled immediately after the execution logic of the task completes. This event is raised by a task or container immediately after it runs.
Public methodOnPostValidateCalled immediately after the validation logic of the task completes. This event is raised by a task after the task is validated.
Public methodOnPreExecuteCalled when a task is about to execute. This event is raised by a task or a container immediately before it runs.
Public methodOnPreValidateCalled when the actual validation logic of the task starts. This event is raised when the validation of the task host or container begins.
Public methodOnProgressCalled to update progress about task execution.
Public methodOnQueryCancelCalled at any juncture in task processing where it is feasible to cancel execution. This event is raised by tasks and containers to determine whether they should stop running.
Public methodOnTaskFailedCalled by the task host when it fails.
Public methodOnVariableValueChangedCalled by the run-time engine. It is not called by tasks.
Public methodOnWarningCalled any time the task is in a state that does not justify an error, but does warrant alerting the client.

For each method, there is a related object in the DtsEventHandlers collection that handles the event. If the event is disabled, the object will not execute and will return false. If the object does not handle the event at the local level, the event is escalated to the parent container to be handled.

These methods provide indexes into the events collection for the corresponding event handler.