DtsEventHandler Class
A container on a package or other containers that holds executables to run when specific events occur. This class cannot be inherited.
Assembly: Microsoft.SqlServer.ManagedDTS (in Microsoft.SqlServer.ManagedDTS.dll)
Microsoft.SqlServer.Dts.Runtime::DtsObject
Microsoft.SqlServer.Dts.Runtime::Executable
Microsoft.SqlServer.Dts.Runtime::DtsContainer
Microsoft.SqlServer.Dts.Runtime::DtsEventHandler
| Name | Description | |
|---|---|---|
![]() | CreationName | Returns the string that is used to create an instance of the DtsContainer object. This property is read-only.(Inherited from DtsContainer.) |
![]() | DebugMode | Gets or sets a Boolean that indicates whether the DtsContainer object is in debug mode and whether it should fire the OnBreakpointHit event while running. (Inherited from DtsContainer.) |
![]() | DelayValidation | Gets or sets a Boolean that indicates whether validation of the task is delayed until run time. The default value is false.(Inherited from DtsContainer.) |
![]() | Description | Gets or sets the description of the DtsContainer object.(Inherited from DtsContainer.) |
![]() | Disable | A Boolean that indicates if the DtsContainer object is disabled. (Inherited from DtsContainer.) |
![]() | Executables | Returns an Executables collection containing the executables in this container which run when the event occurs. This property is read-only. |
![]() | ExecutionDuration | Returns a value that indicates the amount of time that the container spent in execution, in milliseconds. This property is read-only. (Inherited from DtsContainer.) |
![]() | ExecutionResult | Returns a value that indicates the success or failure of the execution of the DtsContainer object. (Inherited from DtsContainer.) |
![]() | ExecutionStatus | Returns a value that indicates the current status of the execution of the DtsContainer object at the time of the call.(Inherited from DtsContainer.) |
![]() | 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.(Inherited from DtsContainer.) |
![]() | FailParentOnFailure | Gets or sets a Boolean that defines whether the parent container fails when a child container fails.(Inherited from DtsContainer.) |
![]() | ForcedExecutionValue | If the ForceExecutionValue property is set to True, gets or sets a value that specifies the optional execution value that the package returns.(Inherited from DtsContainer.) |
![]() | ForceExecutionResult | Gets or sets a DTSForcedExecResult enumeration value that specifies the forced execution result of the container. (Inherited from DtsContainer.) |
![]() | ForceExecutionValue | Gets or sets a Boolean that indicates whether the execution value of the container should be forced to contain a particular value.(Inherited from DtsContainer.) |
![]() | HasExpressions | Gets whether the DTS event contains expressions. |
![]() | ID | Returns the ID, which is a GUID, of the DtsContainer. The value is read-only.(Inherited from DtsContainer.) |
![]() | IsDefaultLocaleID | A Boolean that indicates whether the container uses the default locale. This property is read-only.(Inherited from DtsContainer.) |
![]() | IsolationLevel | Gets or sets the isolation level of the transaction in the DtsContainer object. (Inherited from DtsContainer.) |
![]() | LocaleID | Gets or sets an Integer that indicates the Microsoft Win32® localeID to use when the DtsContainer object is executed. (Inherited from DtsContainer.) |
![]() | LogEntryInfos | Returns a LogEntryInfos object. This property is read-only.(Inherited from DtsContainer.) |
![]() | LoggingMode | Gets or sets a valid value from the DTSLoggingMode enumeration that indicates the logging mode of the container.(Inherited from DtsContainer.) |
![]() | LoggingOptions | Returns an object that contains properties that indicates the filtering and logging resource for containers. This property is read-only.(Inherited from DtsContainer.) |
![]() | MaximumErrorCount | Gets or sets an Integer value that indicates the maximum number of errors that can occur before the DtsContainer object stops running.(Inherited from DtsContainer.) |
![]() | Name | Gets or sets the name of the DtsContainer.(Inherited from DtsContainer.) |
![]() | Parent | Returns the parent container. The value is read-only.(Inherited from DtsContainer.) |
![]() | PrecedenceConstraints | Returns a collection of precedence constraints, if any, found on the executables in this container. This property is read-only. |
![]() | Properties | Returns a DtsProperties collection. This property is read-only. |
![]() | Site | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the site for the container.(Inherited from DtsContainer.) |
![]() | StartTime | Returns the time that the container began execution. This property is read-only. (Inherited from DtsContainer.) |
![]() | StopTime | Returns the time that the container ended execution. This property is read-only.(Inherited from DtsContainer.) |
![]() | 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.(Inherited from DtsContainer.) |
![]() | TransactionOption | Gets or sets a DTSTransactionOption enumeration value that indicates whether the container participates in transactions.(Inherited from DtsContainer.) |
![]() | VariableDispenser | Returns a VariableDispenser object so variables associated with the container can be locked. (Inherited from DtsContainer.) |
![]() | Variables | Returns a collection that contains the variables associated with this container. This property is read-only.(Inherited from DtsContainer.) |
| Name | Description | |
|---|---|---|
![]() | AcceptBreakpointManager(BreakpointManager^) | This method is called by the run-time engine when a task or container is created, and passes it a BreakpointManager manager to allow the task to create, remove, and check the status of breakpoints. This method is called by the runtime and is not used in code.(Inherited from DtsContainer.) |
![]() | Dispose() | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.(Inherited from DtsContainer.) |
![]() | Equals(Object^) | Determines whether two object instances are equal.(Inherited from DtsObject.) |
![]() | Execute(Connections^, Variables^, IDTSEvents^, IDTSLogging^, Object^) | Runs the application, container, or package as part of a package workflow.(Inherited from DtsContainer.) |
![]() | GetExecutionPath() | Gets the DTS event handler execution path. |
![]() | GetExpression(String^) | Returns the expression for the specified property. Null means no expression is assigned. |
![]() | GetHashCode() | Returns the hash code for this instance.(Inherited from DtsObject.) |
![]() | GetPackagePath() | Gets the path of the package that the event handler applies to. |
![]() | GetType() | (Inherited from Object.) |
![]() | LoadFromXML(XmlNode^, IDTSEvents^) | This method is not callable by your application code. To load a package saved as .xml, use the Application::LoadPackage method.(Inherited from DtsContainer.) |
![]() | ResumeExecution() | Resumes execution of the task after pausing. The task or container is resumed by the runtime engine. (Inherited from DtsContainer.) |
![]() | SaveToXML(XmlDocument^%, XmlNode^, IDTSEvents^) | This method is not callable by your application code. To save a package as .xml, use the Application::SaveToXml method.(Inherited from DtsContainer.) |
![]() | SetExpression(String^, String^) | Assigns the specified expression to the property. Specify null to remove an existing expression from the property. |
![]() | SuspendExecution() | Called when the executable needs to suspend. This method is called by the runtime engine. (Inherited from DtsContainer.) |
![]() | ToString() | (Inherited from Object.) |
![]() | Validate(Connections^, Variables^, IDTSEvents^, IDTSLogging^) | Allows the container to determine if it contains invalid settings that will prevent it from executing successfully.(Inherited from DtsContainer.) |
| Name | Description | |
|---|---|---|
![]() | m_executable | This API supports the product infrastructure and is not intended to be used directly from your code. The executable.(Inherited from Executable.) |
| Name | Description | |
|---|---|---|
![]() | Disposed | Adds an event handler to listen to the Disposed event on the component.(Inherited from DtsContainer.) |
For more information, see Integration Services (SSIS) Event Handlers and Integration Services Containers.
Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.



