EventHandlerClass Class

 

This API supports the product 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.

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

System.Object
  Microsoft.SqlServer.Dts.Runtime.Wrapper.EventHandlerClass

[GuidAttribute("C41382ED-0293-4D63-AD59-7C92B5911CB1")]
[DefaultMemberAttribute("StartTime")]
[TypeLibTypeAttribute(TypeLibTypeFlags.FCanCreate)]
[ClassInterfaceAttribute(ClassInterfaceType.None)]
public class EventHandlerClass : EventHandler, IDTSEventHandler100, 
	IDTSContainer100, IDTSSequence100, IDTSExecutable100, IDTSExecutionMetrics100, 
	IDTSPropertiesProvider100, IDTSName100, IDTSBreakpointSite100, 
	IDTSSuspend100, IDTSPersist100, IDTSRuntimeObject100

NameDescription
System_CAPS_pubmethodEventHandlerClass()

This API supports the product infrastructure and is not intended to be used directly from your code. Initializes a new instance of the EventHandlerClass class.

NameDescription
System_CAPS_pubpropertyCreationName

This API supports the product infrastructure and is not intended to be used directly from your code. Gets the name that is used by the runtime engine to create an instance of the EventHandlerClass. This property is read-only.

System_CAPS_pubpropertyDebugMode

This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a Boolean that indicates whether a task should check if breakpoints are enabled.

System_CAPS_pubpropertyDelayValidation

This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a Boolean that indicates whether validation of the task is delayed until run time. The default value is false.

System_CAPS_pubpropertyDescription

This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the description of the EventHandlerClass object.

System_CAPS_pubpropertyDisable

This API supports the product infrastructure and is not intended to be used directly from your code. Gets a Boolean that indicates whether the EventHandlerClass object is disabled.

System_CAPS_pubpropertyExecutables

This API supports the product infrastructure and is not intended to be used directly from your code. Gets a collection of executable objects in this container which run when the event occurs. This property is read-only.

System_CAPS_pubpropertyExecutionDuration

This API supports the product infrastructure and is not intended to be used directly from your code. Gets a value that indicates the amount of time that the container spent in execution, in milliseconds. This property is read-only.

System_CAPS_pubpropertyExecutionResult

This API supports the product infrastructure and is not intended to be used directly from your code. Gets a value that indicates the success or failure of the execution of the EventHandlerClass object.

System_CAPS_pubpropertyExecutionStatus

This API supports the product infrastructure and is not intended to be used directly from your code. Gets a value that indicates the current status of the execution of the EventHandlerClass object at the time of the call.

System_CAPS_pubpropertyFailPackageOnFailure

This API supports the product infrastructure and is not intended to be used directly from your code. 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.

System_CAPS_pubpropertyFailParentOnFailure

This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a Boolean that indicates whether the parent container fails when a child container fails.

System_CAPS_pubpropertyForcedExecutionValue

This API supports the product infrastructure and is not intended to be used directly from your code. If the ForceExecutionValue property is set to true, gets or sets a value that specifies the optional execution value the package returns.

System_CAPS_pubpropertyForceExecutionResult

This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a DTSForcedExecResult enumeration value that specifies the forced execution result of the container.

System_CAPS_pubpropertyForceExecutionValue

This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a Boolean that indicates whether the execution value of the container should be forced to contain a particular value.

System_CAPS_pubpropertyID

This API supports the product infrastructure and is not intended to be used directly from your code. Gets the ID, which is a GUID, of the EventHandlerClass. The value is read-only.

System_CAPS_pubpropertyIDTSSuspend100_SuspendRequired

This API supports the product infrastructure and is not intended to be used directly from your code. 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.

System_CAPS_pubpropertyIsDefaultLocaleID

This API supports the product infrastructure and is not intended to be used directly from your code. Gets a Boolean that indicates whether the container uses the default locale. This property is read-only.

System_CAPS_pubpropertyIsolationLevel

This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the isolation level of the transaction in the EventHandlerClass object.

System_CAPS_pubpropertyLocaleID

This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets an Integer that indicates the Microsoft Win32® localeID to use when the EventHandlerClass object is executed.

System_CAPS_pubpropertyLogEntryInfos

This API supports the product infrastructure and is not intended to be used directly from your code. Gets a collection of log entry definitions. This property is read-only.

System_CAPS_pubpropertyLoggingMode

This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a value from the DTSLoggingMode enumeration that indicates the logging mode of the container.

System_CAPS_pubpropertyLoggingOptions

