DtsContainer Class

Reference

Definition

Namespace:: Microsoft.SqlServer.Dts.Runtime

Assembly:: Microsoft.SqlServer.ManagedDTS.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

type DtsContainer = class
    inherit Executable
    interface IDTSPersist
    interface IDTSExecutionMetrics
    interface IDTSName
    interface IDTSBreakpointSite
    interface IDTSSuspend
    interface IComponent
    interface IDisposable

Public MustInherit Class DtsContainer
Inherits Executable
Implements IComponent, IDisposable, IDTSBreakpointSite, IDTSExecutionMetrics, IDTSName, IDTSPersist

Inheritance: Object

DtsObject

Executable
DtsContainer

Derived: Microsoft.SqlServer.Dts.Runtime.DtsEventHandler

Microsoft.SqlServer.Dts.Runtime.EventsProvider

Implements: IDTSBreakpointSite IDTSExecutionMetrics IDTSName IDTSPersist IDTSSuspend IComponent IDisposable

Constructors

DtsContainer(IDTSContainer100)

Initializes a new instance of the DtsContainer class.

Fields

m_executable

The executable.

(Inherited from Executable)

Properties

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

Methods

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()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
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.
GetHashCode()	Returns the hash code for this instance. (Inherited from DtsObject)
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()	Resumes execution of the task after pausing. The task or container is resumed by the runtime engine.
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)	Sets the wrapped executable for the container.
SuspendExecution()	Called when the executable needs to suspend. This method is called by the runtime engine.
Validate(Connections, Variables, IDTSEvents, IDTSLogging)	Allows the container to determine if it contains invalid settings that will prevent it from executing successfully.

Events

Disposed

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

Applies to

Share via