Classe ForEachLoop

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

Hierarquia de herança

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

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

Sintaxe

'Declaração
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

O tipo ForEachLoop expõe os membros a seguir.

Propriedades

	Nome	Descrição
	CreationName	Returns the string that is used to create an instance of the DtsContainer object. This property is read-only. (Herdado de 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. (Herdado de DtsContainer.)
	DelayValidation	Gets or sets a Boolean that indicates whether validation of the task is delayed until run time. The default value is false. (Herdado de DtsContainer.)
	Description	Gets or sets the description of the DtsContainer object. (Herdado de DtsContainer.)
	Disable	A Boolean that indicates if the DtsContainer object is disabled. (Herdado de DtsContainer.)
	DisableEventHandlers	Gets or sets a Boolean that indicates whether the event handlers on task are disabled. (Herdado de EventsProvider.)
	EventHandlers	Returns a collection of event handler objects. This field is read-only. (Herdado de EventsProvider.)
	EventInfos	Returns a collection of EventInfo objects. This field is read-only. (Herdado de 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. (Herdado de DtsContainer.)
	ExecutionResult	Returns a value that indicates the success or failure of the execution of the DtsContainer object. (Herdado de DtsContainer.)
	ExecutionStatus	Returns a value that indicates the current status of the execution of the DtsContainer object at the time of the call. (Herdado de 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. (Herdado de DtsContainer.)
	FailParentOnFailure	Gets or sets a Boolean that defines whether the parent container fails when a child container fails. (Herdado de 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. (Herdado de DtsContainer.)
	ForceExecutionResult	Gets or sets a DTSForcedExecResult enumeration value that specifies the forced execution result of the container. (Herdado de DtsContainer.)
	ForceExecutionValue	Gets or sets a Boolean that indicates whether the execution value of the container should be forced to contain a particular value. (Herdado de 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. (Herdado de DtsContainer.)
	IsDefaultLocaleID	A Boolean that indicates whether the container uses the default locale. This property is read-only. (Herdado de DtsContainer.)
	IsolationLevel	Gets or sets the isolation level of the transaction in the DtsContainer object. (Herdado de DtsContainer.)
	LocaleID	Gets or sets an Integer that indicates the Microsoft Win32® localeID to use when the DtsContainer object is executed. (Herdado de DtsContainer.)
	LogEntryInfos	Returns a LogEntryInfos object. This property is read-only. (Herdado de DtsContainer.)
	LoggingMode	Gets or sets a valid value from the DTSLoggingMode enumeration that indicates the logging mode of the container. (Herdado de DtsContainer.)
	LoggingOptions	Returns an object that contains properties that indicates the filtering and logging resource for containers. This property is read-only. (Herdado de DtsContainer.)
	MaximumErrorCount	Gets or sets an Integer value that indicates the maximum number of errors that can occur before the DtsContainer object stops running. (Herdado de DtsContainer.)
	Name	Gets or sets the name of the DtsContainer. (Herdado de DtsContainer.)
	Parent	Returns the parent container. The value is read-only. (Herdado de 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	Infraestrutura. (Herdado de DtsContainer.)
	StartTime	Returns the time that the container began execution. This property is read-only. (Herdado de DtsContainer.)
	StopTime	Returns the time that the container ended execution. This property is read-only. (Herdado de 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. (Herdado de DtsContainer.)
	TransactionOption	Gets or sets a DTSTransactionOption enumeration value that indicates whether the container participates in transactions. (Herdado de DtsContainer.)
	VariableDispenser	Returns a VariableDispenser object so variables associated with the container can be locked. (Herdado de 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. (Herdado de DtsContainer.)

Início

Métodos

	Nome	Descrição
	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. (Herdado de DtsContainer.)
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Herdado de DtsContainer.)
	Equals	Determines whether two object instances are equal. (Herdado de DtsObject.)
	Execute	Runs the application, container, or package as part of a package workflow. (Herdado de DtsContainer.)
	Finalize	(Herdado de 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. (Herdado de DtsObject.)
	GetPackagePath	Returns a String that contains the relative path to the package location.
	GetType	(Herdado de Object.)
	LoadFromXML	This method is not callable by your application code. To load a package saved as .xml, use the Application..::..LoadPackage method. (Herdado de DtsContainer.)
	MemberwiseClone	(Herdado de Object.)
	ResumeExecution	Resumes execution of the task after pausing. The task or container is resumed by the runtime engine. (Herdado de DtsContainer.)
	SaveToXML	This method is not callable by your application code. To save a package as .xml, use the Application..::..SaveToXml method. (Herdado de DtsContainer.)
	SetExpression	Assigns the specified expression to the property. Specify nullNothingnullptrunituma referência nula (Nothing no Visual Basic) to remove an existing expression from the property.
	SetWrappedExecutable	Infraestrutura. (Herdado de EventsProvider.)
	SuspendExecution	Called when the executable needs to suspend. This method is called by the runtime engine. (Herdado de DtsContainer.)
	ToString	(Herdado de Object.)
	Validate	Allows the container to determine if it contains invalid settings that will prevent it from executing successfully. (Herdado de DtsContainer.)

Início

Eventos

	Nome	Descrição
	Disposed	Adds an event handler to listen to the Disposed event on the component. (Herdado de DtsContainer.)

Início

Campos

	Nome	Descrição
	m_executable	Infraestrutura. (Herdado de Executable.)

Início

Comentários

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

Segurança de thread

Qualquer membro público static (Shared no Visual Basic) desse tipo é seguro para threads. Não há garantia de que qualquer membro de instância seja seguro para threads.

Consulte também

Referência

Namespace Microsoft.SqlServer.Dts.Runtime