Export (0) Print
Expand All

DtsContainer Class

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

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

public abstract class DtsContainer : Executable, 
	IDTSPersist, IDTSExecutionMetrics, IDTSName, IDTSBreakpointSite, IDTSSuspend, 
	IComponent, IDisposable

The DtsContainer type exposes the following members.

  NameDescription
Protected methodDtsContainerInitializes a new instance of the DtsContainer class.
Top

  NameDescription
Public propertyCreationNameReturns the string that is used to create an instance of the DtsContainer object. This property is read-only.
Public propertyDebugModeGets 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 propertyDelayValidationGets or sets a Boolean that indicates whether validation of the task is delayed until run time. The default value is false.
Public propertyDescriptionGets or sets the description of the DtsContainer object.
Public propertyDisableA Boolean that indicates if the DtsContainer object is disabled.
Public propertyExecutionDurationReturns a value that indicates the amount of time that the container spent in execution, in milliseconds. This property is read-only.
Public propertyExecutionResultReturns a value that indicates the success or failure of the execution of the DtsContainer object.
Public propertyExecutionStatusReturns a value that indicates the current status of the execution of the DtsContainer object at the time of the call.
Public propertyFailPackageOnFailureGets 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 propertyFailParentOnFailureGets or sets a Boolean that defines whether the parent container fails when a child container fails.
Public propertyForcedExecutionValueIf the ForceExecutionValue property is set to true, gets or sets a value that specifies the optional execution value that the package returns.
Public propertyForceExecutionResultGets or sets a DTSForcedExecResult enumeration value that specifies the forced execution result of the container.
Public propertyForceExecutionValueGets or sets a Boolean that indicates whether the execution value of the container should be forced to contain a particular value.
Public propertyIDReturns the ID, which is a GUID, of the DtsContainer. The value is read-only.
Public propertyIsDefaultLocaleIDA Boolean that indicates whether the container uses the default locale. This property is read-only.
Public propertyIsolationLevelGets or sets the isolation level of the transaction in the DtsContainer object.
Public propertyLocaleIDGets or sets an Integer that indicates the Microsoft Win32® localeID to use when the DtsContainer object is executed.
Public propertyLogEntryInfosReturns a LogEntryInfos object. This property is read-only.
Public propertyLoggingModeGets or sets a valid value from the DTSLoggingMode enumeration that indicates the logging mode of the container.
Public propertyLoggingOptionsReturns an object that contains properties that indicates the filtering and logging resource for containers. This property is read-only.
Public propertyMaximumErrorCountGets or sets an Integer value that indicates the maximum number of errors that can occur before the DtsContainer object stops running.
Public propertyNameGets or sets the name of the DtsContainer.
Public propertyParentReturns the parent container. The value is read-only.
Public propertySiteInfrastructure.
Public propertyStartTimeReturns the time that the container began execution. This property is read-only.
Public propertyStopTimeReturns the time that the container ended execution. This property is read-only.
Public propertySuspendRequiredGets 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 propertyTransactionOptionGets or sets a DTSTransactionOption enumeration value that indicates whether the container participates in transactions.
Public propertyVariableDispenserReturns a VariableDispenser object so variables associated with the container can be locked.
Public propertyVariablesReturns a collection that contains the variables associated with this container. This property is read-only.
Top

  NameDescription
Public methodAcceptBreakpointManagerThis 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 methodDisposePerforms application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Public methodEqualsDetermines whether two object instances are equal. (Inherited from DtsObject.)
Public methodExecuteRuns the application, container, or package as part of a package workflow. (Overrides Executable.Execute(Connections, Variables, IDTSEvents, IDTSLogging, Object).)
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCodeReturns the hash code for this instance. (Inherited from DtsObject.)
Public methodGetType (Inherited from Object.)
Public methodLoadFromXMLThis method is not callable by your application code. To load a package saved as .xml, use the Application.LoadPackage method.
Protected methodMemberwiseClone (Inherited from Object.)
Public methodResumeExecutionResumes execution of the task after pausing. The task or container is resumed by the runtime engine.
Public methodSaveToXMLThis method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method.
Protected methodSetWrappedExecutableInfrastructure.
Public methodSuspendExecutionCalled when the executable needs to suspend. This method is called by the runtime engine.
Public methodToString (Inherited from Object.)
Public methodValidateAllows the container to determine if it contains invalid settings that will prevent it from executing successfully. (Overrides Executable.Validate(Connections, Variables, IDTSEvents, IDTSLogging).)
Top

  NameDescription
Public eventDisposedAdds an event handler to listen to the Disposed event on the component.
Top

  NameDescription
Protected fieldm_executableInfrastructure. (Inherited from Executable.)
Top

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft