This documentation is archived and is not being maintained.

ForEachEnumeratorHost.CollectionEnumerator Property

Gets or sets a Boolean that indicates if the hosting enumerator is enumerating collections of objects or enumerating collections of collections.

Namespace: Microsoft.SqlServer.Dts.Runtime
Assembly: Microsoft.SqlServer.ManagedDTS (in microsoft.sqlserver.manageddts.dll)

public bool CollectionEnumerator { get; set; }
/** @property */
public final boolean get_CollectionEnumerator ()

/** @property */
public final void set_CollectionEnumerator (boolean value)

public final function get CollectionEnumerator () : boolean

public final function set CollectionEnumerator (value : boolean)

Property Value

A Boolean that indicates what the enumerator is iterating over.

true indicates that the enumerator is iterating over a collection of collections. If false, the enumerator is iterating over a collection of objects.

The following code example creates a ForEachEnumeratorHost to hold a ForEachSMOEnumerator enumerator, and displays the host properties.

using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.SqlServer.Dts.Runtime.Enumerators.SMO;
using Microsoft.SqlServer.Dts.Runtime;

namespace Microsoft.SqlServer.SSIS.Sample
    internal class EnumType
        public const string SMOEnum = "Foreach SMO Enumerator";
    class Program
        static void Main(string[] args)
            Application app = new Application();
            ForEachEnumeratorInfos infos = app.ForEachEnumeratorInfos;
            ForEachEnumeratorInfo info = null;

            foreach (ForEachEnumeratorInfo enumInfo in infos)
                Console.Write("Available enumerators: {0}\n", enumInfo.Name);
                if (enumInfo.Name == EnumType.SMOEnum)
                    // Set the ForEachEnumeratorInfo variable
                    // to the SMo enumerator, and use it 
                    // later in the CreateNew method.
                    info = enumInfo;
            ForEachEnumeratorHost enumH = info.CreateNew();
            Console.WriteLine("Host InnerObject: " + enumH.InnerObject.ToString());
            Console.WriteLine("CollectionEnumerator? {0}", enumH.CollectionEnumerator);
            Console.WriteLine("CreationName: {0}",  enumH.CreationName);
            Console.WriteLine("Description:  {0}", enumH.Description);
            Console.WriteLine("Value of DelayValidation: {0}", enumH.DelayValidation);
            Console.WriteLine("HostType:    {0}", enumH.HostType);
            Console.WriteLine("ID:          {0}", enumH.ID);
            Console.WriteLine("Name:        {0}", enumH.Name);

Sample Output:

Available enumerators: Foreach File Enumerator

Available enumerators: Foreach Item Enumerator

Available enumerators: Foreach ADO Enumerator

Available enumerators: Foreach ADO.NET Schema Rowset Enumerator

Available enumerators: Foreach From Variable Enumerator

Available enumerators: Foreach NodeList Enumerator

Available enumerators: Foreach SMO Enumerator

Host InnerObject: Microsoft.SqlServer.Dts.Runtime.Enumerators.SMO.ForEachSMOEnumerator

CollectionEnumerator? False

CreationName: Microsoft.SqlServer.Dts.Runtime.Enumerators.SMO.ForEachSMOEnumerator, Microsoft.SqlServer.ForEachSMOEnumerator, Version=, Culture=neutral, PublicKeyToken=89845dcd8080cc91


Value of DelayValidation: False

HostType: ForEachEnumerator

ID: {C91BA4D0-6AD4-4BEE-A7C4-9A737880773E}

Name: {C91BA4D0-6AD4-4BEE-A7C4-9A737880773E}

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.

Development Platforms

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

Target Platforms