EventHandlerClass Class

Definition

Namespace:

Microsoft.SqlServer.Dts.Runtime.Wrapper

Assembly:

Microsoft.SqlServer.DTSRuntimeWrap.dll

A container on a package or other containers that holds executable objects to run when specific events occur.

public ref class EventHandlerClass : Microsoft::SqlServer::Dts::Runtime::Wrapper::EventHandler, Microsoft::SqlServer::Dts::Runtime::Wrapper::IDTSBreakpointSite100, Microsoft::SqlServer::Dts::Runtime::Wrapper::IDTSContainer100, Microsoft::SqlServer::Dts::Runtime::Wrapper::IDTSExecutable100, Microsoft::SqlServer::Dts::Runtime::Wrapper::IDTSExecutionMetrics100, Microsoft::SqlServer::Dts::Runtime::Wrapper::IDTSName100, Microsoft::SqlServer::Dts::Runtime::Wrapper::IDTSPersist100, Microsoft::SqlServer::Dts::Runtime::Wrapper::IDTSPropertiesProvider100, Microsoft::SqlServer::Dts::Runtime::Wrapper::IDTSRuntimeObject100, Microsoft::SqlServer::Dts::Runtime::Wrapper::IDTSSequence100

[System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.None)]
[System.Runtime.InteropServices.TypeLibType(System.Runtime.InteropServices.TypeLibTypeFlags.FCanCreate)]
[System.Runtime.InteropServices.Guid("38E200B8-D503-46DF-9307-019C8FB19D37")]
public class EventHandlerClass : Microsoft.SqlServer.Dts.Runtime.Wrapper.EventHandler, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSBreakpointSite100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSContainer100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSExecutable100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSExecutionMetrics100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSName100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSPersist100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSPropertiesProvider100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSRuntimeObject100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSSequence100

[<System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.None)>]
[<System.Runtime.InteropServices.TypeLibType(System.Runtime.InteropServices.TypeLibTypeFlags.FCanCreate)>]
[<System.Runtime.InteropServices.Guid("38E200B8-D503-46DF-9307-019C8FB19D37")>]
type EventHandlerClass = class
    interface EventHandler
    interface IDTSEventHandler100
    interface IDTSContainer100
    interface IDTSSequence100
    interface IDTSExecutable100
    interface IDTSExecutionMetrics100
    interface IDTSPropertiesProvider100
    interface IDTSName100
    interface IDTSBreakpointSite100
    interface IDTSSuspend100
    interface IDTSPersist100
    interface IDTSRuntimeObject100

Public Class EventHandlerClass
Implements EventHandler, IDTSBreakpointSite100, IDTSContainer100, IDTSExecutable100, IDTSExecutionMetrics100, IDTSName100, IDTSPersist100, IDTSPropertiesProvider100, IDTSRuntimeObject100, IDTSSequence100

Inheritance

Object

EventHandlerClass

Attributes

ClassInterfaceAttribute GuidAttribute TypeLibTypeAttribute

Implements

EventHandler IDTSBreakpointSite100 IDTSContainer100 IDTSEventHandler100 IDTSExecutable100 IDTSExecutionMetrics100 IDTSName100 IDTSPersist100 IDTSPropertiesProvider100 IDTSRuntimeObject100 IDTSSequence100 IDTSSuspend100

Remarks

For more information, see DtsEventHandler.

Constructors

EventHandlerClass()

Initializes a new instance of the EventHandlerClass class.

Properties

