EventHandlerClass Class
This API supports the SQL Server 2012 infrastructure and is not intended to be used directly from your code.
A container on a package or other containers that holds executable objects to run when specific events occur.
Inheritance Hierarchy
System.Object
Microsoft.SqlServer.Dts.Runtime.Wrapper.EventHandlerClass
Namespace: Microsoft.SqlServer.Dts.Runtime.Wrapper
Assembly: Microsoft.SqlServer.DTSRuntimeWrap (in Microsoft.SqlServer.DTSRuntimeWrap.dll)
Syntax
'Declaration
<GuidAttribute("B8E051B0-2B05-49C7-A60F-20E877392D5E")> _
<ClassInterfaceAttribute(ClassInterfaceType.None)> _
Public Class EventHandlerClass _
Implements EventHandler, IDTSEventHandler100, IDTSContainer100, IDTSSequence100, _
IDTSExecutable100, IDTSExecutionMetrics100, IDTSPropertiesProvider100, IDTSName100, IDTSBreakpointSite100, _
IDTSSuspend100, IDTSPersist100, IDTSRuntimeObject100
'Usage
Dim instance As EventHandlerClass
[GuidAttribute("B8E051B0-2B05-49C7-A60F-20E877392D5E")]
[ClassInterfaceAttribute(ClassInterfaceType.None)]
public class EventHandlerClass : EventHandler,
IDTSEventHandler100, IDTSContainer100, IDTSSequence100, IDTSExecutable100, IDTSExecutionMetrics100,
IDTSPropertiesProvider100, IDTSName100, IDTSBreakpointSite100, IDTSSuspend100, IDTSPersist100,
IDTSRuntimeObject100
[GuidAttribute(L"B8E051B0-2B05-49C7-A60F-20E877392D5E")]
[ClassInterfaceAttribute(ClassInterfaceType::None)]
public ref class EventHandlerClass : EventHandler,
IDTSEventHandler100, IDTSContainer100, IDTSSequence100, IDTSExecutable100, IDTSExecutionMetrics100,
IDTSPropertiesProvider100, IDTSName100, IDTSBreakpointSite100, IDTSSuspend100, IDTSPersist100,
IDTSRuntimeObject100
[<GuidAttribute("B8E051B0-2B05-49C7-A60F-20E877392D5E")>]
[<ClassInterfaceAttribute(ClassInterfaceType.None)>]
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
end
public class EventHandlerClass implements EventHandler, IDTSEventHandler100, IDTSContainer100, IDTSSequence100, IDTSExecutable100, IDTSExecutionMetrics100, IDTSPropertiesProvider100, IDTSName100, IDTSBreakpointSite100, IDTSSuspend100, IDTSPersist100, IDTSRuntimeObject100
The EventHandlerClass type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
EventHandlerClass | Infrastructure. Initializes a new instance of the EventHandlerClass class. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
CreationName | Infrastructure. Gets the name that is used by the runtime engine to create an instance of the EventHandlerClass. This property is read-only. |
|
DebugMode | Infrastructure. Gets or sets a Boolean that indicates whether a task should check if breakpoints are enabled. |
|
DelayValidation | Infrastructure. Gets or sets a Boolean that indicates whether validation of the task is delayed until run time. The default value is false. |
|
Description | Infrastructure. Gets or sets the description of the EventHandlerClass object. |
|
Disable | Infrastructure. Gets a Boolean that indicates whether the EventHandlerClass object is disabled. |
|
Executables | Infrastructure. Gets a collection of executable objects in this container which run when the event occurs. This property is read-only. |
|
ExecutionDuration | Infrastructure. Gets a value that indicates the amount of time that the container spent in execution, in milliseconds. This property is read-only. |
|
ExecutionResult | Infrastructure. Gets a value that indicates the success or failure of the execution of the EventHandlerClass object. |
|
ExecutionStatus | Infrastructure. Gets a value that indicates the current status of the execution of the EventHandlerClass object at the time of the call. |
|
FailPackageOnFailure | Infrastructure. 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 | Infrastructure. Gets or sets a Boolean that indicates whether the parent container fails when a child container fails. |
|
ForcedExecutionValue | Infrastructure. If the ForceExecutionValue property is set to true, gets or sets a value that specifies the optional execution value the package returns. |
|
ForceExecutionResult | Infrastructure. Gets or sets a DTSForcedExecResult enumeration value that specifies the forced execution result of the container. |
|
ForceExecutionValue | Infrastructure. Gets or sets a Boolean that indicates whether the execution value of the container should be forced to contain a particular value. |
|
ID | Infrastructure. Gets the ID, which is a GUID, of the EventHandlerClass. The value is read-only. |
|
IDTSSuspend100_SuspendRequired | Infrastructure. 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 | Infrastructure. Gets a Boolean that indicates whether the container uses the default locale. This property is read-only. |
|
IsolationLevel | Infrastructure. Gets or sets the isolation level of the transaction in the EventHandlerClass object. |
|
LocaleID | Infrastructure. Gets or sets an Integer that indicates the Microsoft Win32® localeID to use when the EventHandlerClass object is executed. |
|
LogEntryInfos | Infrastructure. Gets a collection of log entry definitions. This property is read-only. |
|
LoggingMode | Infrastructure. Gets or sets a value from the DTSLoggingMode enumeration that indicates the logging mode of the container. |
|
LoggingOptions | Infrastructure. Gets an object that contains properties that indicates the filtering and logging resource for containers. This property is read-only. |
|
MaximumErrorCount | Infrastructure. Gets or sets an Integer value that specifies the maximum number of errors that can occur before the EventHandlerClass object stops running. |
|
Name | Infrastructure. Gets or sets the name of the EventHandlerClass. |
|
Parent | Infrastructure. Gets the parent container. The value is read-only. |
|
PrecedenceConstraints | Infrastructure. Gets a collection of precedence constraints, if any, found on the executable objects in this container. This property is read-only. |
|
Properties | Infrastructure. Gets a collection of IDTSProperty100 objects. This property is read-only. |
|
StartTime | Infrastructure. Gets the time when the container starts execution. This property is read-only. |
|
StopTime | Infrastructure. Gets the time when the container stops execution. This property is read-only. |
|
SuspendRequired | Infrastructure. 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 | Infrastructure. Gets or sets a value that indicates whether the container participates in transactions. |
|
VariableDispenser | Infrastructure. Gets a variable dispenser object so that variables associated with the container can be locked for reading or writing. |
|
Variables | Infrastructure. Gets a collection object that contains the variables associated with this container. This property is read-only. |
Top
Methods
| Name | Description | |
|---|---|---|
|
AcceptBreakpointManager | Infrastructure. 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 | Infrastructure. Computes the expressions of this EventHandlerClass object. |
|
Equals | (Inherited from Object.) |
|
Execute | Infrastructure. Runs the application, container, or package as part of a package workflow. |
.gif "Protected method") |
Finalize | (Inherited from Object.) |
|
GetExpression | Infrastructure. Returns the expression for the specified property or nulla null reference (Nothing in Visual Basic) if no expression is assigned. |
|
GetHashCode | (Inherited from Object.) |
|
GetParentID | Infrastructure. Gets the parent identifier of this container. |
|
GetType | (Inherited from Object.) |
|
IDTSSuspend100_ResumeExecution | Infrastructure. Resumes execution of the task after pausing. The task or container is resumed by the runtime engine. |
|
IDTSSuspend100_SuspendExecution | Infrastructure. Notifies that the executable needs to suspend. This method is called by the runtime engine. |
|
LoadFromXML | Infrastructure. Loads an EventHandlerClass from the specified XML document. |
|
MemberwiseClone | (Inherited from Object.) |
|
RegenerateID | Infrastructure. Creates a new GUID for the container and updates the container ID property. |
|
ResumeExecution | Infrastructure. Resumes execution of the task after pausing. The task or container is resumed by the runtime engine. |
|
SaveToXML | Infrastructure. Saves an EventHandlerClass to the specified XML document. |
|
SetExpression | Infrastructure. Assigns the specified expression to the property. Specify nulla null reference (Nothing in Visual Basic) to remove an existing expression from the property. |
|
SuspendExecution | Infrastructure. Notifies that the executable needs to suspend. This method is called by the runtime engine. |
|
ToString | (Inherited from Object.) |
|
Validate | Infrastructure. Allows the container to determine if it contains invalid settings that will prevent it from executing successfully. |
Top
Remarks
For more information, see DtsEventHandler.
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.