Compartir a través de

  • Artículo

Clase ForEachLoop

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

Espacio de nombres:  Microsoft.SqlServer.Dts.Runtime
Ensamblado:  Microsoft.SqlServer.ManagedDTS (en Microsoft.SqlServer.ManagedDTS.dll)

Sintaxis

'Declaración
Public NotInheritable Class ForEachLoop _
    Inherits EventsProvider _
    Implements IDTSSequence, IDTSPropertiesProvider, IDTSPackagePath
'Uso
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

El tipo ForEachLoop expone los siguientes miembros.

Propiedades

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

Arriba

Métodos

  Nombre Descripción
Método público 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. (Se hereda de DtsContainer.)
Método público Dispose Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Se hereda de DtsContainer.)
Método público Equals Determines whether two object instances are equal. (Se hereda de DtsObject.)
Método público Execute Runs the application, container, or package as part of a package workflow. (Se hereda de DtsContainer.)
Método protegido Finalize (Se hereda de Object.)
Método público GetExpression Returns a String that contains the expression for the specified property. Null means no expression is assigned.
Método público GetHashCode Returns the hash code for this instance. (Se hereda de DtsObject.)
Método público GetPackagePath Returns a String that contains the relative path to the package location.
Método público GetType (Se hereda de Object.)
Método público LoadFromXML This method is not callable by your application code. To load a package saved as .xml, use the Application..::..LoadPackage method. (Se hereda de DtsContainer.)
Método protegido MemberwiseClone (Se hereda de Object.)
Método público ResumeExecution Resumes execution of the task after pausing. The task or container is resumed by the runtime engine. (Se hereda de DtsContainer.)
Método público SaveToXML This method is not callable by your application code. To save a package as .xml, use the Application..::..SaveToXml method. (Se hereda de DtsContainer.)
Método público SetExpression Assigns the specified expression to the property. Specify nullNothingnullptrunites una referencia NULL (Nothing en Visual Basic). to remove an existing expression from the property.
Método protegido SetWrappedExecutable Infraestructura. (Se hereda de EventsProvider.)
Método público SuspendExecution Called when the executable needs to suspend. This method is called by the runtime engine. (Se hereda de DtsContainer.)
Método público ToString (Se hereda de Object.)
Método público Validate Allows the container to determine if it contains invalid settings that will prevent it from executing successfully. (Se hereda de DtsContainer.)

Arriba

Eventos

  Nombre Descripción
Evento público Disposed Adds an event handler to listen to the Disposed event on the component. (Se hereda de DtsContainer.)

Arriba

Campos

  Nombre Descripción
Campo protegido m_executable Infraestructura. (Se hereda de Executable.)

Arriba

Comentarios

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

Seguridad para subprocesos

Cualquier miembro público static (Shared en Visual Basic) de este tipo es seguro para subprocesos. No se garantiza que los miembros de instancia sean seguros para subprocesos.