ForLoop ForLoop ForLoop ForLoop Class

Definition

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

public ref class ForLoop 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 ForLoop : 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 ForLoop = class
    inherit EventsProvider
    interface IDTSSequence
    interface IDTSPropertiesProvider
    interface IDTSPropertiesProviderEx
    interface IDTSPackagePath
    interface IDTSExecutionPath
Public NotInheritable Class ForLoop
Inherits EventsProvider
Implements IDTSExecutionPath, IDTSPackagePath, IDTSPropertiesProvider, IDTSPropertiesProviderEx, IDTSSequence
Inheritance
Implements

Remarks

At run time, the control flow in the ForLoop container is repeated within the overall package control flow. In each iteration of the loop, the ForLoop container evaluates an expression and repeats its workflow until the expression evaluates to false. For more information, see For Loop Container.

Properties

AssignExpression AssignExpression AssignExpression AssignExpression

Gets or sets an expression to increment or decrement the loop counter.

CreationName CreationName CreationName CreationName

Returns the string that is used to create an instance of the DtsContainer object. This property is read-only.

(Inherited from DtsContainer)
DebugMode DebugMode DebugMode DebugMode

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.

(Inherited from DtsContainer)
DelayValidation DelayValidation DelayValidation 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)
Description Description Description Description

Gets or sets the description of the DtsContainer object.

(Inherited from DtsContainer)
Disable Disable Disable Disable

A Boolean that indicates if the DtsContainer object is disabled.

(Inherited from DtsContainer)
DisableEventHandlers DisableEventHandlers DisableEventHandlers DisableEventHandlers

Gets or sets a Boolean that indicates whether the event handlers on task are disabled.

(Inherited from EventsProvider)
EvalExpression EvalExpression EvalExpression EvalExpression

Gets or sets the expression that is evaluated on each pass of the loop.

EventHandlers EventHandlers EventHandlers EventHandlers

Returns a collection of event handler objects. This field is read-only.

(Inherited from EventsProvider)
EventInfos EventInfos EventInfos EventInfos

Returns a collection of EventInfo objects. This field is read-only.

(Inherited from EventsProvider)
Executables Executables Executables Executables

Returns a collection of executable objects that are processed during the ForLoop iteration.

ExecutionDuration ExecutionDuration ExecutionDuration 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)
ExecutionResult ExecutionResult ExecutionResult ExecutionResult

Returns a value that indicates the success or failure of the execution of the DtsContainer object.

(Inherited from DtsContainer)
ExecutionStatus ExecutionStatus ExecutionStatus 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)
FailPackageOnFailure FailPackageOnFailure FailPackageOnFailure 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)
FailParentOnFailure FailParentOnFailure FailParentOnFailure FailParentOnFailure

Gets or sets a Boolean that defines whether the parent container fails when a child container fails.

(Inherited from DtsContainer)
ForcedExecutionValue ForcedExecutionValue ForcedExecutionValue 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)
ForceExecutionResult ForceExecutionResult ForceExecutionResult ForceExecutionResult

Gets or sets a DTSForcedExecResult enumeration value that specifies the forced execution result of the container.

(Inherited from DtsContainer)
ForceExecutionValue ForceExecutionValue ForceExecutionValue 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)
HasExpressions HasExpressions HasExpressions HasExpressions

Gets a value that indicates whether the ForLoop object has expressions.

ID ID ID ID

Returns the ID, which is a GUID, of the DtsContainer. The value is read-only.

(Inherited from DtsContainer)
InitExpression InitExpression InitExpression InitExpression

Gets or sets an optional initialization expression.

IsDefaultLocaleID IsDefaultLocaleID IsDefaultLocaleID IsDefaultLocaleID

A Boolean that indicates whether the container uses the default locale. This property is read-only.

(Inherited from DtsContainer)
IsolationLevel IsolationLevel IsolationLevel IsolationLevel

Gets or sets the isolation level of the transaction in the DtsContainer object.

(Inherited from DtsContainer)
LocaleID LocaleID LocaleID LocaleID

Gets or sets an Integer that indicates the Microsoft Win32® localeID to use when the DtsContainer object is executed.

(Inherited from DtsContainer)
LogEntryInfos LogEntryInfos LogEntryInfos LogEntryInfos

Returns a LogEntryInfos object. This property is read-only.

(Inherited from DtsContainer)
LoggingMode LoggingMode LoggingMode LoggingMode

Gets or sets a valid value from the DTSLoggingMode enumeration that indicates the logging mode of the container.

(Inherited from DtsContainer)
LoggingOptions LoggingOptions LoggingOptions LoggingOptions

Returns an object that contains properties that indicates the filtering and logging resource for containers. This property is read-only.

(Inherited from DtsContainer)
MaximumErrorCount MaximumErrorCount MaximumErrorCount 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)
Name Name Name Name

Gets or sets the name of the DtsContainer.

(Inherited from DtsContainer)
Parent Parent Parent Parent

Returns the parent container. The value is read-only.

(Inherited from DtsContainer)
PrecedenceConstraints PrecedenceConstraints PrecedenceConstraints PrecedenceConstraints

Returns a PrecedenceConstraints collection. This field is read-only.

Properties Properties Properties Properties

Returns a set of properties for the ForLoop into a DtsProperties collection.

Site Site Site Site

Gets or sets the site for the container.

(Inherited from DtsContainer)
StartTime StartTime StartTime StartTime

Returns the time that the container began execution. This property is read-only.

(Inherited from DtsContainer)
StopTime StopTime StopTime StopTime

Returns the time that the container ended execution. This property is read-only.

(Inherited from DtsContainer)
SuspendRequired SuspendRequired SuspendRequired 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)
TransactionOption TransactionOption TransactionOption TransactionOption

Gets or sets a DTSTransactionOption enumeration value that indicates whether the container participates in transactions.

(Inherited from DtsContainer)
VariableDispenser VariableDispenser VariableDispenser VariableDispenser

Returns a VariableDispenser object so variables associated with the container can be locked.

(Inherited from DtsContainer)
Variables Variables Variables Variables

Returns a collection that contains the variables associated with this container. This property is read-only.

(Inherited from DtsContainer)

Methods

AcceptBreakpointManager(BreakpointManager) AcceptBreakpointManager(BreakpointManager) AcceptBreakpointManager(BreakpointManager) AcceptBreakpointManager(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.

(Inherited from DtsContainer)
Dispose() Dispose() Dispose() Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

(Inherited from DtsContainer)
Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determines whether two object instances are equal.

(Inherited from DtsObject)
Execute(Connections, Variables, IDTSEvents, IDTSLogging, Object) Execute(Connections, Variables, IDTSEvents, IDTSLogging, Object) Execute(Connections, Variables, IDTSEvents, IDTSLogging, Object) Execute(Connections, Variables, IDTSEvents, IDTSLogging, Object)

Runs the application, container, or package as part of a package workflow.

(Inherited from DtsContainer)
GetExecutionPath() GetExecutionPath() GetExecutionPath() GetExecutionPath()

Gets the execution path for the ForLoop object.

GetExpression(String) GetExpression(String) GetExpression(String) GetExpression(String)

Returns a String that contains the expression for the specified property. Null means no expression is assigned.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Returns the hash code for this instance.

(Inherited from DtsObject)
GetPackagePath() GetPackagePath() GetPackagePath() GetPackagePath()

Returns a String that contains the relative path to the package location.

LoadFromXML(XmlNode, IDTSEvents) LoadFromXML(XmlNode, IDTSEvents) LoadFromXML(XmlNode, IDTSEvents) LoadFromXML(XmlNode, IDTSEvents)

This method is not callable by your application code. To load a package saved as .xml, use the LoadPackage(String, IDTSEvents) method.

(Inherited from DtsContainer)
ResumeExecution() ResumeExecution() ResumeExecution() ResumeExecution()

Resumes execution of the task after pausing. The task or container is resumed by the runtime engine.

(Inherited from DtsContainer)
SaveToXML(XmlDocument, XmlNode, IDTSEvents) SaveToXML(XmlDocument, XmlNode, IDTSEvents) SaveToXML(XmlDocument, XmlNode, IDTSEvents) SaveToXML(XmlDocument, XmlNode, IDTSEvents)

This method is not callable by your application code. To save a package as .xml, use the SaveToXml(String, Package, IDTSEvents) method.

(Inherited from DtsContainer)
SetExpression(String, String) SetExpression(String, String) SetExpression(String, String) SetExpression(String, String)

Assigns the specified expression to the property. Specify null to remove an existing expression from the property.

SetWrappedExecutable(IDTSExecutable100) SetWrappedExecutable(IDTSExecutable100) SetWrappedExecutable(IDTSExecutable100) SetWrappedExecutable(IDTSExecutable100)

Returns the wrapped executable object.

(Inherited from EventsProvider)
SuspendExecution() SuspendExecution() SuspendExecution() SuspendExecution()

Called when the executable needs to suspend. This method is called by the runtime engine.

(Inherited from DtsContainer)
Validate(Connections, Variables, IDTSEvents, IDTSLogging) Validate(Connections, Variables, IDTSEvents, IDTSLogging) Validate(Connections, Variables, IDTSEvents, IDTSLogging) Validate(Connections, Variables, IDTSEvents, IDTSLogging)

Allows the container to determine if it contains invalid settings that will prevent it from executing successfully.

(Inherited from DtsContainer)

Events

Disposed Disposed Disposed Disposed

Adds an event handler to listen to the Disposed event on the component.

(Inherited from DtsContainer)

Fields

m_executable m_executable m_executable m_executable

The executable.

(Inherited from Executable)

Applies to