ForEachLoopClass 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 foreach iteration statement.

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

System.Object
  Microsoft.SqlServer.Dts.Runtime.Wrapper.ForEachLoopClass

[GuidAttribute("C2DA94B4-782A-4F02-8532-B79F2F17EF2C")]
[ClassInterfaceAttribute(ClassInterfaceType.None)]
[TypeLibTypeAttribute(TypeLibTypeFlags.FCanCreate)]
[DefaultMemberAttribute("StartTime")]
public class ForEachLoopClass : IDTSExecutable100, ForEachLoop, 
	IDTSForEachLoop100, IDTSContainer100, IDTSSequence100, IDTSEventsProvider100, 
	IDTSExecutionMetrics100, IDTSPropertiesProvider100, IDTSBreakpointSite100, 
	IDTSSuspend100, IDTSPersist100, IDTSRuntimeObject100, IDTSName100

NameDescription
System_CAPS_pubmethodForEachLoopClass()

This API supports the product infrastructure and is not intended to be used directly from your code. Initializes a new instance of the ForEachLoopClass class.

NameDescription
System_CAPS_pubpropertyCreationName

This API supports the product infrastructure and is not intended to be used directly from your code. Returns the string that is used to create an instance of the ForEachLoopClass 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 the ForEachLoopClass object is in debug mode and whether it should fire the OnBreakpointHit event while running.

System_CAPS_pubpropertyDelayValidation

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 validation of the task is delayed until run time. The default value is false.

System_CAPS_pubpropertyDescription

This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the description of the ForEachLoopClass object.

System_CAPS_pubpropertyDisable

This API supports the product infrastructure and is not intended to be used directly from your code. Gets a Boolean that indicates whether the ForEachLoopClass object is disabled.

System_CAPS_pubpropertyDisableEventHandlers

This API supports the product infrastructure and is not intended to be used directly from your code. Gets a Boolean that indicates whether event handlers on task are disabled.

System_CAPS_pubpropertyEventHandlers

This API supports the product infrastructure and is not intended to be used directly from your code. Gets 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. Gets 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. Gets a collection of executable objects.

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. Returns a value that indicates the success or failure of the execution of the ForEachLoopClass object.

System_CAPS_pubpropertyExecutionStatus

This API supports the product infrastructure and is not intended to be used directly from your code. Returns a value that indicates the current status of the execution of the ForEachLoopClass 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 Boolean 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 Boolean that defines 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. If the ForceExecutionValue property is set to 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 a DTSExecResult enumeration value that specifies 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 a Boolean that indicates whether the execution value of the container should be forced to contain a particular value.

System_CAPS_pubpropertyForEachEnumerator

This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a host for the IDTSForEachEnumerator100.

System_CAPS_pubpropertyID

This API supports the product infrastructure and is not intended to be used directly from your code. Gets the GUID of the ForEachLoopClass. The value 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 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.

System_CAPS_pubpropertyIsDefaultLocaleID

This API supports the product infrastructure and is not intended to be used directly from your code. A Boolean that indicates whether the container uses the default locale. This property is read-only.

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 ForEachLoopClass object.

System_CAPS_pubpropertyLocaleID

This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets an Integer that indicates the Microsoft Win32® localeID to use when the ForEachLoopClass object is executed.

System_CAPS_pubpropertyLogEntryInfos

This API supports the product infrastructure and is not intended to be used directly from your code. Gets the IDTSLogEntryInfos100 object for the container. This property is read-only.

System_CAPS_pubpropertyLoggingMode

This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a valid value from the DTSLoggingMode enumeration that indicates 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. This property is read-only.

System_CAPS_pubpropertyMaximumErrorCount

This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets an Integer value that indicates the maximum number of errors that can occur before the ForEachLoopClass object 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 the name of the ForEachLoopClass.

System_CAPS_pubpropertyParent

This API supports the product infrastructure and is not intended to be used directly from your code. Gets the parent container. The value is read-only.

System_CAPS_pubpropertyPrecedenceConstraints

This API supports the product infrastructure and is not intended to be used directly from your code. Gets an IDTSPrecedenceConstraints100 collection that contains all of the precedence constraints associated with the ForEachLoop.

System_CAPS_pubpropertyProperties

This API supports the product infrastructure and is not intended to be used directly from your code. Returns a collection of IDTSProperty100 objects associated with the ForEachLoop.

System_CAPS_pubpropertyStartTime

This API supports the product infrastructure and is not intended to be used directly from your code. Gets 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. Gets 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 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.

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_pubpropertyVariableMappings

This API supports the product infrastructure and is not intended to be used directly from your code. Gets an IDTSForEachVariableMappings100 collection that contains the variable mappings for the ForEachLoop.

System_CAPS_pubpropertyVariables

This API supports the product infrastructure and is not intended to be used directly from your code. Returns a collection that contains the variables associated with this container. This property is read-only.

NameDescription
System_CAPS_pubmethodAcceptBreakpointManager(IDTSBreakpointManager100)

This API supports the product infrastructure and is not intended to be used directly from your code. Accepts an IDTSBreakpointManager100 manager, that is called by the run-time engine when a task or container is created, 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.

System_CAPS_pubmethodComputeExpressions(Boolean)

This API supports the product infrastructure and is not intended to be used directly from your code. Computes the expressions in the property collection.

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 ID of the parent container.

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodIDTSForEachLoop100_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_pubmethodIDTSForEachLoop100_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. For more information, see ForEachLoop.

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.

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: