Share via


ADOEnumerationType Enumeration

Describes the objects that are the subject of the enumeration.

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

Syntax

'Declaration
Public Enumeration ADOEnumerationType
'Usage
Dim instance As ADOEnumerationType
public enum ADOEnumerationType
public enum class ADOEnumerationType
type ADOEnumerationType
public enum ADOEnumerationType

Members

Member name Description
EnumerateAllRows When the variable contains a dataset, this setting enumerates all the rows in all the tables in the dataset. When the variable contains a datatable, this setting enumerates all the rows in the table. When it contains a recordset, it enumerates all the rows in the recordset.
EnumerateRowsInFirstTable When the variable contains a dataset, this setting enumerates all the rows in the first table in the dataset. When the variable contains a data table, it enumerates all rows in the table. When it contains a recordset, it enumerates all the rows in the recordset.
EnumerateTables When the variable contains a dataset, this setting enumerates all the tables in the dataset. When the variable contains a datatable, it raises an error at runtime. When it contains a recordset, it enumerates all the rows in the recordset.

Remarks

This enumeration is used by the Type property. The variable object, referred to in the member description, refers to the run-time variable that contains the data object.

Examples

The following code example shows how to use the Type property to differentiate the type of object, allowing different code to be written for handling different business logic, toggling check boxes in a user interface, or running any other special processes.

m_Enum = (ForEachADOEnumerator)FEEHost.InnerObject;
    if( m_Enum != null )
    {
        switch( m_Enum.Type )
        {
            case ADOEnumerationType.EnumerateAllRows:
                // Insert custom code here.
                break;

            case ADOEnumerationType.EnumerateRowsInFirstTable:
                // Insert custom code here.
                break;

            case ADOEnumerationType.EnumerateTables:
                // Insert custom code here.
                break;

            default:
                // Insert custom code here.
                break;
        }

See Also

Reference

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