Export (0) Print
Expand All

ForLoopClass Class

This API supports the SQL Server 2012 infrastructure and is not intended to be used directly from your code.

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

Object
  Microsoft.SqlServer.Dts.Runtime.Wrapper.ForLoopClass

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

[GuidAttribute("C4F485A2-0CD1-4D6A-A781-CDED435B2249")]
[ClassInterfaceAttribute(ClassInterfaceType.None)]
[TypeLibTypeAttribute(TypeLibTypeFlags.FCanCreate)]
[DefaultMemberAttribute("StartTime")]
public class ForLoopClass : IDTSExecutable100, 
	ForLoop, IDTSForLoop100, IDTSContainer100, IDTSSequence100, IDTSEventsProvider100, 
	IDTSExecutionMetrics100, IDTSPropertiesProvider100, IDTSBreakpointSite100, IDTSSuspend100, IDTSPersist100, 
	IDTSRuntimeObject100, IDTSName100

The ForLoopClass type exposes the following members.

  NameDescription
Public methodForLoopClassInfrastructure. Initializes a new instance of the ForLoopClass class.
Top

  NameDescription
Public propertyAssignExpressionInfrastructure. Gets or sets an expression to increment or decrement the loop counter.
Public propertyCreationNameInfrastructure. 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.
Public propertyDebugModeInfrastructure. Gets or sets a Boolean that indicates whether a task should check if breakpoints are enabled.
Public propertyDelayValidationInfrastructure. Gets or sets a value that indicates whether validation of the task is delayed until run time.
Public propertyDescriptionInfrastructure. Gets or sets a description about the object.
Public propertyDisableInfrastructure. Gets or sets a value that indicates whether the IDTSContainer100 object is disabled.
Public propertyDisableEventHandlersInfrastructure. Gets or sets a Boolean that indicates whether the event handlers on task are disabled.
Public propertyEvalExpressionInfrastructure. Gets or sets the expression that is evaluated on each pass of the loop.
Public propertyEventHandlersInfrastructure. Returns a collection of event handler objects. This field is read-only.
Public propertyEventInfosInfrastructure. Returns a collection of IDTSEventInfo100 objects. This field is read-only.
Public propertyExecutablesInfrastructure. Returns a collection of executable objects that are processed during the ForLoopClass iteration.
Public propertyExecutionDurationInfrastructure. Returns a value that indicates the amount of time that the container spent in execution, in milliseconds. This property is read-only.
Public propertyExecutionResultInfrastructure. Gets a value that indicates the success or failure of the execution of the IDTSContainer100 object.
Public propertyExecutionStatusInfrastructure. Gets the current status of the execution of the IDTSContainer100 object at the time of the call.
Public propertyFailPackageOnFailureInfrastructure. Gets or sets a value that indicates whether the package fails when a child container fails.
Public propertyFailParentOnFailureInfrastructure. Gets or sets a value that indicates whether the parent container fails when a child container fails.
Public propertyForcedExecutionValueInfrastructure. When ForceExecutionValue is true, gets or sets a value that specifies the optional execution value that the package returns.
Public propertyForceExecutionResultInfrastructure. Gets or sets the forced execution result of the container.
Public propertyForceExecutionValueInfrastructure. Gets or sets a value that indicates whether the execution value of the container should be forced to contain a particular value.
Public propertyIDInfrastructure. Returns a unique ID assigned to the object. This is usually a GUID. This property is read-only.
Public propertyIDTSSuspend100_SuspendRequiredInfrastructure. 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.
Public propertyInitExpressionInfrastructure. Gets or sets an optional initialization expression.
Public propertyIsDefaultLocaleIDInfrastructure. Gets a value that indicates whether the container uses the default locale.
Public propertyIsolationLevelInfrastructure. Gets or sets the isolation level of the transaction in the IDTSContainer100 object.
Public propertyLocaleIDInfrastructure. Gets or sets the identifier of the locale to use when the IDTSContainer100 object is executed.
Public propertyLogEntryInfosInfrastructure. Gets a collection of information about a log entry.
Public propertyLoggingModeInfrastructure. Gets or sets the logging mode of the container.
Public propertyLoggingOptionsInfrastructure. Gets an object that contains properties that indicates the filtering and logging resource for containers.
Public propertyMaximumErrorCountInfrastructure. Gets or sets the maximum number of errors that can occur before the container stops running.
Public propertyNameInfrastructure. Gets or sets a name assigned to the object.
Public propertyParentInfrastructure. Gets the parent of the container.
Public propertyPrecedenceConstraintsInfrastructure. Returns a IDTSPrecedenceConstraints100 collection. This field is read-only.
Public propertyPropertiesInfrastructure. Returns a set of properties for the ForLoopClass into a IDTSProperties100 collection.
Public propertyStartTimeInfrastructure. Returns the time that the container began execution. This property is read-only.
Public propertyStopTimeInfrastructure. Returns the time that the container ended execution. This property is read-only.
Public propertySuspendRequiredInfrastructure. 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.
Public propertyTransactionOptionInfrastructure. Gets or sets a DTSTransactionOption enumeration value that indicates whether the container participates in transactions.
Public propertyVariableDispenserInfrastructure. Gets an IDTSVariableDispenser100 object so variables associated with the container can be locked.
Public propertyVariablesInfrastructure. Gets a collection that contains the variables associated with this container.
Top

  NameDescription
Public methodAcceptBreakpointManagerInfrastructure. 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.
Public methodComputeExpressionsInfrastructure. Computes the expressions of the ForLoopClass object.
Public methodEquals (Inherited from Object.)
Public methodExecuteInfrastructure. Executes the executable.
Protected methodFinalize (Inherited from Object.)
Public methodGetExpressionInfrastructure. Returns a String that contains the expression for the specified property. Null means no expression is assigned.
Public methodGetHashCode (Inherited from Object.)
Public methodGetParentIDInfrastructure. Gets the parent identifier of this container.
Public methodGetType (Inherited from Object.)
Public methodIDTSForLoop100_ExecuteInfrastructure. Executes the executable.
Public methodIDTSForLoop100_ValidateInfrastructure. Verify that the executable will successfully execute by validating all its dependencies and other items before executing it.
Public methodIDTSSuspend100_ResumeExecutionInfrastructure. Resumes execution of the task after pausing. The task or container is resumed by the runtime engine.
Public methodIDTSSuspend100_SuspendExecutionInfrastructure. Indicates that the executable needs to suspend. This method is called by the runtime engine.
Public methodLoadFromXMLInfrastructure. Loads data stored in XML format.
Protected methodMemberwiseClone (Inherited from Object.)
Public methodRegenerateIDInfrastructure. Creates a new identifier for the container and updates the container identifier.
Public methodResumeExecutionInfrastructure. Resumes execution of the task after pausing. The task or container is resumed by the runtime engine.
Public methodSaveToXMLInfrastructure. Saves information to an XML document.
Public methodSetExpressionInfrastructure. Assigns the specified expression to the property. Specify null to remove an existing expression from the property.
Public methodSuspendExecutionInfrastructure. Indicates that the executable needs to suspend. This method is called by the runtime engine.
Public methodToString (Inherited from Object.)
Public methodValidateInfrastructure. Verify that the executable will successfully execute by validating all its dependencies and other items before executing it.
Top

For more information, see ForLoop.

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

Community Additions

ADD
Show:
© 2014 Microsoft