ForEachLoop 类

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

继承层次结构

System.Object
  Microsoft.SqlServer.Dts.Runtime.DtsObject
    Microsoft.SqlServer.Dts.Runtime.Executable
      Microsoft.SqlServer.Dts.Runtime.DtsContainer
        Microsoft.SqlServer.Dts.Runtime.EventsProvider
          Microsoft.SqlServer.Dts.Runtime.ForEachLoop

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

语法

声明
Public NotInheritable Class ForEachLoop _
    Inherits EventsProvider _
    Implements IDTSSequence, IDTSPropertiesProvider, IDTSPropertiesProviderEx, IDTSPackagePath,  _
    IDTSExecutionPath
用法
Dim instance As ForEachLoop

public sealed class ForEachLoop : EventsProvider, 
    IDTSSequence, IDTSPropertiesProvider, IDTSPropertiesProviderEx, IDTSPackagePath, IDTSExecutionPath

public ref class ForEachLoop sealed : public EventsProvider, 
    IDTSSequence, IDTSPropertiesProvider, IDTSPropertiesProviderEx, IDTSPackagePath, IDTSExecutionPath

[<SealedAttribute>]
type ForEachLoop =  
    class 
        inherit EventsProvider 
        interface IDTSSequence 
        interface IDTSPropertiesProvider 
        interface IDTSPropertiesProviderEx 
        interface IDTSPackagePath 
        interface IDTSExecutionPath 
    end

public final class ForEachLoop extends EventsProvider implements IDTSSequence, IDTSPropertiesProvider, IDTSPropertiesProviderEx, IDTSPackagePath, IDTSExecutionPath

ForEachLoop 类型公开以下成员。

属性

	名称	说明
	CreationName	Returns the string that is used to create an instance of the DtsContainer object. This property is read-only. （从 DtsContainer 继承。）
	DebugMode	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. （从 DtsContainer 继承。）
	DelayValidation	Gets or sets a Boolean that indicates whether validation of the task is delayed until run time. The default value is false. （从 DtsContainer 继承。）
	Description	Gets or sets the description of the DtsContainer object. （从 DtsContainer 继承。）
	Disable	A Boolean that indicates if the DtsContainer object is disabled. （从 DtsContainer 继承。）
	DisableEventHandlers	Gets or sets a Boolean that indicates whether the event handlers on task are disabled. （从 EventsProvider 继承。）
	EventHandlers	Returns a collection of event handler objects. This field is read-only. （从 EventsProvider 继承。）
	EventInfos	Returns a collection of EventInfo objects. This field is read-only. （从 EventsProvider 继承。）
	Executables	Returns a collection of Executable objects processed by the Data Transformation Run-time engine during execution of the ForEachLoop. This field is read-only.
	ExecutionDuration	Returns a value that indicates the amount of time that the container spent in execution, in milliseconds. This property is read-only. （从 DtsContainer 继承。）
	ExecutionResult	Returns a value that indicates the success or failure of the execution of the DtsContainer object. （从 DtsContainer 继承。）
	ExecutionStatus	Returns a value that indicates the current status of the execution of the DtsContainer object at the time of the call. （从 DtsContainer 继承。）
	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. （从 DtsContainer 继承。）
	FailParentOnFailure	Gets or sets a Boolean that defines whether the parent container fails when a child container fails. （从 DtsContainer 继承。）
	ForcedExecutionValue	If the ForceExecutionValue property is set to True, gets or sets a value that specifies the optional execution value that the package returns. （从 DtsContainer 继承。）
	ForceExecutionResult	Gets or sets a DTSForcedExecResult enumeration value that specifies the forced execution result of the container. （从 DtsContainer 继承。）
	ForceExecutionValue	Gets or sets a Boolean that indicates whether the execution value of the container should be forced to contain a particular value. （从 DtsContainer 继承。）
	ForEachEnumerator	Gets or sets a host for the ForEachEnumerator.
	HasExpressions	Gets a value that indicates whether the ForEachLoop object has expressions.
	ID	Returns the ID, which is a GUID, of the DtsContainer. The value is read-only. （从 DtsContainer 继承。）
	IsDefaultLocaleID	A Boolean that indicates whether the container uses the default locale. This property is read-only. （从 DtsContainer 继承。）
	IsolationLevel	Gets or sets the isolation level of the transaction in the DtsContainer object. （从 DtsContainer 继承。）
	LocaleID	Gets or sets an Integer that indicates the Microsoft Win32® localeID to use when the DtsContainer object is executed. （从 DtsContainer 继承。）
	LogEntryInfos	Returns a LogEntryInfos object. This property is read-only. （从 DtsContainer 继承。）
	LoggingMode	Gets or sets a valid value from the DTSLoggingMode enumeration that indicates the logging mode of the container. （从 DtsContainer 继承。）
	LoggingOptions	Returns an object that contains properties that indicates the filtering and logging resource for containers. This property is read-only. （从 DtsContainer 继承。）
	MaximumErrorCount	Gets or sets an Integer value that indicates the maximum number of errors that can occur before the DtsContainer object stops running. （从 DtsContainer 继承。）
	Name	Gets or sets the name of the DtsContainer. （从 DtsContainer 继承。）
	Parent	Returns the parent container. The value is read-only. （从 DtsContainer 继承。）
	PrecedenceConstraints	Returns a PrecedenceConstraints collection that contains all of the precedence constraints associated with the ForEachLoop.
	Properties	Returns a collection of DtsProperty objects associated with the ForEachLoop.
	Site	基础结构。Gets or sets the site for the container. （从 DtsContainer 继承。）
	StartTime	Returns the time that the container began execution. This property is read-only. （从 DtsContainer 继承。）
	StopTime	Returns the time that the container ended execution. This property is read-only. （从 DtsContainer 继承。）
	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. （从 DtsContainer 继承。）
	TransactionOption	Gets or sets a DTSTransactionOption enumeration value that indicates whether the container participates in transactions. （从 DtsContainer 继承。）
	VariableDispenser	Returns a VariableDispenser object so variables associated with the container can be locked. （从 DtsContainer 继承。）
	VariableMappings	Returns a ForEachVariableMappings 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. （从 DtsContainer 继承。）

