ForEachADOEnumerator Class

  • Article

Enumerates over rows in a dataset, data table, or recordset. This class cannot be inherited.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Dts.Runtime.DtsObject
    Microsoft.SqlServer.Dts.Runtime.ForEachEnumerator
      Microsoft.SqlServer.Dts.Runtime.Enumerators.ADO.ForEachADOEnumerator

Namespace:  Microsoft.SqlServer.Dts.Runtime.Enumerators.ADO
Assembly:  Microsoft.SqlServer.ForEachADOEnumerator (in Microsoft.SqlServer.ForEachADOEnumerator.dll)

Syntax

'Declaration
Public NotInheritable Class ForEachADOEnumerator _
    Inherits ForEachEnumerator _
    Implements IDTSForEachADOEnumerator, IDTSComponentPersist
'Usage
Dim instance As ForEachADOEnumerator

public sealed class ForEachADOEnumerator : ForEachEnumerator, 
    IDTSForEachADOEnumerator, IDTSComponentPersist

public ref class ForEachADOEnumerator sealed : public ForEachEnumerator, 
    IDTSForEachADOEnumerator, IDTSComponentPersist

[<SealedAttribute>]
type ForEachADOEnumerator =  
    class 
        inherit ForEachEnumerator 
        interface IDTSForEachADOEnumerator 
        interface IDTSComponentPersist 
    end

public final class ForEachADOEnumerator extends ForEachEnumerator implements IDTSForEachADOEnumerator, IDTSComponentPersist

The ForEachADOEnumerator type exposes the following members.

Constructors

  Name Description
Public method ForEachADOEnumerator Initializes a new instance of the ForEachADOEnumerator class.

Top

Properties

  Name Description
Public property 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.)
Public property DataObjectVariable Gets or sets a String that contains the persisted data object from the enumerator.
Public property Type Gets or sets a value that indicates what type of object to enumerate over.
Public property Version Returns the version number of the package. This property is read-only. (Inherited from ForEachEnumerator.)

Top

Methods

  Name Description
Public method CanUpdate A Boolean that indicates if the new package XML can update the old package XML. (Inherited from ForEachEnumerator.)
Public method Equals Determines whether two object instances are equal. (Inherited from DtsObject.)
Public method GetEnumerator Returns an IEnumerator interface that can iterate over the ActiveX Data Objects (ADO) object. (Overrides ForEachEnumerator.GetEnumerator(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging).)
Public method GetHashCode Returns the hash code for this instance. (Inherited from DtsObject.)
Public method GetType (Inherited from Object.)
Public method InitializeForEachEnumerator Initializes the properties associated with the task. This method is called by the runtime and is not used in code. (Inherited from ForEachEnumerator.)
Public method LoadFromXML This method is not callable by your application code. To load a package saved as .xml, use the Application.LoadPackage method.
Public method SaveToXML This method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method. This method cannot be inherited.
Public method ToString (Inherited from Object.)
Public method Update This method updates the old package XML with the new package XML if CanUpdate is set to true. (Inherited from ForEachEnumerator.)
Public method Validate Allows the container to determine if it contains invalid settings that will prevent it from executing successfully. (Inherited from ForEachEnumerator.)

Top

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.

See Also

Reference

Microsoft.SqlServer.Dts.Runtime.Enumerators.ADO Namespace