ForEachItemEnumerator Class

Article
04/26/2013

Implements an enumerator over the ForEachItem collection. This class cannot be inherited.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Dts.Runtime.DtsObject
    Microsoft.SqlServer.Dts.Runtime.ForEachEnumerator
      Microsoft.SqlServer.Dts.Runtime.Enumerators.Item.ForEachItemEnumerator

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

Syntax

'Declaration
Public NotInheritable Class ForEachItemEnumerator _
    Inherits ForEachEnumerator
'Usage
Dim instance As ForEachItemEnumerator

public sealed class ForEachItemEnumerator : ForEachEnumerator

public ref class ForEachItemEnumerator sealed : public ForEachEnumerator

[<SealedAttribute>]
type ForEachItemEnumerator =  
    class 
        inherit ForEachEnumerator 
    end

public final class ForEachItemEnumerator extends ForEachEnumerator

The ForEachItemEnumerator type exposes the following members.

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. (Inherited from ForEachEnumerator.)
	Items	Gets or sets a collection of ForEachItems.
	Version	Returns the version number of the package. This property is read-only. (Inherited from ForEachEnumerator.)

Top

Methods

	Name	Description
	CanUpdate	A Boolean that indicates if the new package XML can update the old package XML. (Inherited from ForEachEnumerator.)
	Equals	Determines whether two object instances are equal. (Inherited from DtsObject.)
	ExportXML	Exports data to an .xml file.
	GetEnumerator	Gets an IEnumerator interface for iterating through the ForEachItem collection. (Overrides ForEachEnumerator.GetEnumerator(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging).)
	GetHashCode	Returns the hash code for this instance. (Inherited from DtsObject.)
	GetType	(Inherited from Object.)
	ImportXML	Imports XML into the collection.
	InitializeForEachEnumerator	Initializes the properties associated with the task. This method is called by the runtime and is not used in code. (Inherited from ForEachEnumerator.)
	ToString	(Inherited from Object.)
	Update	This method updates the old package XML with the new package XML if CanUpdate is set to true. (Inherited from ForEachEnumerator.)
	Validate	Allows the container to determine if it contains invalid settings that will prevent it from executing successfully. (Inherited from ForEachEnumerator.)

Top

Remarks

This class allows access to the enumerator items directly without calling GetEnumerator. This interface also allows the enumerator to have data added to its collection. Additionally, it has ImportXML and ExportXML methods that allow the enumerator to read and write data to an .xml file.

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