Share via

ForEachLoop Class

  • Article

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

Inheritance Hierarchy

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

Namespace:  Microsoft.SqlServer.Dts.Runtime
Assembly:  Microsoft.SqlServer.ManagedDTS (in Microsoft.SqlServer.ManagedDTS.dll)

Syntax

'Declaration
Public NotInheritable Class ForEachLoop _
    Inherits EventsProvider _
    Implements IDTSSequence, IDTSPropertiesProvider, IDTSPropertiesProviderEx, IDTSPackagePath,  _
    IDTSExecutionPath
'Usage
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

The ForEachLoop type exposes the following members.

Properties

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

Top

Methods

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

Top

Events

  Name Description
Public event Disposed Adds an event handler to listen to the Disposed event on the component. (Inherited from DtsContainer.)

Top

Fields

  Name Description
Protected field m_executable Infrastructure. The executable. (Inherited from Executable.)

Top

Remarks

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

Thread Safety

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

See Also

Reference

Microsoft.SqlServer.Dts.Runtime Namespace