ForEachLoop 类

定义

提供使用 foreach 迭代语句在包中定义迭代工作流的容器。

public ref class ForEachLoop sealed : Microsoft::SqlServer::Dts::Runtime::EventsProvider, Microsoft::SqlServer::Dts::Runtime::IDTSExecutionPath, Microsoft::SqlServer::Dts::Runtime::IDTSPackagePath, Microsoft::SqlServer::Dts::Runtime::IDTSPropertiesProvider, Microsoft::SqlServer::Dts::Runtime::IDTSPropertiesProviderEx, Microsoft::SqlServer::Dts::Runtime::IDTSSequence
public sealed class ForEachLoop : Microsoft.SqlServer.Dts.Runtime.EventsProvider, Microsoft.SqlServer.Dts.Runtime.IDTSExecutionPath, Microsoft.SqlServer.Dts.Runtime.IDTSPackagePath, Microsoft.SqlServer.Dts.Runtime.IDTSPropertiesProvider, Microsoft.SqlServer.Dts.Runtime.IDTSPropertiesProviderEx, Microsoft.SqlServer.Dts.Runtime.IDTSSequence
type ForEachLoop = class
    inherit EventsProvider
    interface IDTSSequence
    interface IDTSPropertiesProvider
    interface IDTSPropertiesProviderEx
    interface IDTSPackagePath
    interface IDTSExecutionPath
Public NotInheritable Class ForEachLoop
Inherits EventsProvider
Implements IDTSExecutionPath, IDTSPackagePath, IDTSPropertiesProvider, IDTSPropertiesProviderEx, IDTSSequence
继承
实现

注解

在运行时,容器中的 ForEachLoop 控制流在整体包控制流中重复。

字段

m_executable

可执行文件。

(继承自 Executable)

属性

CreationName

返回用于创建 DtsContainer 对象实例的字符串。 此属性为只读。

(继承自 DtsContainer)
DebugMode

获取或设置一个布尔值,该值指示对象是否 DtsContainer 处于调试模式,以及它是否应在运行时触发 OnBreakpointHit(IDTSBreakpointSite, BreakpointTarget) 事件。

(继承自 DtsContainer)
DelayValidation

获取或设置一个布尔值,该值指示验证任务是否延迟到运行时。 默认值为 false。

(继承自 DtsContainer)
Description

获取或设置 DtsContainer 对象的说明。

(继承自 DtsContainer)
Disable

一个布尔值,指示对象是否 DtsContainer 被禁用。

(继承自 DtsContainer)
DisableEventHandlers

获取或设置一个布尔值,该值指示是否禁用任务上的事件处理程序。

(继承自 EventsProvider)
EventHandlers

返回事件处理程序对象的集合。 此字段为只读。

(继承自 EventsProvider)
EventInfos

返回 EventInfo 对象的集合。 此字段为只读。

(继承自 EventsProvider)
Executables

返回在 Executable 执行期间由数据转换运行时引擎处理的 ForEachLoop 对象的集合。 此字段为只读。

ExecutionDuration

返回一个值,该值指示在容器中执行所需的时间(毫秒)。 此属性为只读。

(继承自 DtsContainer)
ExecutionResult

返回指示 DtsContainer 对象执行是成功还是失败的值。

(继承自 DtsContainer)
ExecutionStatus

返回指示在调用时 DtsContainer 对象执行的当前状态的值。

(继承自 DtsContainer)
FailPackageOnFailure

获取或设置一个布尔值,该值指示子容器失败时包是否失败。 此属性用于容器,不用于包本身。

(继承自 DtsContainer)
FailParentOnFailure

获取或设置一个Boolean,该值定义在子容器失败时父容器是否失败。

(继承自 DtsContainer)
ForcedExecutionValue

ForceExecutionValue如果该属性设置为 True,则获取或设置一个值,该值指定包返回的可选执行值。

(继承自 DtsContainer)
ForceExecutionResult

获取或设置一个 DTSForcedExecResult 枚举值,该值指定容器的强制执行结果。

(继承自 DtsContainer)
ForceExecutionValue

获取或设置一个布尔值,该值指示容器的执行值是否应强制包含特定值。

(继承自 DtsContainer)
ForEachEnumerator

获取或设置 ForEachEnumerator 的宿主。

HasExpressions

获取一个值,该值指示 ForEachLoop 对象是否具有表达式。

ID

返回 ID,它是 DtsContainer 的 GUID。 该值为只读的。

(继承自 DtsContainer)
IsDefaultLocaleID

一个布尔值,指示容器是否使用默认区域设置。 此属性为只读。