页首

方法

	名称	说明
	AcceptBreakpointManager	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. （从 DtsContainer 继承。）
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. （从 DtsContainer 继承。）
	Equals	Determines whether two object instances are equal. （从 DtsObject 继承。）
	Execute	Runs the application, container, or package as part of a package workflow. （从 DtsContainer 继承。）
	GetExecutionPath	Gets the execution path for the ForEachLoop object.
	GetExpression	Returns a String that contains the expression for the specified property. Null means no expression is assigned.
	GetHashCode	Returns the hash code for this instance. （从 DtsObject 继承。）
	GetPackagePath	Returns a String that contains the relative path to the package location.
	GetType	（从 Object 继承。）
	LoadFromXML	This method is not callable by your application code. To load a package saved as .xml, use the Application.LoadPackage method. （从 DtsContainer 继承。）
	ResumeExecution	Resumes execution of the task after pausing. The task or container is resumed by the runtime engine. （从 DtsContainer 继承。）
	SaveToXML	This method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method. （从 DtsContainer 继承。）
	SetExpression	Assigns the specified expression to the property. Specify nullnull 引用（在 Visual Basic 中为 Nothing） to remove an existing expression from the property.
	SuspendExecution	Called when the executable needs to suspend. This method is called by the runtime engine. （从 DtsContainer 继承。）
	ToString	（从 Object 继承。）
	Validate	Allows the container to determine if it contains invalid settings that will prevent it from executing successfully. （从 DtsContainer 继承。）

页首

事件

	名称	说明
	Disposed	Adds an event handler to listen to the Disposed event on the component. （从 DtsContainer 继承。）

页首

字段

	名称	说明
	m_executable	基础结构。The executable. （从 Executable 继承。）

页首

注释

At run time, the control flow in the ForEachLoop container is repeated within the overall package control flow.

线程安全

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

请参阅

参考

Microsoft.SqlServer.Dts.Runtime 命名空间