Класс ForEachLoop

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

Иерархия наследования

System. . :: . .Object
  Microsoft.SqlServer.Dts.Runtime. . :: . .DtsObject
    Microsoft.SqlServer.Dts.Runtime. . :: . .Executable
      Microsoft.SqlServer.Dts.Runtime. . :: . .DtsContainer
        Microsoft.SqlServer.Dts.Runtime. . :: . .EventsProvider
          Microsoft.SqlServer.Dts.Runtime..::..ForEachLoop

Пространство имен:  Microsoft.SqlServer.Dts.Runtime
Сборка:  Microsoft.SqlServer.ManagedDTS (в Microsoft.SqlServer.ManagedDTS.dll)

Синтаксис

'Декларация
Public NotInheritable Class ForEachLoop _
    Inherits EventsProvider _
    Implements IDTSSequence, IDTSPropertiesProvider, IDTSPackagePath
'Применение
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

Тип ForEachLoop обеспечивает доступ к следующим элементам.

Свойства

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

В начало

Методы

  Имя Описание
Открытый метод 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. (Производный от DtsContainer.)
Открытый метод Dispose Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Производный от DtsContainer.)
Открытый метод Equals Determines whether two object instances are equal. (Производный от DtsObject.)
Открытый метод Execute Runs the application, container, or package as part of a package workflow. (Производный от DtsContainer.)
Защищенный метод Finalize (Производный от Object.)
Открытый метод GetExpression Returns a String that contains the expression for the specified property. Null means no expression is assigned.
Открытый метод GetHashCode Returns the hash code for this instance. (Производный от DtsObject.)
Открытый метод GetPackagePath Returns a String that contains the relative path to the package location.
Открытый метод GetType (Производный от Object.)
Открытый метод LoadFromXML This method is not callable by your application code. To load a package saved as .xml, use the Application..::..LoadPackage method. (Производный от DtsContainer.)
Защищенный метод MemberwiseClone (Производный от Object.)
Открытый метод ResumeExecution Resumes execution of the task after pausing. The task or container is resumed by the runtime engine. (Производный от DtsContainer.)
Открытый метод SaveToXML This method is not callable by your application code. To save a package as .xml, use the Application..::..SaveToXml method. (Производный от DtsContainer.)
Открытый метод SetExpression Assigns the specified expression to the property. Specify nullNothingnullptrunitпустая ссылка (Nothing в Visual Basic) to remove an existing expression from the property.
Защищенный метод SetWrappedExecutable Инфраструктура. (Производный от EventsProvider.)
Открытый метод SuspendExecution Called when the executable needs to suspend. This method is called by the runtime engine. (Производный от DtsContainer.)
Открытый метод ToString (Производный от Object.)
Открытый метод Validate Allows the container to determine if it contains invalid settings that will prevent it from executing successfully. (Производный от DtsContainer.)

В начало

События

  Имя Описание
Открытое событие Disposed Adds an event handler to listen to the Disposed event on the component. (Производный от DtsContainer.)

В начало

Поля

  Имя Описание
Защищенное поле m_executable Инфраструктура. (Производный от Executable.)

В начало

Замечания

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

Безопасность многопоточности

Любые открытые статический (Shared в Visual Basic) элементы этого типа потокобезопасны. Потокобезопасность с элементами экземпляров не гарантируется.