• Article

Classe ForEachLoop

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

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

Syntaxe

'Déclaration
Public NotInheritable Class ForEachLoop _
    Inherits EventsProvider _
    Implements IDTSSequence, IDTSPropertiesProvider, IDTSPackagePath
'Utilisation
Dim instance As ForEachLoop

public sealed class ForEachLoop : EventsProvider, 
    IDTSSequence, IDTSPropertiesProvider, IDTSPackagePath

public ref class ForEachLoop sealed : public EventsProvider, 
    IDTSSequence, IDTSPropertiesProvider, IDTSPackagePath

[<SealedAttribute>]
type ForEachLoop =  
    class
        inherit EventsProvider
        interface IDTSSequence
        interface IDTSPropertiesProvider
        interface IDTSPackagePath
    end

public final class ForEachLoop extends EventsProvider implements IDTSSequence, IDTSPropertiesProvider, IDTSPackagePath

Le type ForEachLoop expose les membres suivants.

Propriétés

  Nom Description
Propriété publique CreationName Returns the string that is used to create an instance of the DtsContainer object. This property is read-only. (hérité de DtsContainer.)
Propriété publique DebugMode Gets or sets a Boolean that indicates whether the DtsContainer object is in debug mode and whether it should fire the OnBreakpointHit event while running. (hérité de DtsContainer.)
Propriété publique DelayValidation Gets or sets a Boolean that indicates whether validation of the task is delayed until run time. The default value is false. (hérité de DtsContainer.)
Propriété publique Description Gets or sets the description of the DtsContainer object. (hérité de DtsContainer.)
Propriété publique Disable A Boolean that indicates if the DtsContainer object is disabled. (hérité de DtsContainer.)
Propriété publique DisableEventHandlers Gets or sets a Boolean that indicates whether the event handlers on task are disabled. (hérité de EventsProvider.)
Propriété publique EventHandlers Returns a collection of event handler objects. This field is read-only. (hérité de EventsProvider.)
Propriété publique EventInfos Returns a collection of EventInfo objects. This field is read-only. (hérité de EventsProvider.)
Propriété publique Executables Returns a collection of Executable objects processed by the Data Transformation Run-time engine during execution of the ForEachLoop. This field is read-only.
Propriété publique ExecutionDuration Returns a value that indicates the amount of time that the container spent in execution, in milliseconds. This property is read-only. (hérité de DtsContainer.)
Propriété publique ExecutionResult Returns a value that indicates the success or failure of the execution of the DtsContainer object. (hérité de DtsContainer.)
Propriété publique ExecutionStatus Returns a value that indicates the current status of the execution of the DtsContainer object at the time of the call. (hérité de DtsContainer.)
Propriété publique FailPackageOnFailure Gets or sets a Boolean that indicates whether the package fails when a child container fails. This property is used on containers, not the package itself. (hérité de DtsContainer.)
Propriété publique FailParentOnFailure Gets or sets a Boolean that defines whether the parent container fails when a child container fails. (hérité de DtsContainer.)
Propriété publique ForcedExecutionValue If the ForceExecutionValue property is set to true, gets or sets a value that specifies the optional execution value that the package returns. (hérité de DtsContainer.)
Propriété publique ForceExecutionResult Gets or sets a DTSForcedExecResult enumeration value that specifies the forced execution result of the container. (hérité de DtsContainer.)
Propriété publique ForceExecutionValue Gets or sets a Boolean that indicates whether the execution value of the container should be forced to contain a particular value. (hérité de DtsContainer.)
Propriété publique ForEachEnumerator Gets or sets a host for the ForEachEnumerator.
Propriété publique ID Returns the ID, which is a GUID, of the DtsContainer. The value is read-only. (hérité de DtsContainer.)
Propriété publique IsDefaultLocaleID A Boolean that indicates whether the container uses the default locale. This property is read-only. (hérité de DtsContainer.)
Propriété publique IsolationLevel Gets or sets the isolation level of the transaction in the DtsContainer object. (hérité de DtsContainer.)
Propriété publique LocaleID Gets or sets an Integer that indicates the Microsoft Win32® localeID to use when the DtsContainer object is executed. (hérité de DtsContainer.)
Propriété publique LogEntryInfos Returns a LogEntryInfos object. This property is read-only. (hérité de DtsContainer.)
Propriété publique LoggingMode Gets or sets a valid value from the DTSLoggingMode enumeration that indicates the logging mode of the container. (hérité de DtsContainer.)
Propriété publique LoggingOptions Returns an object that contains properties that indicates the filtering and logging resource for containers. This property is read-only. (hérité de DtsContainer.)
Propriété publique MaximumErrorCount Gets or sets an Integer value that indicates the maximum number of errors that can occur before the DtsContainer object stops running. (hérité de DtsContainer.)
Propriété publique Name Gets or sets the name of the DtsContainer. (hérité de DtsContainer.)
Propriété publique Parent Returns the parent container. The value is read-only. (hérité de DtsContainer.)
Propriété publique PrecedenceConstraints Returns a PrecedenceConstraints collection that contains all of the precedence constraints associated with the ForEachLoop.
Propriété publique Properties Returns a collection of DtsProperty objects associated with the ForEachLoop.
Propriété publique Site Infrastructure. (hérité de DtsContainer.)
Propriété publique StartTime Returns the time that the container began execution. This property is read-only. (hérité de DtsContainer.)
Propriété publique StopTime Returns the time that the container ended execution. This property is read-only. (hérité de DtsContainer.)
Propriété publique 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. (hérité de DtsContainer.)
Propriété publique TransactionOption Gets or sets a DTSTransactionOption enumeration value that indicates whether the container participates in transactions. (hérité de DtsContainer.)
Propriété publique VariableDispenser Returns a VariableDispenser object so variables associated with the container can be locked. (hérité de DtsContainer.)
Propriété publique VariableMappings Returns a ForEachVariableMappings collection that contains the variable mappings for the ForEachLoop.
Propriété publique Variables Returns a collection that contains the variables associated with this container. This property is read-only. (hérité de DtsContainer.)

