ForEachLoopClass 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 foreach iteration statement.
Inheritance Hierarchy
System.Object
Microsoft.SqlServer.Dts.Runtime.Wrapper.ForEachLoopClass
Namespace: Microsoft.SqlServer.Dts.Runtime.Wrapper
Assembly: Microsoft.SqlServer.DTSRuntimeWrap (in Microsoft.SqlServer.DTSRuntimeWrap.dll)
Syntax
'Declaration
<ClassInterfaceAttribute(ClassInterfaceType.None)> _
<GuidAttribute("DEFA06B0-9DF0-47B4-BF57-B8A602F99E91")> _
Public Class ForEachLoopClass _
Implements IDTSExecutable100, ForEachLoop, IDTSForEachLoop100, IDTSContainer100, _
IDTSSequence100, IDTSEventsProvider100, IDTSExecutionMetrics100, IDTSPropertiesProvider100, IDTSBreakpointSite100, _
IDTSSuspend100, IDTSPersist100, IDTSRuntimeObject100, IDTSName100
'Usage
Dim instance As ForEachLoopClass
[ClassInterfaceAttribute(ClassInterfaceType.None)]
[GuidAttribute("DEFA06B0-9DF0-47B4-BF57-B8A602F99E91")]
public class ForEachLoopClass : IDTSExecutable100,
ForEachLoop, IDTSForEachLoop100, IDTSContainer100, IDTSSequence100, IDTSEventsProvider100,
IDTSExecutionMetrics100, IDTSPropertiesProvider100, IDTSBreakpointSite100, IDTSSuspend100, IDTSPersist100,
IDTSRuntimeObject100, IDTSName100
[ClassInterfaceAttribute(ClassInterfaceType::None)]
[GuidAttribute(L"DEFA06B0-9DF0-47B4-BF57-B8A602F99E91")]
public ref class ForEachLoopClass : IDTSExecutable100,
ForEachLoop, IDTSForEachLoop100, IDTSContainer100, IDTSSequence100, IDTSEventsProvider100,
IDTSExecutionMetrics100, IDTSPropertiesProvider100, IDTSBreakpointSite100, IDTSSuspend100, IDTSPersist100,
IDTSRuntimeObject100, IDTSName100
[<ClassInterfaceAttribute(ClassInterfaceType.None)>]
[<GuidAttribute("DEFA06B0-9DF0-47B4-BF57-B8A602F99E91")>]
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
end
public class ForEachLoopClass implements IDTSExecutable100, ForEachLoop, IDTSForEachLoop100, IDTSContainer100, IDTSSequence100, IDTSEventsProvider100, IDTSExecutionMetrics100, IDTSPropertiesProvider100, IDTSBreakpointSite100, IDTSSuspend100, IDTSPersist100, IDTSRuntimeObject100, IDTSName100
The ForEachLoopClass type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
ForEachLoopClass | Infrastructure. Initializes a new instance of the ForEachLoopClass class. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
CreationName | Infrastructure. Returns the string that is used to create an instance of the ForEachLoopClass object. This property is read-only. |
|
DebugMode | Infrastructure. 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. |
|
DelayValidation | Infrastructure. Gets or sets a Boolean that indicates whether validation of the task is delayed until run time. The default value is false. |
|
Description | Infrastructure. Gets or sets the description of the ForEachLoopClass object. |
|
Disable | Infrastructure. Gets a Boolean that indicates whether the ForEachLoopClass object is disabled. |
|
DisableEventHandlers | Infrastructure. Gets a Boolean that indicates whether event handlers on task are disabled. |
|
EventHandlers | Infrastructure. Gets a collection of event handler objects. This field is read-only. |
|
EventInfos | Infrastructure. Gets a collection of IDTSEventInfo100 objects. This field is read-only. |
|
Executables | Infrastructure. Gets a collection of executable objects. |
|
ExecutionDuration | Infrastructure. Returns a value that indicates the amount of time that the container spent in execution, in milliseconds. This property is read-only. |
|
ExecutionResult | Infrastructure. Returns a value that indicates the success or failure of the execution of the ForEachLoopClass object. |
|
ExecutionStatus | Infrastructure. Returns a value that indicates the current status of the execution of the ForEachLoopClass object at the time of the call. |
|
FailPackageOnFailure | Infrastructure. Gets or sets a Boolean that indicates whether the package fails when a child container fails. |
|
FailParentOnFailure | Infrastructure. Gets or sets a Boolean that defines whether the parent container fails when a child container fails. |
|
ForcedExecutionValue | Infrastructure. If the ForceExecutionValue property is set to true, gets or sets a value that specifies the optional execution value that the package returns. |
|
ForceExecutionResult | Infrastructure. Gets or sets a DTSExecResult enumeration value that specifies the forced execution result of the container. |
|
ForceExecutionValue | Infrastructure. Gets or sets a Boolean that indicates whether the execution value of the container should be forced to contain a particular value. |
|
ForEachEnumerator | Infrastructure. Gets or sets a host for the IDTSForEachEnumerator100. |
|
ID | Infrastructure. Gets the GUID of the ForEachLoopClass. The value is read-only. |
|
IDTSSuspend100_SuspendRequired | Infrastructure. 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 | Infrastructure. A Boolean that indicates whether the container uses the default locale. This property is read-only. |
|
IsolationLevel | Infrastructure. Gets or sets the isolation level of the transaction in the ForEachLoopClass object. |
|
LocaleID | Infrastructure. Gets or sets an Integer that indicates the Microsoft Win32® localeID to use when the ForEachLoopClass object is executed. |
|
LogEntryInfos | Infrastructure. Gets the IDTSLogEntryInfos100 object for the container. This property is read-only. |
|
LoggingMode | Infrastructure. Gets or sets a valid value from the DTSLoggingMode enumeration that indicates the logging mode of the container. |
|
LoggingOptions | Infrastructure. Gets an object that contains properties that indicates the filtering and logging resource for containers. This property is read-only. |
|
MaximumErrorCount | Infrastructure. Gets or sets an Integer value that indicates the maximum number of errors that can occur before the ForEachLoopClass object stops running. |
|
Name | Infrastructure. Gets or sets the name of the ForEachLoopClass. |
|
Parent | Infrastructure. Gets the parent container. The value is read-only. |
|
PrecedenceConstraints | Infrastructure. Gets an IDTSPrecedenceConstraints100 collection that contains all of the precedence constraints associated with the ForEachLoop. |
|
Properties | Infrastructure. Returns a collection of IDTSProperty100 objects associated with the ForEachLoop. |
|
StartTime | Infrastructure. Gets the time that the container began execution. This property is read-only. |
|
StopTime | Infrastructure. Gets the time that the container ended execution. This property is read-only. |
|
SuspendRequired | Infrastructure. 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 | Infrastructure. Gets or sets a DTSTransactionOption enumeration value that indicates whether the container participates in transactions. |
|
VariableDispenser | Infrastructure. Gets an IDTSVariableDispenser100 object so variables associated with the container can be locked. |
|
VariableMappings | Infrastructure. Gets an IDTSForEachVariableMappings100 collection that contains the variable mappings for the ForEachLoop. |
|
Variables | Infrastructure. Returns a collection that contains the variables associated with this container. This property is read-only. |
Top
Methods
| Name | Description | |
|---|---|---|
|
AcceptBreakpointManager | Infrastructure. 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 | Infrastructure. Computes the expressions in the property collection. |
|
Equals | (Inherited from Object.) |
|
Execute | Infrastructure. Executes the executable. |
.gif "Protected method") |
Finalize | (Inherited from Object.) |
|
GetExpression | Infrastructure. Returns a String that contains the expression for the specified property. Null means no expression is assigned. |
|
GetHashCode | (Inherited from Object.) |
|
GetParentID | Infrastructure. Gets the ID of the parent container. |
|
GetType | (Inherited from Object.) |
|
IDTSForEachLoop100_Execute | Infrastructure. Executes the executable. |
|
IDTSForEachLoop100_Validate | Infrastructure. Verify that the executable will successfully execute by validating all its dependencies and other items before executing it. |
|
IDTSSuspend100_ResumeExecution | Infrastructure. Resumes execution of the task after pausing. The task or container is resumed by the runtime engine. |
|
IDTSSuspend100_SuspendExecution | Infrastructure. Indicates that the executable needs to suspend. This method is called by the runtime engine. |
|
LoadFromXML | Infrastructure. Loads data stored in XML format. |
|
MemberwiseClone | (Inherited from Object.) |
|
RegenerateID | Infrastructure. For more information, see ForEachLoop. |
|
ResumeExecution | Infrastructure. Resumes execution of the task after pausing. The task or container is resumed by the runtime engine. |
|
SaveToXML | Infrastructure. Saves information to an XML document. |
|
SetExpression | Infrastructure. Assigns the specified expression to the property. Specify nulla null reference (Nothing in Visual Basic) to remove an existing expression from the property. |
|
SuspendExecution | Infrastructure. Indicates that the executable needs to suspend. This method is called by the runtime engine. |
|
ToString | (Inherited from Object.) |
|
Validate | Infrastructure. Verify that the executable will successfully execute by validating all its dependencies and other items before executing it. |
Top
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.