FieldColEnumerator Class

FieldColEnumerator Class

 

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

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

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

public sealed class FieldColEnumerator : IEnumerator

NameDescription
System_CAPS_pubpropertyCurrent

This API supports the product infrastructure and is not intended to be used directly from your code. Gets the current object in the collection.

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodMoveNext()

This API supports the product infrastructure and is not intended to be used directly from your code. Indicates whether the enumerator moves to the next element.

System_CAPS_pubmethodReset()

This API supports the product infrastructure and is not intended to be used directly from your code. Resets the DataColEnumerator to its default configuration.

System_CAPS_pubmethodToString()

(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 field into the enumerator and iterate over it.

Vardisp.LockOneForWrite("VariableThatHadIndexSetToMinus1", vars)

FieldColEnumerator fEnum = (FieldColEnumerator)vars[0]
foreach (object o in fEnum)
{
    // 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.

Return to top
Show:
© 2016 Microsoft