Partager via


Classe ForLoopClass

Cette API prend en charge l'infrastructure SQL Server 2012 et n'est pas destinée à être utilisée directement à partir de votre code.

Provides a container that defines an iterative workflow in a package, using the for iteration statement.

Hiérarchie d'héritage

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

Espace de noms :  Microsoft.SqlServer.Dts.Runtime.Wrapper
Assembly :  Microsoft.SqlServer.DTSRuntimeWrap (en Microsoft.SqlServer.DTSRuntimeWrap.dll)

Syntaxe

'Déclaration
<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
'Utilisation
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

Le type ForLoopClass expose les membres suivants.

Constructeurs

  Nom Description
Méthode publique ForLoopClass Infrastructure. Initializes a new instance of the ForLoopClass class.

Haut de la page

Propriétés

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

Haut de la page

Méthodes

  Nom Description
Méthode publique 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.
Méthode publique ComputeExpressions Infrastructure. Computes the expressions of the ForLoopClass object.
Méthode publique Equals (hérité de Object.)
Méthode publique Execute Infrastructure. Executes the executable.
Méthode protégée Finalize (hérité de Object.)
Méthode publique GetExpression Infrastructure. Returns a String that contains the expression for the specified property. Null means no expression is assigned.
Méthode publique GetHashCode (hérité de Object.)
Méthode publique GetParentID Infrastructure. Gets the parent identifier of this container.
Méthode publique GetType (hérité de Object.)
Méthode publique IDTSForLoop100_Execute Infrastructure. Executes the executable.
Méthode publique IDTSForLoop100_Validate Infrastructure. Verify that the executable will successfully execute by validating all its dependencies and other items before executing it.
Méthode publique IDTSSuspend100_ResumeExecution Infrastructure. Resumes execution of the task after pausing. The task or container is resumed by the runtime engine.
Méthode publique IDTSSuspend100_SuspendExecution Infrastructure. Indicates that the executable needs to suspend. This method is called by the runtime engine.
Méthode publique LoadFromXML Infrastructure. Loads data stored in XML format.
Méthode protégée MemberwiseClone (hérité de Object.)
Méthode publique RegenerateID Infrastructure. Creates a new identifier for the container and updates the container identifier.
Méthode publique ResumeExecution Infrastructure. Resumes execution of the task after pausing. The task or container is resumed by the runtime engine.
Méthode publique SaveToXML Infrastructure. Saves information to an XML document.
Méthode publique SetExpression Infrastructure. Assigns the specified expression to the property. Specify nullune référence Null (Nothing dans Visual Basic) to remove an existing expression from the property.
Méthode publique SuspendExecution Infrastructure. Indicates that the executable needs to suspend. This method is called by the runtime engine.
Méthode publique ToString (hérité de Object.)
Méthode publique Validate Infrastructure. Verify that the executable will successfully execute by validating all its dependencies and other items before executing it.

Haut de la page

Notes

For more information, see ForLoop.

Sécurité des threads

Tous les membres publics static (Shared dans Visual Basic) de ce type sont thread-safe. Tous les membres de l'instance ne sont pas garantis comme étant thread-safe.

Voir aussi

Référence

Espace de noms Microsoft.SqlServer.Dts.Runtime.Wrapper