Share via


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.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Dts.Runtime.Enumerators.ADO.DataColEnumerator

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

Syntax

'Declaration
Public NotInheritable Class DataColEnumerator _
    Implements IEnumerator
'Usage
Dim instance As DataColEnumerator
public sealed class DataColEnumerator : IEnumerator
public ref class DataColEnumerator sealed : IEnumerator
[<SealedAttribute>]
type DataColEnumerator =  
    class 
        interface IEnumerator 
    end
public final class DataColEnumerator implements IEnumerator

The DataColEnumerator type exposes the following members.

Properties

  Name Description
Public property Current Infrastructure. Gets the current object in the collection.

Top

Methods

  Name Description
Public method Equals (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Public method MoveNext Infrastructure. Indicates whether the enumerator moves to the next element.
Public method Reset Infrastructure. Resets the DataColEnumerator to its default configuration.
Public method ToString (Inherited from Object.)

Top

Remarks

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.

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