(继承自 DtsContainer)
IsolationLevel

获取或设置 DtsContainer 对象中事务的隔离级别。

(继承自 DtsContainer)
LocaleID

获取或设置一个 Integer 类型的值,该值指示执行对象时 DtsContainer 要使用的 Microsoft Win32® 区域设置 ID。

(继承自 DtsContainer)
LogEntryInfos

返回一个 LogEntryInfos 对象。 此属性为只读。

(继承自 DtsContainer)
LoggingMode

获取或设置 DTSLoggingMode 枚举中的一个有效值,该值指示容器的日志记录模式。

(继承自 DtsContainer)
LoggingOptions

返回一个对象,该对象包含指示容器的筛选和日志记录资源的属性。 此属性为只读。

(继承自 DtsContainer)
MaximumErrorCount

获取或设置一个 Integer 值,该值指示对象停止运行之前 DtsContainer 可能发生的最大错误数。

(继承自 DtsContainer)
Name

获取或设置 DtsContainer 的名称。

(继承自 DtsContainer)
Parent

返回父容器。 该值为只读的。

(继承自 DtsContainer)
PrecedenceConstraints

返回包含与 PrecedenceConstraints 关联的所有优先约束的 ForEachLoop 集合。

Properties

返回与 DtsProperty 关联的 ForEachLoop 对象的集合。

Site

获取或设置容器的站点。

(继承自 DtsContainer)
StartTime

返回容器开始执行的时间。 此属性为只读。

(继承自 DtsContainer)
StopTime

返回容器结束执行的时间。 此属性为只读。

(继承自 DtsContainer)
SuspendRequired

获取或设置一个布尔值,该值指示任务在遇到断点时是否应挂起。 遇到断点时,将由任务和容器的运行时引擎设置此值。

(继承自 DtsContainer)
TransactionOption

获取或设置一个 DTSTransactionOption 枚举值,该值指示容器是否参与事务。

(继承自 DtsContainer)
VariableDispenser

返回一个 VariableDispenser 对象,以便可以锁定与容器关联的变量。

(继承自 DtsContainer)
VariableMappings

返回包含 ForEachVariableMappings 的变量映射的 ForEachLoop 集合。

Variables

返回一个集合,其中包含与此容器关联的变量。 此属性为只读。

(继承自 DtsContainer)

方法

AcceptBreakpointManager(BreakpointManager)

在创建任务或容器时由运行时引擎调用此方法,并且为其传递 BreakpointManager 管理器,以便使任务能够创建、删除和检查断点的状态。 此方法由运行时调用,在代码中未使用。

(继承自 DtsContainer)
Dispose()

执行与释放或重置非托管资源关联的应用程序定义的任务。

(继承自 DtsContainer)
Equals(Object)

确定两个对象实例是否相等。

(继承自 DtsObject)
Execute(Connections, Variables, IDTSEvents, IDTSLogging, Object)

将应用程序、容器或包作为包工作流的一部分运行。

(继承自 DtsContainer)
GetExecutionPath()

获取 ForEachLoop 对象的执行路径。

GetExpression(String)

返回一个字符串,该字符串包含指定属性的表达式。 Null 表示未分配任何表达式。

GetHashCode()

返回此实例的哈希代码。

(继承自 DtsObject)
GetPackagePath()

返回一个字符串,其中包含包位置的相对路径。

LoadFromXML(XmlNode, IDTSEvents)

此方法不能由应用程序代码调用。 若要加载保存为 .xml 的包,请使用 LoadPackage(String, IDTSEvents) 方法。

(继承自 DtsContainer)
ResumeExecution()

暂停后恢复执行任务。 由运行时引擎恢复任务或容器。

(继承自 DtsContainer)
SaveToXML(XmlDocument, XmlNode, IDTSEvents)

此方法不能由应用程序代码调用。 若将包保存为 .xml,请使用 SaveToXml(String, Package, IDTSEvents) 方法。

(继承自 DtsContainer)
SetExpression(String, String)

将指定的表达式分配给属性。 指定 null 以从属性中删除现有表达式。

SetWrappedExecutable(IDTSExecutable100)

返回包装的可执行对象。

(继承自 EventsProvider)
SuspendExecution()

可执行文件需要挂起时调用。 运行时引擎调用此方法。

(继承自 DtsContainer)
Validate(Connections, Variables, IDTSEvents, IDTSLogging)

允许容器确定它是否包含阻止其成功执行的无效设置。

(继承自 DtsContainer)

事件

Disposed

添加用于侦听组件的 Disposed 事件的事件处理程序。

(继承自 DtsContainer)

适用于