CreationName	Gets the name that is used by the runtime engine to create an instance of the EventHandlerClass. This property is read-only.
DebugMode	Gets or sets a Boolean that indicates whether a task should check if breakpoints are enabled.
DelayValidation	Gets or sets a Boolean that indicates whether validation of the task is delayed until run time. The default value is false.
Description	Gets or sets the description of the EventHandlerClass object.
Disable	Gets a Boolean that indicates whether the EventHandlerClass object is disabled.
Executables	Gets a collection of executable objects in this container which run when the event occurs. This property is read-only.
ExecutionDuration	Gets a value that indicates the amount of time that the container spent in execution, in milliseconds. This property is read-only.
ExecutionResult	Gets a value that indicates the success or failure of the execution of the EventHandlerClass object.
ExecutionStatus	Gets a value that indicates the current status of the execution of the EventHandlerClass object at the time of the call.
FailPackageOnFailure	Gets or sets a Boolean that indicates whether the package fails when a child container fails. This property is used on containers, not the package itself.
FailParentOnFailure	Gets or sets a Boolean that indicates whether the parent container fails when a child container fails.
ForcedExecutionValue	If the ForceExecutionValue property is set to true, gets or sets a value that specifies the optional execution value the package returns.
ForceExecutionResult	Gets or sets a DTSForcedExecResult enumeration value that specifies the forced execution result of the container.
ForceExecutionValue	Gets or sets a Boolean that indicates whether the execution value of the container should be forced to contain a particular value.
ID	Gets the ID, which is a GUID, of the EventHandlerClass. The value is read-only.
IDTSSuspend100_SuspendRequired	Gets or sets a Boolean that indicates if tasks should suspend when they encounter a breakpoint. This value is set by the runtime engine for tasks and containers when a breakpoint is encountered.
IsDefaultLocaleID	Gets a Boolean that indicates whether the container uses the default locale. This property is read-only.
IsolationLevel	Gets or sets the isolation level of the transaction in the EventHandlerClass object.
LocaleID	Gets or sets an Integer that indicates the Microsoft Win32® localeID to use when the EventHandlerClass object is executed.
LogEntryInfos	Gets a collection of log entry definitions. This property is read-only.
LoggingMode	Gets or sets a value from the DTSLoggingMode enumeration that indicates the logging mode of the container.
LoggingOptions	Gets an object that contains properties that indicates the filtering and logging resource for containers. This property is read-only.
MaximumErrorCount	Gets or sets an Integer value that specifies the maximum number of errors that can occur before the EventHandlerClass object stops running.
Name	Gets or sets the name of the EventHandlerClass.
Parent	Gets the parent container. The value is read-only.
PrecedenceConstraints	Gets a collection of precedence constraints, if any, found on the executable objects in this container. This property is read-only.
Properties	Gets a collection of IDTSProperty100 objects. This property is read-only.
StartTime	Gets the time when the container starts execution. This property is read-only.
StopTime	Gets the time when the container stops execution. This property is read-only.
SuspendRequired	Gets or sets a Boolean that indicates if tasks should suspend when they encounter a breakpoint. This value is set by the runtime engine for tasks and containers when a breakpoint is encountered.
TransactionOption	Gets or sets a value that indicates whether the container participates in transactions.
VariableDispenser	Gets a variable dispenser object so that variables associated with the container can be locked for reading or writing.
Variables	Gets a collection object that contains the variables associated with this container. This property is read-only.

Methods

AcceptBreakpointManager(IDTSBreakpointManager100)	Passes a IDTSBreakpointManager100 to a task. The task will use the breakpoint manager to create, remove, and check the status of breakpoints. This method is called by the runtime and is not used in code.
ComputeExpressions(Boolean)	Computes the expressions of this EventHandlerClass object.
Execute(IDTSConnections100, IDTSVariables100, IDTSEvents100, IDTSLogging100, Object)	Runs the application, container, or package as part of a package workflow.
GetExpression(String)	Returns the expression for the specified property or null if no expression is assigned.
GetParentID()	Gets the parent identifier of this container.
IDTSSuspend100_get_SuspendRequired()
IDTSSuspend100_ResumeExecution()	Resumes execution of the task after pausing. The task or container is resumed by the runtime engine.
IDTSSuspend100_set_SuspendRequired(Boolean)
IDTSSuspend100_SuspendExecution()	Notifies that the executable needs to suspend. This method is called by the runtime engine.
LoadFromXML(Object, IDTSEvents100)	Loads an EventHandlerClass from the specified XML document.
RegenerateID()	Creates a new GUID for the container and updates the container ID property.
ResumeExecution()	Resumes execution of the task after pausing. The task or container is resumed by the runtime engine.
SaveToXML(Object, Object, IDTSEvents100)	Saves an EventHandlerClass to the specified XML document.
SetExpression(String, String)	Assigns the specified expression to the property. Specify null to remove an existing expression from the property.
SuspendExecution()	Notifies that the executable needs to suspend. This method is called by the runtime engine.
Validate(IDTSConnections100, IDTSVariables100, IDTSEvents100, IDTSLogging100)	Allows the container to determine if it contains invalid settings that will prevent it from executing successfully.