ForLoopClass Class

 

This API supports the product 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.

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

System::Object
  Microsoft.SqlServer.Dts.Runtime.Wrapper.Sql2014::ForLoopClass

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

NameDescription
System_CAPS_pubmethodForLoopClass()

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

Initializes a new instance of the ForLoopClass class.

NameDescription
System_CAPS_pubpropertyAssignExpression

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

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

System_CAPS_pubpropertyCreationName

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

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.

System_CAPS_pubpropertyDebugMode

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

Gets or sets a Boolean that indicates whether a task should check if breakpoints are enabled.

System_CAPS_pubpropertyDelayValidation

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

Gets or sets a value that indicates whether validation of the task is delayed until run time.

System_CAPS_pubpropertyDescription

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

Gets or sets a description about the object.

System_CAPS_pubpropertyDisable

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

Gets or sets a value that indicates whether the IDTSContainer100 object is disabled.

System_CAPS_pubpropertyDisableEventHandlers

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

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

System_CAPS_pubpropertyEvalExpression

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

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

System_CAPS_pubpropertyEventHandlers

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

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

System_CAPS_pubpropertyEventInfos

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

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

System_CAPS_pubpropertyExecutables

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

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

System_CAPS_pubpropertyExecutionDuration

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

Returns a value that indicates the amount of time that the container spent in execution, in milliseconds. This property is read-only.

System_CAPS_pubpropertyExecutionResult

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

Gets a value that indicates the success or failure of the execution of the IDTSContainer100 object.

System_CAPS_pubpropertyExecutionStatus

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

Gets the current status of the execution of the IDTSContainer100 object at the time of the call.

System_CAPS_pubpropertyFailPackageOnFailure

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

Gets or sets a value that indicates whether the package fails when a child container fails.

System_CAPS_pubpropertyFailParentOnFailure

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

Gets or sets a value that indicates whether the parent container fails when a child container fails.

System_CAPS_pubpropertyForcedExecutionValue

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

When ForceExecutionValue is true, gets or sets a value that specifies the optional execution value that the package returns.

System_CAPS_pubpropertyForceExecutionResult

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

Gets or sets the forced execution result of the container.

System_CAPS_pubpropertyForceExecutionValue

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

Gets or sets the forced execution result of the container.

System_CAPS_pubpropertyID

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

Returns a unique ID assigned to the object. This is usually a GUID. This property is read-only.

System_CAPS_pubpropertyIDTSSuspend100_SuspendRequired

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

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.

System_CAPS_pubpropertyInitExpression

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

Gets or sets an optional initialization expression.

System_CAPS_pubpropertyIsDefaultLocaleID

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

Gets a value that indicates whether the container uses the default locale.

System_CAPS_pubpropertyIsolationLevel

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

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

System_CAPS_pubpropertyLocaleID

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

Gets or sets the identifier of the locale to use when the IDTSContainer100 object is executed.

System_CAPS_pubpropertyLogEntryInfos

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

Gets a collection of information about a log entry.

System_CAPS_pubpropertyLoggingMode

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

Gets or sets the logging mode of the container.

System_CAPS_pubpropertyLoggingOptions

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

Gets an object that contains properties that indicates the filtering and logging resource for containers.

System_CAPS_pubpropertyMaximumErrorCount

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

Gets or sets the maximum number of errors that can occur before the container stops running.

System_CAPS_pubpropertyName

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

Gets or sets a name assigned to the object.

System_CAPS_pubpropertyParent

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

Gets the parent of the container.

System_CAPS_pubpropertyPrecedenceConstraints

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

Returns IDTSPrecedenceConstraints100 collection. This field is read-only.

System_CAPS_pubpropertyProperties

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

Returns a set of properties for the ForLoopClass into a IDTSProperties100 collection.

System_CAPS_pubpropertyStartTime

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

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

System_CAPS_pubpropertyStopTime

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

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

System_CAPS_pubpropertySuspendRequired

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

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.

System_CAPS_pubpropertyTransactionOption

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

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

System_CAPS_pubpropertyVariableDispenser

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

Gets an IDTSVariableDispenser100 object so variables associated with the container can be locked.

System_CAPS_pubpropertyVariables

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

Gets a collection that contains the variables associated with this container.

NameDescription
System_CAPS_pubmethodAcceptBreakpointManager(IDTSBreakpointManager100^)

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

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.

System_CAPS_pubmethodComputeExpressions(Boolean)

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

Computes the expressions of the ForLoopClass object.

System_CAPS_pubmethodEquals(Object^)

(Inherited from Object.)

System_CAPS_pubmethodExecute(IDTSConnections100^, IDTSVariables100^, IDTSEvents100^, IDTSLogging100^, Object^)

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

Executes the executable.

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetExpression(String^)

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

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

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetParentID()

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

Gets the parent identifier of this container.

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodIDTSForLoop100_Execute(IDTSConnections100^, IDTSVariables100^, IDTSEvents100^, IDTSLogging100^, Object^)

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

Executes the executable.

System_CAPS_pubmethodIDTSForLoop100_Validate(IDTSConnections100^, IDTSVariables100^, IDTSEvents100^, IDTSLogging100^)

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

Verify that the executable will successfully execute by validating all its dependencies and other items before executing it.

System_CAPS_pubmethodIDTSSuspend100_ResumeExecution()

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

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

System_CAPS_pubmethodIDTSSuspend100_SuspendExecution()

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

Indicates that the executable needs to suspend. This method is called by the runtime engine.

System_CAPS_pubmethodLoadFromXML(Object^, IDTSEvents100^)

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

Loads data stored in XML format.

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodRegenerateID()

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

Creates a new identifier for the container and updates the container identifier.

System_CAPS_pubmethodResumeExecution()

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

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

System_CAPS_pubmethodSaveToXML(Object^, Object^, IDTSEvents100^)

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

Saves information to an XML document.

System_CAPS_pubmethodSetExpression(String^, String^)

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

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

System_CAPS_pubmethodSuspendExecution()

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

Indicates that the executable needs to suspend. This method is called by the runtime engine.

System_CAPS_pubmethodToString()

(Inherited from Object.)

System_CAPS_pubmethodValidate(IDTSConnections100^, IDTSVariables100^, IDTSEvents100^, IDTSLogging100^)

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

Verify that the executable will successfully execute by validating all its dependencies and other items before executing it.

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.

Return to top
Show: