Partager via


Classe ForEachLoopClass

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

Hiérarchie d'héritage

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

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

Syntaxe

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

Le type ForEachLoopClass expose les membres suivants.

Constructeurs

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

Haut de la page

Propriétés

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

Haut de la page

Méthodes

  Nom Description
Méthode publique 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.
Méthode publique ComputeExpressions Infrastructure. Computes the expressions in the property collection.
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 ID of the parent container.
Méthode publique GetType (hérité de Object.)
Méthode publique IDTSForEachLoop100_Execute Infrastructure. Executes the executable.
Méthode publique IDTSForEachLoop100_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. For more information, see ForEachLoop.
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

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