DataColEnumerator Class

DataColEnumerator Class

This class is used when the ADO enumerator returns a Dataset or Recordset. This enumerator allows you to enumerate over the columns. This class cannot be inherited.


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

public sealed class DataColEnumerator : IEnumerator

The DataColEnumerator type exposes the following members.

Public propertyCurrentInfrastructure.

Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodMoveNextInfrastructure.
Public methodResetInfrastructure.
Public methodToString (Inherited from Object.)

The members of this class cannot be used directly. This class is used by the foreach keyword (For Each in Visual Basic). The following code example is a piece of a foreach loop showing simply how to use indexing to place a data column into the enumerator and iterate over it.

Vardisp.LockOneForWrite("VariableThatHadIndexSetToMinus1", vars)

DataColEnumerator dcEnum = (DataColEnumerator)vars[0]
foreach (object o in dcEnum)
    // Do something with o, 
    // where o is the value of the column, just as you would get
    // if you had a variable for a specific index.

You must set the index for the variable mapping to -1 to retrieve the entire collection into the variable, instead of retrieving just a column which is based on an index, so then you can access it directly.

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

Community Additions

© 2015 Microsoft