DtsContainer DtsContainer DtsContainer Class

Definition

Defines an abstract base class that implements the properties and methods used by all containers and packages.

public ref class DtsContainer abstract : Microsoft::SqlServer::Dts::Runtime::Executable, IDisposable, Microsoft::SqlServer::Dts::Runtime::IDTSBreakpointSite, Microsoft::SqlServer::Dts::Runtime::IDTSExecutionMetrics, Microsoft::SqlServer::Dts::Runtime::IDTSName, Microsoft::SqlServer::Dts::Runtime::IDTSPersist, System::ComponentModel::IComponent
public abstract class DtsContainer : Microsoft.SqlServer.Dts.Runtime.Executable, IDisposable, Microsoft.SqlServer.Dts.Runtime.IDTSBreakpointSite, Microsoft.SqlServer.Dts.Runtime.IDTSExecutionMetrics, Microsoft.SqlServer.Dts.Runtime.IDTSName, Microsoft.SqlServer.Dts.Runtime.IDTSPersist, System.ComponentModel.IComponent
Public MustInherit Class DtsContainer
Inherits Executable
Implements IComponent, IDisposable, IDTSBreakpointSite, IDTSExecutionMetrics, IDTSName, IDTSPersist
Inheritance
Derived
Implements

Constructors

DtsContainer(IDTSContainer100) DtsContainer(IDTSContainer100) DtsContainer(IDTSContainer100)

Initializes a new instance of the DtsContainer class.

Properties

CreationName CreationName CreationName

Returns the string that is used to create an instance of the DtsContainer object. This property is read-only.

DebugMode DebugMode DebugMode

Gets or sets a Boolean that indicates whether the DtsContainer object is in debug mode and whether it should fire the OnBreakpointHit(IDTSBreakpointSite, BreakpointTarget) event while running.

DelayValidation DelayValidation DelayValidation

Gets or sets a Boolean that indicates whether validation of the task is delayed until run time. The default value is false.

Description Description Description

Gets or sets the description of the DtsContainer object.

Disable Disable Disable

A Boolean that indicates if the DtsContainer object is disabled.

ExecutionDuration ExecutionDuration ExecutionDuration

Returns a value that indicates the amount of time that the container spent in execution, in milliseconds. This property is read-only.

ExecutionResult ExecutionResult ExecutionResult

Returns a value that indicates the success or failure of the execution of the DtsContainer object.

ExecutionStatus ExecutionStatus ExecutionStatus

Returns a value that indicates the current status of the execution of the DtsContainer object at the time of the call.

FailPackageOnFailure FailPackageOnFailure 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 FailParentOnFailure FailParentOnFailure

Gets or sets a Boolean that defines whether the parent container fails when a child container fails.

ForcedExecutionValue ForcedExecutionValue ForcedExecutionValue

If the ForceExecutionValue property is set to True, gets or sets a value that specifies the optional execution value that the package returns.

ForceExecutionResult ForceExecutionResult ForceExecutionResult

Gets or sets a DTSForcedExecResult enumeration value that specifies the forced execution result of the container.

ForceExecutionValue ForceExecutionValue ForceExecutionValue

Gets or sets a Boolean that indicates whether the execution value of the container should be forced to contain a particular value.

ID ID ID

Returns the ID, which is a GUID, of the DtsContainer. The value is read-only.

IsDefaultLocaleID IsDefaultLocaleID IsDefaultLocaleID

A Boolean that indicates whether the container uses the default locale. This property is read-only.

IsolationLevel IsolationLevel IsolationLevel

Gets or sets the isolation level of the transaction in the DtsContainer object.

LocaleID LocaleID LocaleID

Gets or sets an Integer that indicates the Microsoft Win32® localeID to use when the DtsContainer object is executed.

LogEntryInfos LogEntryInfos LogEntryInfos

Returns a LogEntryInfos object. This property is read-only.

LoggingMode LoggingMode LoggingMode

Gets or sets a valid value from the DTSLoggingMode enumeration that indicates the logging mode of the container.

LoggingOptions LoggingOptions LoggingOptions

Returns an object that contains properties that indicates the filtering and logging resource for containers. This property is read-only.

MaximumErrorCount MaximumErrorCount MaximumErrorCount

Gets or sets an Integer value that indicates the maximum number of errors that can occur before the DtsContainer object stops running.

Name Name Name

Gets or sets the name of the DtsContainer.

Parent Parent Parent

Returns the parent container. The value is read-only.

Site Site Site

Gets or sets the site for the container.

StartTime StartTime StartTime

Returns the time that the container began execution. This property is read-only.

StopTime StopTime StopTime

Returns the time that the container ended execution. This property is read-only.

SuspendRequired SuspendRequired 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 TransactionOption TransactionOption

Gets or sets a DTSTransactionOption enumeration value that indicates whether the container participates in transactions.

VariableDispenser VariableDispenser VariableDispenser

Returns a VariableDispenser object so variables associated with the container can be locked.

Variables Variables Variables

Returns a collection that contains the variables associated with this container. This property is read-only.

Methods

AcceptBreakpointManager(BreakpointManager) AcceptBreakpointManager(BreakpointManager) 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.

Dispose() Dispose() Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Equals(Object) Equals(Object) Equals(Object)

Determines whether two object instances are equal.

(Inherited from DtsObject)
Execute(Connections, Variables, IDTSEvents, IDTSLogging, Object) Execute(Connections, Variables, IDTSEvents, IDTSLogging, Object) Execute(Connections, Variables, IDTSEvents, IDTSLogging, Object)

Runs the application, container, or package as part of a package workflow.

GetHashCode() GetHashCode() GetHashCode()

Returns the hash code for this instance.

(Inherited from DtsObject)
LoadFromXML(XmlNode, IDTSEvents) LoadFromXML(XmlNode, IDTSEvents) LoadFromXML(XmlNode, IDTSEvents)

This method is not callable by your application code. To load a package saved as .xml, use the LoadPackage(String, IDTSEvents) method.

ResumeExecution() ResumeExecution() ResumeExecution()

Resumes execution of the task after pausing. The task or container is resumed by the runtime engine.

SaveToXML(XmlDocument, XmlNode, IDTSEvents) SaveToXML(XmlDocument, XmlNode, IDTSEvents) SaveToXML(XmlDocument, XmlNode, IDTSEvents)

This method is not callable by your application code. To save a package as .xml, use the SaveToXml(String, Package, IDTSEvents) method.

SetWrappedExecutable(IDTSExecutable100) SetWrappedExecutable(IDTSExecutable100) SetWrappedExecutable(IDTSExecutable100)

Sets the wrapped executable for the container.

SuspendExecution() SuspendExecution() SuspendExecution()

Called when the executable needs to suspend. This method is called by the runtime engine.

Validate(Connections, Variables, IDTSEvents, IDTSLogging) Validate(Connections, Variables, IDTSEvents, IDTSLogging) Validate(Connections, Variables, IDTSEvents, IDTSLogging)

Allows the container to determine if it contains invalid settings that will prevent it from executing successfully.

Events

Disposed Disposed Disposed

Adds an event handler to listen to the Disposed event on the component.

Fields

m_executable m_executable m_executable

The executable.

(Inherited from Executable)

Applies to