通过

ForEachLoopClass 类

  • 项目

此 API 支持 SQL Server 2012 基础结构，但不能通过代码直接使用。

Provides a container that defines an iterative workflow in a package using the foreach iteration statement.

继承层次结构

System.Object
  Microsoft.SqlServer.Dts.Runtime.Wrapper.ForEachLoopClass

命名空间：  Microsoft.SqlServer.Dts.Runtime.Wrapper
程序集：  Microsoft.SqlServer.DTSRuntimeWrap（在 Microsoft.SqlServer.DTSRuntimeWrap.dll 中）

语法

声明
<ClassInterfaceAttribute(ClassInterfaceType.None)> _
<GuidAttribute("DEFA06B0-9DF0-47B4-BF57-B8A602F99E91")> _
Public Class ForEachLoopClass _
    Implements IDTSExecutable100, ForEachLoop, IDTSForEachLoop100, IDTSContainer100,  _
    IDTSSequence100, IDTSEventsProvider100, IDTSExecutionMetrics100, IDTSPropertiesProvider100, IDTSBreakpointSite100,  _
    IDTSSuspend100, IDTSPersist100, IDTSRuntimeObject100, IDTSName100
用法
Dim instance As ForEachLoopClass

[ClassInterfaceAttribute(ClassInterfaceType.None)]
[GuidAttribute("DEFA06B0-9DF0-47B4-BF57-B8A602F99E91")]
public class ForEachLoopClass : IDTSExecutable100, 
    ForEachLoop, IDTSForEachLoop100, IDTSContainer100, IDTSSequence100, IDTSEventsProvider100, 
    IDTSExecutionMetrics100, IDTSPropertiesProvider100, IDTSBreakpointSite100, IDTSSuspend100, IDTSPersist100, 
    IDTSRuntimeObject100, IDTSName100

[ClassInterfaceAttribute(ClassInterfaceType::None)]
[GuidAttribute(L"DEFA06B0-9DF0-47B4-BF57-B8A602F99E91")]
public ref class ForEachLoopClass : IDTSExecutable100, 
    ForEachLoop, IDTSForEachLoop100, IDTSContainer100, IDTSSequence100, IDTSEventsProvider100, 
    IDTSExecutionMetrics100, IDTSPropertiesProvider100, IDTSBreakpointSite100, IDTSSuspend100, IDTSPersist100, 
    IDTSRuntimeObject100, IDTSName100

[<ClassInterfaceAttribute(ClassInterfaceType.None)>]
[<GuidAttribute("DEFA06B0-9DF0-47B4-BF57-B8A602F99E91")>]
type ForEachLoopClass =  
    class 
        interface IDTSExecutable100 
        interface ForEachLoop 
        interface IDTSForEachLoop100 
        interface IDTSContainer100 
        interface IDTSSequence100 
        interface IDTSEventsProvider100 
        interface IDTSExecutionMetrics100 
        interface IDTSPropertiesProvider100 
        interface IDTSBreakpointSite100 
        interface IDTSSuspend100 
        interface IDTSPersist100 
        interface IDTSRuntimeObject100 
        interface IDTSName100 
    end

public class ForEachLoopClass implements IDTSExecutable100, ForEachLoop, IDTSForEachLoop100, IDTSContainer100, IDTSSequence100, IDTSEventsProvider100, IDTSExecutionMetrics100, IDTSPropertiesProvider100, IDTSBreakpointSite100, IDTSSuspend100, IDTSPersist100, IDTSRuntimeObject100, IDTSName100

ForEachLoopClass 类型公开以下成员。

构造函数

  名称 说明
公共方法 ForEachLoopClass 基础结构。Initializes a new instance of the ForEachLoopClass class.

页首

属性

  名称 说明
