• Article

DtsContainer Members

Include Protected Members
Include Inherited Members

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

The DtsContainer type exposes the following members.

Constructors

  Name Description
Protected method DtsContainer(IDTSContainer100) Initializes a new instance of the DtsContainer class.

Top

Methods

  Name Description
Public method 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.
Public method Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Public method Equals(Object) Determines whether two object instances are equal. (Inherited from DtsObject.)
Public method Execute(Connections, Variables, IDTSEvents, IDTSLogging, Object) Runs the application, container, or package as part of a package workflow. (Overrides Executable.Execute(Connections, Variables, IDTSEvents, IDTSLogging, Object).)
Protected method Finalize() (Inherited from Object.)
Public method GetHashCode() Returns the hash code for this instance. (Inherited from DtsObject.)
Public method GetType() (Inherited from Object.)
Public method LoadFromXML(XmlNode, IDTSEvents) This method is not callable by your application code. To load a package saved as .xml, use the Application.LoadPackage method.
Protected method MemberwiseClone() (Inherited from Object.)
Public method ResumeExecution() Resumes execution of the task after pausing. The task or container is resumed by the runtime engine.
Public method SaveToXML(XmlDocument%, XmlNode, IDTSEvents) This method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method.
Protected method SetWrappedExecutable(IDTSExecutable100) Infrastructure.
Public method SuspendExecution() Called when the executable needs to suspend. This method is called by the runtime engine.
Public method ToString() (Inherited from Object.)
Public method Validate(Connections, Variables, IDTSEvents, IDTSLogging) Allows the container to determine if it contains invalid settings that will prevent it from executing successfully. (Overrides Executable.Validate(Connections, Variables, IDTSEvents, IDTSLogging).)

Top

Fields

  Name Description
Protected field m_executable Infrastructure. (Inherited from Executable.)

Top

Properties

  Name Description
Public property CreationName Returns the string that is used to create an instance of the DtsContainer object. This property is read-only.
Public property 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.
Public property DelayValidation Gets or sets a Boolean that indicates whether validation of the task is delayed until run time. The default value is false.
Public property Description Gets or sets the description of the DtsContainer object.
Public property Disable A Boolean that indicates if the DtsContainer object is disabled.
Public property ExecutionDuration Returns a value that indicates the amount of time that the container spent in execution, in milliseconds. This property is read-only.
Public property ExecutionResult Returns a value that indicates the success or failure of the execution of the DtsContainer object.
Public property ExecutionStatus Returns a value that indicates the current status of the execution of the DtsContainer object at the time of the call.
Public property 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.
Public property FailParentOnFailure Gets or sets a Boolean that defines whether the parent container fails when a child container fails.
Public property ForcedExecutionValue If the ForceExecutionValue property is set to True, gets or sets a value that specifies the optional execution value that the package returns.
Public property ForceExecutionResult Gets or sets a DTSForcedExecResult enumeration value that specifies the forced execution result of the container.
Public property ForceExecutionValue Gets or sets a Boolean that indicates whether the execution value of the container should be forced to contain a particular value.
Public property ID Returns the ID, which is a GUID, of the DtsContainer. The value is read-only.
Public property IsDefaultLocaleID A Boolean that indicates whether the container uses the default locale. This property is read-only.
Public property IsolationLevel Gets or sets the isolation level of the transaction in the DtsContainer object.
Public property LocaleID Gets or sets an Integer that indicates the Microsoft Win32® localeID to use when the DtsContainer object is executed.
Public property LogEntryInfos Returns a LogEntryInfos object. This property is read-only.
Public property LoggingMode Gets or sets a valid value from the DTSLoggingMode enumeration that indicates the logging mode of the container.
Public property LoggingOptions Returns an object that contains properties that indicates the filtering and logging resource for containers. This property is read-only.
Public property MaximumErrorCount Gets or sets an Integer value that indicates the maximum number of errors that can occur before the DtsContainer object stops running.
Public property Name Gets or sets the name of the DtsContainer.
Public property Parent Returns the parent container. The value is read-only.
Public property Site Infrastructure.
Public property StartTime Returns the time that the container began execution. This property is read-only.
Public property StopTime Returns the time that the container ended execution. This property is read-only.
Public property 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.
Public property TransactionOption Gets or sets a DTSTransactionOption enumeration value that indicates whether the container participates in transactions.
Public property VariableDispenser Returns a VariableDispenser object so variables associated with the container can be locked.
Public property Variables Returns a collection that contains the variables associated with this container. This property is read-only.

Top

Events

  Name Description
Public event Disposed Adds an event handler to listen to the Disposed event on the component.

Top