Share via

  • Article

ForEachEnumeratorHost.InnerObject Property

Returns the inner object of the host, which is the ForEachEnumerator that is being hosted.

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

Syntax

'Declaration
Public ReadOnly Property InnerObject As Object
    Get
'Usage
Dim instance As ForEachEnumeratorHost
Dim value As Object

value = instance.InnerObject

public Object InnerObject { get; }

public:
virtual property Object^ InnerObject {
    Object^ get () sealed;
}

abstract InnerObject : Object
override InnerObject : Object

final function get InnerObject () : Object

Property Value

Type: System.Object
An object.

Implements

IDTSObjectHost.InnerObject

Examples

Several classes are created and by the ForEachEnumeratorHost. The following code example shows the enumerators currently available to the application, how to create the ForEachSMOEnumerator within the host object, and then cast the InnerObject to the specific enumerator type.

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.Samples
{
    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);
            // When the SMO enumerator is found, set the info variable.
            if (enumInfo.Name == EnumType.SMOEnum)
            {  
                info = enumInfo;
            }
        }

        ForEachEnumeratorHost enumH = info.CreateNew();
        Console.WriteLine("SMO Enumerator: " + enumH.InnerObject.ToString());
        ForEachSMOEnumerator smoEnumerator = (ForEachSMOEnumerator)enumH.InnerObject;
        }
    }
}

Imports System
Imports System.Collections.Generic
Imports System.Text
Imports Microsoft.SqlServer.Dts.Runtime.Enumerators.SMO
Imports Microsoft.SqlServer.Dts.Runtime

Namespace Microsoft.SqlServer.SSIS.Samples
    Friend Class EnumType
        Public const String SMOEnum = "Foreach SMO Enumerator"
    End Class
    Class Program
        Shared  Sub Main(ByVal args() As String)
            Dim app As Application =  New Application() 
            Dim infos As ForEachEnumeratorInfos =  app.ForEachEnumeratorInfos 
            Dim info As ForEachEnumeratorInfo =  Nothing 

            Dim EnumInfo As ForEachEnumeratorInfo 
            Dim enumInfo As ForEachEnumeratorInfo
            End Enum
            For Each EnumInfo In infos 
            For Each EnumInfo In infos Console.Write("Available enumerators: {0}\n" EnumInfo.Name) End Enum 
            For Each enumInfo In infos
            Console.Write("Available enumerators: {0}\n" enumInfo.Name)
            End Enum
            End Enum
            ' When the SMO enumerator is found, set the info variable.
            If EnumInfo.Name = EnumType.SMOEnum Then 
            Dim EnumInfo.Name As If =  EnumType.SMOEnum Then info  =  EnumInfo  End Enum
            If enumInfo.Name = EnumType.SMOEnum Then
                info = enumInfo
            End Enum
            End Enum
            End If
            Next

        Dim EnumH As ForEachEnumeratorHost =  info.CreateNew() 
        Dim enumH As ForEachEnumeratorHost =  info.CreateNew() 
        End Enum
        Console.WriteLine("SMO Enumerator: " + EnumH.InnerObject.ToString()) 
        Console.WriteLine("SMO Enumerator: " + enumH.InnerObject.ToString())
        End Enum
        Dim smoEnumerator As ForEachSMOEnumerator = CType(EnumH.InnerObject, ForEachSMOEnumerator)
        Dim smoEnumerator As ForEachSMOEnumerator = CType(enumH.InnerObject, ForEachSMOEnumerator)
        End Enum
        End Sub
    End Class
End Namespace

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

SMO Enumerator: Microsoft.SqlServer.Dts.Runtime.Enumerators.SMO.ForEachSMOEnumerator

SMO.EnumURN = RuntimeServer[@Variable='MachineName']/Server[@Name='localhost']/SMOEnumObj[@Name='Databases']/SMOEnumType[@Name='Names']