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
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
DtsContainer
Derived
Implements

Constructors

DtsContainer(IDTSContainer100)

初始化 DtsContainer 类的新实例。Initializes a new instance of the DtsContainer class.

Fields

m_executable

可执行文件。The executable.

(Inherited from Executable)

Properties

CreationName

返回用于创建 DtsContainer 对象实例的字符串。Returns the string that is used to create an instance of the DtsContainer object. 此属性为只读。This property is read-only.

DebugMode

获取或设置一个布尔值,该值指示 DtsContainer 对象是否处于调试模式,以及在运行时是否应激发 OnBreakpointHit(IDTSBreakpointSite, BreakpointTarget) 事件。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. 默认值为 false。The default value is false.

Description

获取或设置 DtsContainer 对象的说明。Gets or sets the description of the DtsContainer object.

Disable

指示是否禁用对象的布尔值 DtsContainerA 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

返回指示 DtsContainer 对象执行是成功还是失败的值。Returns a value that indicates the success or failure of the execution of the DtsContainer object.

ExecutionStatus

返回指示在调用时 DtsContainer 对象执行的当前状态的值。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

获取或设置一个Boolean,该值定义在子容器失败时父容器是否失败。Gets or sets a Boolean that defines whether the parent container fails when a child container fails.

ForcedExecutionValue

如果将 ForceExecutionValue 属性设置为 True,则获取或设置一个值,该值指定包返回的可选执行值。If the ForceExecutionValue property is set to True, gets or sets a value that specifies the optional execution value that the package returns.

ForceExecutionResult

获取或设置一个 DTSForcedExecResult 枚举值,该值指定容器的强制执行结果。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

返回 ID,它是 DtsContainer 的 GUID。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

获取或设置 DtsContainer 对象中事务的隔离级别。Gets or sets the isolation level of the transaction in the DtsContainer object.

LocaleID

获取或设置一个整数,该整数指示在执行对象时要使用的 Microsoft Win32® localeID DtsContainerGets or sets an Integer that indicates the Microsoft Win32® localeID to use when the DtsContainer object is executed.

LogEntryInfos

返回一个 LogEntryInfos 对象。Returns a LogEntryInfos object. 此属性为只读。This property is read-only.

LoggingMode

获取或设置 DTSLoggingMode 枚举中的一个有效值,该值指示容器的日志记录模式。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

获取或设置一个整数值,该值指示在对象停止运行之前可以发生的最大错误数 DtsContainerGets or sets an Integer value that indicates the maximum number of errors that can occur before the DtsContainer object stops running.

Name

获取或设置 DtsContainer 的名称。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

获取或设置一个 DTSTransactionOption 枚举值,该值指示容器是否参与事务。Gets or sets a DTSTransactionOption enumeration value that indicates whether the container participates in transactions.

VariableDispenser

返回一个 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)

在创建任务或容器时由运行时引擎调用此方法,并且为其传递 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. 若要加载保存为 .xml 的包,请使用 LoadPackage(String, IDTSEvents) 方法。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. 若将包保存为 .xml,请使用 SaveToXml(String, Package, IDTSEvents) 方法。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

添加用于侦听组件的 Disposed 事件的事件处理程序。Adds an event handler to listen to the Disposed event on the component.

Applies to