DtsContainer Class
TOC
Collapse the table of content
Expand the table of content

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

NameDescription
System_CAPS_protmethodDtsContainer(IDTSContainer100)

Initializes a new instance of the DtsContainer class.

NameDescription
System_CAPS_pubpropertyCreationName

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

System_CAPS_pubpropertyDebugMode

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.

System_CAPS_pubpropertyDelayValidation

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

System_CAPS_pubpropertyDescription

Gets or sets the description of the DtsContainer object.

System_CAPS_pubpropertyDisable

A Boolean that indicates if the DtsContainer object is disabled.

System_CAPS_pubpropertyExecutionDuration

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

System_CAPS_pubpropertyExecutionResult

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

System_CAPS_pubpropertyExecutionStatus

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

System_CAPS_pubpropertyFailPackageOnFailure

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.

System_CAPS_pubpropertyFailParentOnFailure

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

System_CAPS_pubpropertyForcedExecutionValue

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

System_CAPS_pubpropertyForceExecutionResult

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

System_CAPS_pubpropertyForceExecutionValue

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

System_CAPS_pubpropertyID

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

System_CAPS_pubpropertyIsDefaultLocaleID

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

System_CAPS_pubpropertyIsolationLevel

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

System_CAPS_pubpropertyLocaleID

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

System_CAPS_pubpropertyLogEntryInfos

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

System_CAPS_pubpropertyLoggingMode

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

System_CAPS_pubpropertyLoggingOptions

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

System_CAPS_pubpropertyMaximumErrorCount

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

System_CAPS_pubpropertyName

Gets or sets the name of the DtsContainer.

System_CAPS_pubpropertyParent

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

System_CAPS_pubpropertySite

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.

System_CAPS_pubpropertyStartTime

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

System_CAPS_pubpropertyStopTime

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

System_CAPS_pubpropertySuspendRequired

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.

System_CAPS_pubpropertyTransactionOption

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

System_CAPS_pubpropertyVariableDispenser

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

System_CAPS_pubpropertyVariables

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

NameDescription
System_CAPS_pubmethodAcceptBreakpointManager(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.

System_CAPS_pubmethodDispose()

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

System_CAPS_pubmethodEquals(Object)

Determines whether two object instances are equal.(Inherited from DtsObject.)

System_CAPS_pubmethodExecute(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).)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Returns the hash code for this instance.(Inherited from DtsObject.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodLoadFromXML(XmlNode, IDTSEvents)

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

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodResumeExecution()

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

System_CAPS_pubmethodSaveToXML(XmlDocument, XmlNode, IDTSEvents)

This method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method.

System_CAPS_protmethodSetWrappedExecutable(IDTSExecutable100)

This API supports the product infrastructure and is not intended to be used directly from your code. Sets the wrapped executable for the container.

System_CAPS_pubmethodSuspendExecution()

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

System_CAPS_pubmethodToString()

(Inherited from Object.)

System_CAPS_pubmethodValidate(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).)

NameDescription
System_CAPS_protfieldm_executable

This API supports the product infrastructure and is not intended to be used directly from your code. The executable.(Inherited from Executable.)

NameDescription
System_CAPS_pubeventDisposed

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

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft