FieldColEnumerator Class

Article
12/03/2008

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)

Syntax

'Declaration
Public NotInheritable Class FieldColEnumerator
    Implements IEnumerator

public sealed class FieldColEnumerator : IEnumerator

public ref class FieldColEnumerator sealed : IEnumerator

public final class FieldColEnumerator implements IEnumerator

public final class FieldColEnumerator implements IEnumerator

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 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.

Inheritance Hierarchy

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

Thread Safety

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

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Share via