ForEachEnumerator Class

Article
04/26/2013

Enumerates over the items that the ForEachLoop is assigned to iterate over.

Inheritance Hierarchy

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

Syntax

'Declaration
Public MustInherit Class ForEachEnumerator _
    Inherits DtsObject _
    Implements IDTSForEachEnumerator
'Usage
Dim instance As ForEachEnumerator

public abstract class ForEachEnumerator : DtsObject, 
    IDTSForEachEnumerator

public ref class ForEachEnumerator abstract : public DtsObject, 
    IDTSForEachEnumerator

[<AbstractClassAttribute>]
type ForEachEnumerator =  
    class 
        inherit DtsObject 
        interface IDTSForEachEnumerator 
    end

public abstract class ForEachEnumerator extends DtsObject implements IDTSForEachEnumerator

The ForEachEnumerator type exposes the following members.

Constructors

	Name	Description
	ForEachEnumerator	Initializes a new instance of the ForEachEnumerator class.

Top

Properties

	Name	Description
	CollectionEnumerator	Gets or sets Boolean that indicates if the foreach loop enumerator is enumerating collections of objects or enumerating collections of collections.
	Version	Returns the version number of the package. This property is read-only.

Top

Methods

	Name	Description
	CanUpdate	A Boolean that indicates if the new package XML can update the old package XML.
	Equals	Determines whether two object instances are equal. (Inherited from DtsObject.)
	Finalize	(Inherited from Object.)
	GetEnumerator	Returns a managed enumerator, IEnumerator, for iterating over the collections.
	GetHashCode	Returns the hash code for this instance. (Inherited from DtsObject.)
	GetType	(Inherited from Object.)
	InitializeForEachEnumerator	Initializes the properties associated with the task. This method is called by the runtime and is not used in code.
	MemberwiseClone	(Inherited from Object.)
	ToString	(Inherited from Object.)
	Update	This method updates the old package XML with the new package XML if CanUpdate is set to true.
	Validate	Allows the container to determine if it contains invalid settings that will prevent it from executing successfully.

Top

Remarks

This class provides the abstract (MustInherit in Visual Basic) base class for enumerators over the foreach loop collection. Inherits from DtsObject and IDTSForEachEnumerator.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Share via