• Artikel

ForEachLoop-Klasse

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

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

Syntax

'Declaration
Public NotInheritable Class ForEachLoop _
    Inherits EventsProvider _
    Implements IDTSSequence, IDTSPropertiesProvider, IDTSPackagePath
'Usage
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

Der ForEachLoop-Typ macht folgende Elemente verfügbar.

Eigenschaften

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

Zum Anfang

Methoden

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

Zum Anfang

Ereignisse

  Name Beschreibung
Öffentliches Ereignis Disposed Adds an event handler to listen to the Disposed event on the component. (Geerbt von DtsContainer.)

Zum Anfang

Felder

  Name Beschreibung
Geschütztes Feld m_executable Infrastruktur (Geerbt von Executable.)

Zum Anfang

Hinweise

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

Threadsicherheit

Alle öffentlichen static (Shared in Visual Basic)-Elemente dieses Typs sind Threadsicher. Für Instanzelemente wird die Threadsicherheit nicht gewährleistet.