Share via

  • Article

DefaultEvents Class

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

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Dts.Runtime.DefaultEvents

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

Syntax

'Declaration
Public Class DefaultEvents _
    Implements IDTSEvents
'Usage
Dim instance As DefaultEvents

public class DefaultEvents : IDTSEvents

public ref class DefaultEvents : IDTSEvents

type DefaultEvents =  
    class
        interface IDTSEvents
    end

public class DefaultEvents implements IDTSEvents

The DefaultEvents type exposes the following members.

Constructors

  Name Description
Public method DefaultEvents Initializes a new instance of the DefaultEvents class.

Top

Methods

  Name Description
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public method OnBreakpointHit This method is called whenever a breakpoint is hit within a task.
Public method OnCustomEvent This method is called by tasks to raise custom task-defined events.
Public method OnError This event is raised by a task or container when an error occurs.
Public method OnExecutionStatusChanged This event is raised by a task or container when its execution status changes.
Public method OnInformation This event is raised anytime the task is to provide information.
Public method OnPostExecute 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.
Public method OnPostValidate 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.
Public method OnPreExecute This method is called when the execution logic begins. This event is raised by a task or a container immediately before it runs.
Public method OnPreValidate 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.
Public method OnProgress This method is called anytime a task experiences measurable progress.
Public method 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.
Public method OnTaskFailed This event is raised by the task host when it fails.
Public method OnVariableValueChanged This event is used by the Integration Services run-time. It is not called by tasks.
Public method OnWarning This event is raised anytime the task is in a state that does not justify an error, but does warrant alerting the client.
Public method ToString (Inherited from Object.)

Top

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 Event Handlers.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.