ForLoopClass Class

Article
04/26/2013

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.

Inheritance Hierarchy

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

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

Syntax

'Declaration
<GuidAttribute("C29EE86B-9D47-47BA-965B-E364731C8A2A")> _
<ClassInterfaceAttribute(ClassInterfaceType.None)> _
Public Class ForLoopClass _
    Implements IDTSExecutable100, ForLoop, IDTSForLoop100, IDTSContainer100,  _
    IDTSSequence100, IDTSEventsProvider100, IDTSExecutionMetrics100, IDTSPropertiesProvider100, IDTSBreakpointSite100,  _
    IDTSSuspend100, IDTSPersist100, IDTSRuntimeObject100, IDTSName100
'Usage
Dim instance As ForLoopClass

[GuidAttribute("C29EE86B-9D47-47BA-965B-E364731C8A2A")]
[ClassInterfaceAttribute(ClassInterfaceType.None)]
public class ForLoopClass : IDTSExecutable100, 
    ForLoop, IDTSForLoop100, IDTSContainer100, IDTSSequence100, IDTSEventsProvider100, 
    IDTSExecutionMetrics100, IDTSPropertiesProvider100, IDTSBreakpointSite100, IDTSSuspend100, IDTSPersist100, 
    IDTSRuntimeObject100, IDTSName100

[GuidAttribute(L"C29EE86B-9D47-47BA-965B-E364731C8A2A")]
[ClassInterfaceAttribute(ClassInterfaceType::None)]
public ref class ForLoopClass : IDTSExecutable100, 
    ForLoop, IDTSForLoop100, IDTSContainer100, IDTSSequence100, IDTSEventsProvider100, 
    IDTSExecutionMetrics100, IDTSPropertiesProvider100, IDTSBreakpointSite100, IDTSSuspend100, IDTSPersist100, 
    IDTSRuntimeObject100, IDTSName100

[<GuidAttribute("C29EE86B-9D47-47BA-965B-E364731C8A2A")>]
[<ClassInterfaceAttribute(ClassInterfaceType.None)>]
type ForLoopClass =  
    class 
        interface IDTSExecutable100 
        interface ForLoop 
        interface IDTSForLoop100 
        interface IDTSContainer100 
        interface IDTSSequence100 
        interface IDTSEventsProvider100 
        interface IDTSExecutionMetrics100 
        interface IDTSPropertiesProvider100 
        interface IDTSBreakpointSite100 
        interface IDTSSuspend100 
        interface IDTSPersist100 
        interface IDTSRuntimeObject100 
        interface IDTSName100 
    end

public class ForLoopClass implements IDTSExecutable100, ForLoop, IDTSForLoop100, IDTSContainer100, IDTSSequence100, IDTSEventsProvider100, IDTSExecutionMetrics100, IDTSPropertiesProvider100, IDTSBreakpointSite100, IDTSSuspend100, IDTSPersist100, IDTSRuntimeObject100, IDTSName100

The ForLoopClass type exposes the following members.

Constructors

	Name	Description
	ForLoopClass	Infrastructure. Initializes a new instance of the ForLoopClass class.

Top

Properties

	Name	Description
	AssignExpression	Infrastructure. Gets or sets an expression to increment or decrement the loop counter.
	CreationName	Infrastructure. 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.
	DebugMode	Infrastructure. Gets or sets a Boolean that indicates whether a task should check if breakpoints are enabled.
	DelayValidation	Infrastructure. Gets or sets a value that indicates whether validation of the task is delayed until run time.
	Description	Infrastructure. Gets or sets a description about the object.
	Disable	Infrastructure. Gets or sets a value that indicates whether the IDTSContainer100 object is disabled.
	DisableEventHandlers	Infrastructure. Gets or sets a Boolean that indicates whether the event handlers on task are disabled.
	EvalExpression	Infrastructure. Gets or sets the expression that is evaluated on each pass of the loop.
	EventHandlers	Infrastructure. Returns a collection of event handler objects. This field is read-only.
	EventInfos	Infrastructure. Returns a collection of IDTSEventInfo100 objects. This field is read-only.
	Executables	Infrastructure. Returns a collection of executable objects that are processed during the ForLoopClass iteration.
	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. Gets a value that indicates the success or failure of the execution of the IDTSContainer100 object.
	ExecutionStatus	Infrastructure. Gets the current status of the execution of the IDTSContainer100 object at the time of the call.
	FailPackageOnFailure	Infrastructure. Gets or sets a value that indicates whether the package fails when a child container fails.
	FailParentOnFailure	Infrastructure. Gets or sets a value that indicates whether the parent container fails when a child container fails.
	ForcedExecutionValue	Infrastructure. When ForceExecutionValue is true, gets or sets a value that specifies the optional execution value that the package returns.
	ForceExecutionResult	Infrastructure. Gets or sets the forced execution result of the container.
	ForceExecutionValue	Infrastructure. Gets or sets a value that indicates whether the execution value of the container should be forced to contain a particular value.
	ID	Infrastructure. Returns a unique ID assigned to the object. This is usually a GUID. This property is read-only.
	IDTSSuspend100_SuspendRequired	Infrastructure. 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.
	InitExpression	Infrastructure. Gets or sets an optional initialization expression.
	IsDefaultLocaleID	Infrastructure. Gets a value that indicates whether the container uses the default locale.
	IsolationLevel	Infrastructure. Gets or sets the isolation level of the transaction in the IDTSContainer100 object.
	LocaleID	Infrastructure. Gets or sets the identifier of the locale to use when the IDTSContainer100 object is executed.
	LogEntryInfos	Infrastructure. Gets a collection of information about a log entry.
	LoggingMode	Infrastructure. Gets or sets the logging mode of the container.
	LoggingOptions	Infrastructure. Gets an object that contains properties that indicates the filtering and logging resource for containers.
	MaximumErrorCount	Infrastructure. Gets or sets the maximum number of errors that can occur before the container stops running.
	Name	Infrastructure. Gets or sets a name assigned to the object.
	Parent	Infrastructure. Gets the parent of the container.
	PrecedenceConstraints	Infrastructure. Returns a IDTSPrecedenceConstraints100 collection. This field is read-only.
	Properties	Infrastructure. Returns a set of properties for the ForLoopClass into a IDTSProperties100 collection.
	StartTime	Infrastructure. Returns the time that the container began execution. This property is read-only.
	StopTime	Infrastructure. Returns the time that the container ended execution. This property is read-only.
	SuspendRequired	Infrastructure. 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.
	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.
	Variables	Infrastructure. Gets a collection that contains the variables associated with this container.

Top

Methods

	Name	Description
	AcceptBreakpointManager	Infrastructure. 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.
	ComputeExpressions	Infrastructure. Computes the expressions of the ForLoopClass object.
	Equals	(Inherited from Object.)
	Execute	Infrastructure. Executes the executable.
	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 parent identifier of this container.
	GetType	(Inherited from Object.)
	IDTSForLoop100_Execute	Infrastructure. Executes the executable.
	IDTSForLoop100_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. Creates a new identifier for the container and updates the container identifier.
	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

Remarks

For more information, see ForLoop.

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.

Share via