This API supports the product infrastructure and is not intended to be used directly from your code. Gets an object that contains properties that indicates the filtering and logging resource for containers. This property is read-only.

System_CAPS_pubpropertyMaximumErrorCount

This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets an Integer value that specifies the maximum number of errors that can occur before the EventHandlerClass object stops running.

System_CAPS_pubpropertyName

This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the name of the EventHandlerClass.

System_CAPS_pubpropertyParent

This API supports the product infrastructure and is not intended to be used directly from your code. Gets the parent container. The value is read-only.

System_CAPS_pubpropertyPrecedenceConstraints

This API supports the product infrastructure and is not intended to be used directly from your code. Gets a collection of precedence constraints, if any, found on the executable objects in this container. This property is read-only.

System_CAPS_pubpropertyProperties

This API supports the product infrastructure and is not intended to be used directly from your code. Gets a collection of IDTSProperty100 objects. This property is read-only.

System_CAPS_pubpropertyStartTime

This API supports the product infrastructure and is not intended to be used directly from your code. Gets the time when the container starts execution. This property is read-only.

System_CAPS_pubpropertyStopTime

This API supports the product infrastructure and is not intended to be used directly from your code. Gets the time when the container stops execution. This property is read-only.

System_CAPS_pubpropertySuspendRequired

This API supports the product infrastructure and is not intended to be used directly from your code. 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.

System_CAPS_pubpropertyTransactionOption

This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a value that indicates whether the container participates in transactions.

System_CAPS_pubpropertyVariableDispenser

This API supports the product infrastructure and is not intended to be used directly from your code. Gets a variable dispenser object so that variables associated with the container can be locked for reading or writing.

System_CAPS_pubpropertyVariables

This API supports the product infrastructure and is not intended to be used directly from your code. Gets a collection object that contains the variables associated with this container. This property is read-only.

NameDescription
System_CAPS_pubmethodAcceptBreakpointManager(IDTSBreakpointManager100)

This API supports the product infrastructure and is not intended to be used directly from your code. 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.

System_CAPS_pubmethodComputeExpressions(Boolean)

This API supports the product infrastructure and is not intended to be used directly from your code. Computes the expressions of this EventHandlerClass object.

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodExecute(IDTSConnections100, IDTSVariables100, IDTSEvents100, IDTSLogging100, Object)

This API supports the product infrastructure and is not intended to be used directly from your code. Runs the application, container, or package as part of a package workflow.

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetExpression(String)

This API supports the product infrastructure and is not intended to be used directly from your code. Returns the expression for the specified property or null if no expression is assigned.

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetParentID()

This API supports the product infrastructure and is not intended to be used directly from your code. Gets the parent identifier of this container.

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodIDTSSuspend100_ResumeExecution()

This API supports the product infrastructure and is not intended to be used directly from your code. Resumes execution of the task after pausing. The task or container is resumed by the runtime engine.

System_CAPS_pubmethodIDTSSuspend100_SuspendExecution()

This API supports the product infrastructure and is not intended to be used directly from your code. Notifies that the executable needs to suspend. This method is called by the runtime engine.

System_CAPS_pubmethodLoadFromXML(Object, IDTSEvents100)

This API supports the product infrastructure and is not intended to be used directly from your code. Loads an EventHandlerClass from the specified XML document.

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodRegenerateID()

This API supports the product infrastructure and is not intended to be used directly from your code. Creates a new GUID for the container and updates the container ID property.

System_CAPS_pubmethodResumeExecution()

This API supports the product infrastructure and is not intended to be used directly from your code. Resumes execution of the task after pausing. The task or container is resumed by the runtime engine.

System_CAPS_pubmethodSaveToXML(Object, Object, IDTSEvents100)

This API supports the product infrastructure and is not intended to be used directly from your code. Saves an EventHandlerClass to the specified XML document.

System_CAPS_pubmethodSetExpression(String, String)

This API supports the product infrastructure and is not intended to be used directly from your code. Assigns the specified expression to the property. Specify null to remove an existing expression from the property.

System_CAPS_pubmethodSuspendExecution()

This API supports the product infrastructure and is not intended to be used directly from your code. Notifies that the executable needs to suspend. This method is called by the runtime engine.

System_CAPS_pubmethodToString()

(Inherited from Object.)

System_CAPS_pubmethodValidate(IDTSConnections100, IDTSVariables100, IDTSEvents100, IDTSLogging100)

This API supports the product infrastructure and is not intended to be used directly from your code. Allows the container to determine if it contains invalid settings that will prevent it from executing successfully.

For more information, see DtsEventHandler.

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

Return to top
Show: