ForLoopClass Class

Definition

Namespace:

Microsoft.SqlServer.Dts.Runtime.Wrapper

Assembly:

Microsoft.SqlServer.DTSRuntimeWrap.dll

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

public ref class ForLoopClass : Microsoft::SqlServer::Dts::Runtime::Wrapper::ForLoop, Microsoft::SqlServer::Dts::Runtime::Wrapper::IDTSBreakpointSite100, Microsoft::SqlServer::Dts::Runtime::Wrapper::IDTSContainer100, Microsoft::SqlServer::Dts::Runtime::Wrapper::IDTSEventsProvider100, Microsoft::SqlServer::Dts::Runtime::Wrapper::IDTSExecutionMetrics100, Microsoft::SqlServer::Dts::Runtime::Wrapper::IDTSForLoop100, Microsoft::SqlServer::Dts::Runtime::Wrapper::IDTSName100, Microsoft::SqlServer::Dts::Runtime::Wrapper::IDTSPersist100, Microsoft::SqlServer::Dts::Runtime::Wrapper::IDTSPropertiesProvider100, Microsoft::SqlServer::Dts::Runtime::Wrapper::IDTSRuntimeObject100, Microsoft::SqlServer::Dts::Runtime::Wrapper::IDTSSequence100

[System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.None)]
[System.Runtime.InteropServices.TypeLibType(System.Runtime.InteropServices.TypeLibTypeFlags.FCanCreate)]
[System.Runtime.InteropServices.Guid("F8820007-A986-4DE8-8378-45CC12A343C2")]
public class ForLoopClass : Microsoft.SqlServer.Dts.Runtime.Wrapper.ForLoop, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSBreakpointSite100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSContainer100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSEventsProvider100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSExecutionMetrics100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSForLoop100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSName100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSPersist100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSPropertiesProvider100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSRuntimeObject100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSSequence100

[<System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.None)>]
[<System.Runtime.InteropServices.TypeLibType(System.Runtime.InteropServices.TypeLibTypeFlags.FCanCreate)>]
[<System.Runtime.InteropServices.Guid("F8820007-A986-4DE8-8378-45CC12A343C2")>]
type ForLoopClass = class
    interface IDTSExecutable100
    interface ForLoop
    interface IDTSForLoop100
    interface IDTSContainer100
    interface IDTSSequence100
    interface IDTSEventsProvider100
    interface IDTSExecutionMetrics100
    interface IDTSPropertiesProvider100
    interface IDTSBreakpointSite100
    interface IDTSSuspend100
    interface IDTSPersist100
    interface IDTSRuntimeObject100
    interface IDTSName100

Public Class ForLoopClass
Implements ForLoop, IDTSBreakpointSite100, IDTSContainer100, IDTSEventsProvider100, IDTSExecutionMetrics100, IDTSForLoop100, IDTSName100, IDTSPersist100, IDTSPropertiesProvider100, IDTSRuntimeObject100, IDTSSequence100

Inheritance

Object

ForLoopClass

Attributes

ClassInterfaceAttribute GuidAttribute TypeLibTypeAttribute

Implements

ForLoop IDTSBreakpointSite100 IDTSContainer100 IDTSEventsProvider100 IDTSExecutable100 IDTSExecutionMetrics100 IDTSForLoop100 IDTSName100 IDTSPersist100 IDTSPropertiesProvider100 IDTSRuntimeObject100 IDTSSequence100 IDTSSuspend100

Remarks

For more information, see ForLoop.

Constructors

ForLoopClass()

Initializes a new instance of the ForLoopClass class.

Properties

AssignExpression	Gets or sets an expression to increment or decrement the loop counter.
CreationName	Returns the name that is used by the runtime to create an instance of the object and add it to its collection, if there is a collection for the object. This property is read-only.
DebugMode	Gets or sets a Boolean that indicates whether a task should check if breakpoints are enabled.
DelayValidation	Gets or sets a value that indicates whether validation of the task is delayed until run time.
Description	Gets or sets a description about the object.
Disable	Gets or sets a value that indicates whether the IDTSContainer100 object is disabled.
DisableEventHandlers	Gets or sets a Boolean that indicates whether the event handlers on task are disabled.
EvalExpression	Gets or sets the expression that is evaluated on each pass of the loop.
EventHandlers	Returns a collection of event handler objects. This field is read-only.
EventInfos	Returns a collection of IDTSEventInfo100 objects. This field is read-only.
Executables	Returns a collection of executable objects that are processed during the ForLoopClass iteration.
ExecutionDuration	Returns a value that indicates the amount of time that the container spent in execution, in milliseconds. This property is read-only.
ExecutionResult	Gets a value that indicates the success or failure of the execution of the IDTSContainer100 object.
ExecutionStatus	Gets the current status of the execution of the IDTSContainer100 object at the time of the call.
FailPackageOnFailure	Gets or sets a value that indicates whether the package fails when a child container fails.
FailParentOnFailure	Gets or sets a value that indicates whether the parent container fails when a child container fails.
ForcedExecutionValue	When ForceExecutionValue is true, gets or sets a value that specifies the optional execution value that the package returns.
ForceExecutionResult	Gets or sets the forced execution result of the container.
ForceExecutionValue	Gets or sets a value that indicates whether the execution value of the container should be forced to contain a particular value.
ID	Returns a unique ID assigned to the object. This is usually a GUID. This property is read-only.
IDTSSuspend100_SuspendRequired	Gets or sets a Boolean that indicates whether 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.
InitExpression	Gets or sets an optional initialization expression.
IsDefaultLocaleID	Gets a value that indicates whether the container uses the default locale.
IsolationLevel	Gets or sets the isolation level of the transaction in the IDTSContainer100 object.
LocaleID	Gets or sets the identifier of the locale to use when the IDTSContainer100 object is executed.
LogEntryInfos	Gets a collection of information about a log entry.
LoggingMode	Gets or sets the logging mode of the container.
LoggingOptions	Gets an object that contains properties that indicates the filtering and logging resource for containers.
MaximumErrorCount	Gets or sets the maximum number of errors that can occur before the container stops running.
Name	Gets or sets a name assigned to the object.
Parent	Gets the parent of the container.
PrecedenceConstraints	Returns IDTSPrecedenceConstraints100 collection. This field is read-only.
Properties	Returns a set of properties for the ForLoopClass into a IDTSProperties100 collection.
StartTime	Returns the time that the container began execution. This property is read-only.
StopTime	Returns the time that the container ended execution. This property is read-only.
SuspendRequired	Gets or sets a Boolean that indicates whether 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.
Variables	Gets a collection that contains the variables associated with this container.

Methods

AcceptBreakpointManager(IDTSBreakpointManager100)	Passes a IDTSBreakpointManager100 to a task. The task will use the breakpoint manager to create, remove, and check the status of breakpoints. This method is called by the runtime and is not used in code.
ComputeExpressions(Boolean)	Computes the expressions of the ForLoopClass object.
Execute(IDTSConnections100, IDTSVariables100, IDTSEvents100, IDTSLogging100, Object)	Executes the executable.
GetExpression(String)	Returns a String that contains the expression for the specified property. Null means no expression is assigned.
GetParentID()	Gets the parent identifier of this container.
IDTSForLoop100_Execute(IDTSConnections100, IDTSVariables100, IDTSEvents100, IDTSLogging100, Object)	Executes the executable.
IDTSForLoop100_Validate(IDTSConnections100, IDTSVariables100, IDTSEvents100, IDTSLogging100)	Verify that the executable will successfully execute by validating all its dependencies and other items before executing it.
IDTSSuspend100_get_SuspendRequired()
IDTSSuspend100_ResumeExecution()	Resumes execution of the task after pausing. The task or container is resumed by the runtime engine.
IDTSSuspend100_set_SuspendRequired(Boolean)
IDTSSuspend100_SuspendExecution()	Indicates that the executable needs to suspend. This method is called by the runtime engine.
LoadFromXML(Object, IDTSEvents100)	Loads data stored in XML format.
RegenerateID()	Creates a new identifier for the container and updates the container identifier.
ResumeExecution()	Resumes execution of the task after pausing. The task or container is resumed by the runtime engine.
SaveToXML(Object, Object, IDTSEvents100)	Saves information to an XML document.
SetExpression(String, String)	Assigns the specified expression to the property. Specify null to remove an existing expression from the property.
SuspendExecution()	Indicates that the executable needs to suspend. This method is called by the runtime engine.
Validate(IDTSConnections100, IDTSVariables100, IDTSEvents100, IDTSLogging100)	Verify that the executable will successfully execute by validating all its dependencies and other items before executing it.