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

public ref class ForEachLoopClass : Microsoft::SqlServer::Dts::Runtime::Wrapper::ForEachLoop, 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::IDTSForEachLoop100, 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("B4239650-285C-4F45-8F7B-759C3009A565")]
public class ForEachLoopClass : Microsoft.SqlServer.Dts.Runtime.Wrapper.ForEachLoop, 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.IDTSForEachLoop100, 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("B4239650-285C-4F45-8F7B-759C3009A565")>]
type ForEachLoopClass = class
    interface IDTSExecutable100
    interface ForEachLoop
    interface IDTSForEachLoop100
    interface IDTSContainer100
    interface IDTSSequence100
    interface IDTSEventsProvider100
    interface IDTSExecutionMetrics100
    interface IDTSPropertiesProvider100
    interface IDTSBreakpointSite100
    interface IDTSSuspend100
    interface IDTSPersist100
    interface IDTSRuntimeObject100
    interface IDTSName100

Public Class ForEachLoopClass
Implements ForEachLoop, IDTSBreakpointSite100, IDTSContainer100, IDTSEventsProvider100, IDTSExecutionMetrics100, IDTSForEachLoop100, IDTSName100, IDTSPersist100, IDTSPropertiesProvider100, IDTSRuntimeObject100, IDTSSequence100

Inheritance

Object

ForEachLoopClass

Attributes

ClassInterfaceAttribute GuidAttribute TypeLibTypeAttribute

Implements

ForEachLoop IDTSBreakpointSite100 IDTSContainer100 IDTSEventsProvider100 IDTSExecutable100 IDTSExecutionMetrics100 IDTSForEachLoop100 IDTSName100 IDTSPersist100 IDTSPropertiesProvider100 IDTSRuntimeObject100 IDTSSequence100 IDTSSuspend100

Constructors

ForEachLoopClass()

Initializes a new instance of the ForEachLoopClass class.

Properties

CreationName	Returns the string that is used to create an instance of the ForEachLoopClass object. This property is read-only.
DebugMode	Gets or sets a Boolean that indicates whether the ForEachLoopClass object is in debug mode and whether it should fire the OnBreakpointHit(IDTSBreakpointSite100, IDTSBreakpointTarget100) event while running.
DelayValidation	Gets or sets a Boolean that indicates whether validation of the task is delayed until run time. The default value is false.
Description	Gets or sets the description of the ForEachLoopClass object.
Disable	Gets a Boolean that indicates whether the ForEachLoopClass object is disabled.
DisableEventHandlers	Gets a Boolean that indicates whether event handlers on task are disabled.
EventHandlers	Gets a collection of event handler objects. This field is read-only.
EventInfos	Gets a collection of IDTSEventInfo100 objects. This field is read-only.
Executables	Gets a collection of executable objects.
ExecutionDuration	Returns a value that indicates the amount of time that the container spent in execution, in milliseconds. This property is read-only.
ExecutionResult	Returns a value that indicates the success or failure of the execution of the ForEachLoopClass object.
ExecutionStatus	Returns a value that indicates the current status of the execution of the ForEachLoopClass object at the time of the call.
FailPackageOnFailure	Gets or sets a Boolean that indicates whether the package fails when a child container fails.
FailParentOnFailure	Gets or sets a Boolean that defines whether the parent container fails when a child container fails.
ForcedExecutionValue	If the ForceExecutionValue property is set to true, gets or sets a value that specifies the optional execution value that the package returns.
ForceExecutionResult	Gets or sets a DTSExecResult enumeration value that specifies the forced execution result of the container.
ForceExecutionValue	Gets or sets a Boolean that indicates whether the execution value of the container should be forced to contain a particular value.
ForEachEnumerator	Gets or sets a host for the IDTSForEachEnumerator100.
ID	Gets the GUID of the ForEachLoopClass. The value is read-only.
IDTSSuspend100_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.
IsDefaultLocaleID	A Boolean that indicates whether the container uses the default locale. This property is read-only.
IsolationLevel	Gets or sets the isolation level of the transaction in the ForEachLoopClass object.
LocaleID	Gets or sets an Integer that indicates the Microsoft Win32® localeID to use when the ForEachLoopClass object is executed.
LogEntryInfos	Gets the IDTSLogEntryInfos100 object for the container. This property is read-only.
LoggingMode	Gets or sets a valid value from the DTSLoggingMode enumeration that indicates the logging mode of the container.
LoggingOptions	Gets an object that contains properties that indicates the filtering and logging resource for containers. This property is read-only.
MaximumErrorCount	Gets or sets an Integer value that indicates the maximum number of errors that can occur before the ForEachLoopClass object stops running.
Name	Gets or sets the name of the ForEachLoopClass.
Parent	Gets the parent container. The value is read-only.
PrecedenceConstraints	Gets an IDTSPrecedenceConstraints100 collection that contains all of the precedence constraints associated with the ForEachLoop.
Properties	Returns a collection of IDTSProperty100 objects associated with the ForEachLoop.
StartTime	Gets the time that the container began execution. This property is read-only.
StopTime	Gets the time that the container ended execution. This property is read-only.
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.
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.
VariableMappings	Gets an IDTSForEachVariableMappings100 collection that contains the variable mappings for the ForEachLoop.
Variables	Returns a collection that contains the variables associated with this container. This property is read-only.

Methods

AcceptBreakpointManager(IDTSBreakpointManager100)	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.
ComputeExpressions(Boolean)	Computes the expressions in the property collection.
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 ID of the parent container.
IDTSForEachLoop100_Execute(IDTSConnections100, IDTSVariables100, IDTSEvents100, IDTSLogging100, Object)	Executes the executable.
IDTSForEachLoop100_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()	For more information, see ForEachLoop.
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.