Haut de la page

Méthodes

  Nom Description
Méthode publique AcceptBreakpointManager This method is called by the run-time engine when a task or container is created, and passes it a BreakpointManager manager 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. (hérité de DtsContainer.)
Méthode publique Dispose Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (hérité de DtsContainer.)
Méthode publique Equals Determines whether two object instances are equal. (hérité de DtsObject.)
Méthode publique Execute Runs the application, container, or package as part of a package workflow. (hérité de DtsContainer.)
Méthode protégée Finalize (hérité de Object.)
Méthode publique GetExpression Returns a String that contains the expression for the specified property. Null means no expression is assigned.
Méthode publique GetHashCode Returns the hash code for this instance. (hérité de DtsObject.)
Méthode publique GetPackagePath Returns a String that contains the relative path to the package location.
Méthode publique GetType (hérité de Object.)
Méthode publique LoadFromXML This method is not callable by your application code. To load a package saved as .xml, use the Application..::..LoadPackage method. (hérité de DtsContainer.)
Méthode protégée MemberwiseClone (hérité de Object.)
Méthode publique ResumeExecution Resumes execution of the task after pausing. The task or container is resumed by the runtime engine. (hérité de DtsContainer.)
Méthode publique SaveToXML This method is not callable by your application code. To save a package as .xml, use the Application..::..SaveToXml method. (hérité de DtsContainer.)
Méthode publique SetExpression Assigns the specified expression to the property. Specify nullNothingnullptrunitune référence Null (Nothing dans Visual Basic) to remove an existing expression from the property.
Méthode protégée SetWrappedExecutable Infrastructure. (hérité de EventsProvider.)
Méthode publique SuspendExecution Called when the executable needs to suspend. This method is called by the runtime engine. (hérité de DtsContainer.)
Méthode publique ToString (hérité de Object.)
Méthode publique Validate Allows the container to determine if it contains invalid settings that will prevent it from executing successfully. (hérité de DtsContainer.)

Haut de la page

Événements

  Nom Description
Événement public Disposed Adds an event handler to listen to the Disposed event on the component. (hérité de DtsContainer.)

Haut de la page

Champs

  Nom Description
Champ protégé m_executable Infrastructure. (hérité de Executable.)

Haut de la page

Notes

At run time, the control flow in the ForEachLoop container is repeated within the overall package control flow.

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.