ForEachADOEnumerator.Type Property

Article
12/03/2008

Gets or sets a value that indicates what type of object to enumerate over.

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

Syntax

'Declaration
Public Property Type As ADOEnumerationType

public ADOEnumerationType Type { get; set; }

public:
virtual property ADOEnumerationType Type {
    ADOEnumerationType get () sealed;
    void set (ADOEnumerationType value) sealed;
}

/** @property */
public final ADOEnumerationType get_Type ()

/** @property */
public final void set_Type (ADOEnumerationType value)

public final function get Type () : ADOEnumerationType

public final function set Type (value : ADOEnumerationType)

Property Value

A value from the ADOEnumerationType enumeration that indicates what to enumerate over.

Example

The following code sample 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;
        }

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