公共属性 CreationName 基础结构。Returns the string that is used to create an instance of the ForEachLoopClass object. This property is read-only.
公共属性 DebugMode 基础结构。Gets or sets a Boolean that indicates whether the ForEachLoopClass object is in debug mode and whether it should fire the OnBreakpointHit 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 ForEachLoopClass object.
公共属性 Disable 基础结构。Gets a Boolean that indicates whether the ForEachLoopClass object is disabled.
公共属性 DisableEventHandlers 基础结构。Gets a Boolean that indicates whether event handlers on task are disabled.
公共属性 EventHandlers 基础结构。Gets a collection of event handler objects. This field is read-only.
公共属性 EventInfos 基础结构。Gets a collection of IDTSEventInfo100 objects. This field is read-only.
公共属性 Executables 基础结构。Gets a collection of executable objects.
公共属性 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 ForEachLoopClass object.
公共属性 ExecutionStatus 基础结构。Returns a value that indicates the current status of the execution of the ForEachLoopClass object at the time of the call.
公共属性 FailPackageOnFailure 基础结构。Gets or sets a Boolean that indicates whether the package fails when a child container fails.
公共属性 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 DTSExecResult 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.
公共属性 ForEachEnumerator 基础结构。Gets or sets a host for the IDTSForEachEnumerator100.
公共属性 ID 基础结构。Gets the GUID of the ForEachLoopClass. The value is read-only.
公共属性 IDTSSuspend100_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.
公共属性 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 ForEachLoopClass object.
公共属性 LocaleID 基础结构。Gets or sets an Integer that indicates the Microsoft Win32® localeID to use when the ForEachLoopClass object is executed.
公共属性 LogEntryInfos 基础结构。Gets the IDTSLogEntryInfos100 object for the container. 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 基础结构。Gets 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 ForEachLoopClass object stops running.
公共属性 Name 基础结构。Gets or sets the name of the ForEachLoopClass.
公共属性 Parent 基础结构。Gets the parent container. The value is read-only.
公共属性 PrecedenceConstraints 基础结构。Gets an IDTSPrecedenceConstraints100 collection that contains all of the precedence constraints associated with the ForEachLoop.
公共属性 Properties 基础结构。Returns a collection of IDTSProperty100 objects associated with the ForEachLoop.
公共属性 StartTime 基础结构。Gets the time that the container began execution. This property is read-only.
公共属性 StopTime 基础结构。Gets 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 基础结构。Gets an IDTSVariableDispenser100 object so variables associated with the container can be locked.
公共属性 VariableMappings 基础结构。Gets an IDTSForEachVariableMappings100 collection that contains the variable mappings for the ForEachLoop.
公共属性 Variables 基础结构。Returns a collection that contains the variables associated with this container. This property is read-only.

页首

方法

  名称 说明
公共方法 AcceptBreakpointManager 基础结构。Accepts an IDTSBreakpointManager100 manager, that is called by the run-time engine when a task or container is created, 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.
公共方法 ComputeExpressions 基础结构。Computes the expressions in the property collection.
公共方法 Equals （从 Object 继承。）
公共方法 Execute 基础结构。Executes the executable.
受保护方法 Finalize （从 Object 继承。）
公共方法 GetExpression 基础结构。Returns a String that contains the expression for the specified property. Null means no expression is assigned.
公共方法 GetHashCode （从 Object 继承。）
公共方法 GetParentID 基础结构。Gets the ID of the parent container.
公共方法 GetType （从 Object 继承。）
公共方法 IDTSForEachLoop100_Execute 基础结构。Executes the executable.
公共方法 IDTSForEachLoop100_Validate 基础结构。Verify that the executable will successfully execute by validating all its dependencies and other items before executing it.
公共方法 IDTSSuspend100_ResumeExecution 基础结构。Resumes execution of the task after pausing. The task or container is resumed by the runtime engine.
公共方法 IDTSSuspend100_SuspendExecution 基础结构。Indicates that the executable needs to suspend. This method is called by the runtime engine.
公共方法 LoadFromXML 基础结构。Loads data stored in XML format.
受保护方法 MemberwiseClone （从 Object 继承。）
公共方法 RegenerateID 基础结构。For more information, see ForEachLoop.
公共方法 ResumeExecution 基础结构。Resumes execution of the task after pausing. The task or container is resumed by the runtime engine.
公共方法 SaveToXML 基础结构。Saves information to an XML document.
公共方法 SetExpression 基础结构。Assigns the specified expression to the property. Specify nullnull 引用（在 Visual Basic 中为 Nothing） to remove an existing expression from the property.
公共方法 SuspendExecution 基础结构。Indicates that the executable needs to suspend. This method is called by the runtime engine.
公共方法 ToString （从 Object 继承。）
公共方法 Validate 基础结构。Verify that the executable will successfully execute by validating all its dependencies and other items before executing it.

页首

线程安全

此类型的任何公共 static（在 Visual Basic 中为 Shared） 成员都是线程安全的。不保证所有实例成员都是线程安全的。

请参阅

参考

Microsoft.SqlServer.Dts.Runtime.Wrapper 命名空间