Share via


ForEachItemEnumerator Class

Definition

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

public ref class ForEachItemEnumerator sealed : Microsoft::SqlServer::Dts::Runtime::ForEachEnumerator
public sealed class ForEachItemEnumerator : Microsoft.SqlServer.Dts.Runtime.ForEachEnumerator
type ForEachItemEnumerator = class
    inherit ForEachEnumerator
Public NotInheritable Class ForEachItemEnumerator
Inherits ForEachEnumerator
Inheritance
ForEachItemEnumerator

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.

Properties

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.

TargetServerVersion (Inherited from ForEachEnumerator)
Version

Returns the version number of the package. This property is read-only.

(Inherited from ForEachEnumerator)

Methods

CanUpdate(String)

A Boolean that indicates if the new package XML can update the old package XML.

(Inherited from ForEachEnumerator)
Equals(Object)

Determines whether two object instances are equal.

(Inherited from DtsObject)
ExportXML(String)

Exports data to an .xml file.

GetEnumerator(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging)

Retrieves an IEnumerator interface for iterating through the ForEachItem collection.

GetHashCode()

Returns the hash code for this instance.

(Inherited from DtsObject)
ImportXML(String)

Imports XML into the collection.

InitializeForEachEnumerator(Connections, IDTSInfoEvents, ObjectReferenceTracker)

Initializes the properties associated with the task. This method is called by the runtime and is not used in code.

(Inherited from ForEachEnumerator)
Update(String)

This method updates the old package XML with the new package XML if CanUpdate(String) is set to true.

(Inherited from ForEachEnumerator)
Validate(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging)

Allows the container to determine if it contains invalid settings that will prevent it from executing successfully.

(Inherited from ForEachEnumerator)

Applies to