DefaultEvents Class

Definition

Defines the default events that are provided by the Integration Services run-time.

public ref class DefaultEvents : Microsoft::SqlServer::Dts::Runtime::IDTSEvents
public class DefaultEvents : Microsoft.SqlServer.Dts.Runtime.IDTSEvents
type DefaultEvents = class
    interface IDTSEvents
Public Class DefaultEvents
Implements IDTSEvents
Inheritance
DefaultEvents
Implements

Remarks

Because firing of an event and generating the information sent with an event is potentially expensive, there is a mechanism for suppressing events when a client is not interested in that particular event. Every event firing method has a fireAgain parameter. If the value of this variable is false after the method returns, the caller should not fire this event again for the duration of the current execution.

For more information about the events provided by the Integration Services run-time, see Integration Services (SSIS) Event Handlers.

Constructors

DefaultEvents()

Initializes a new instance of the DefaultEvents class.

Methods

OnBreakpointHit(IDTSBreakpointSite, BreakpointTarget)

This method is called whenever a breakpoint is hit within a task.

OnCustomEvent(TaskHost, String, String, Object[], String, Boolean)

This method is called by tasks to raise custom task-defined events.

OnError(DtsObject, Int32, String, String, String, Int32, String)

This event is raised by a task or container when an error occurs.

OnExecutionStatusChanged(Executable, DTSExecStatus, Boolean)

This event is raised by a task or container when its execution status changes.

OnInformation(DtsObject, Int32, String, String, String, Int32, String, Boolean)

This event is raised anytime the task is to provide information.

OnPostExecute(Executable, Boolean)

This method is called immediately after the execution logic of the task completes. This event is raised by a task or container immediately after it runs.

OnPostValidate(Executable, Boolean)

This method is called immediately after the validation logic of the task completes. This event is raised by a task after the task is validated.

OnPreExecute(Executable, Boolean)

This method is called when the execution logic begins. This event is raised by a task or a container immediately before it runs.

OnPreValidate(Executable, Boolean)

This method is called when the validation logic of the task starts. This event is raised when the validation of the task host or container begins.

OnProgress(TaskHost, String, Int32, Int32, Int32, String, Boolean)

This method is called anytime a task experiences measurable progress.

OnQueryCancel()

This method is called 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.

OnTaskFailed(TaskHost)

This event is raised by the task host when it fails.

OnVariableValueChanged(DtsContainer, Variable, Boolean)

This event is used by the Integration Services run-time. It is not called by tasks.

OnWarning(DtsObject, Int32, String, String, String, Int32, String)

This event is raised anytime the task is in a state that does not justify an error, but does warrant alerting the client.

Applies to