Executables.GetEnumerator Method

Returns an ExecutableEnumerator that can iterate through the Executables collection.

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

Syntax

'Declaration
Public Function GetEnumerator As ExecutableEnumerator
'Usage
Dim instance As Executables 
Dim returnValue As ExecutableEnumerator 

returnValue = instance.GetEnumerator()

public ExecutableEnumerator GetEnumerator()

public:
ExecutableEnumerator^ GetEnumerator()

member GetEnumerator : unit -> ExecutableEnumerator

public function GetEnumerator() : ExecutableEnumerator

Return Value

Type: Microsoft.SqlServer.Dts.Runtime.ExecutableEnumerator
An ExecutableEnumerator that can iterate through the Executables collection.

Examples

The following code example adds a Bulk Insert task to a package, creates an Executables collection, creates the enumerator, and shows the name of the task using the TaskHost.

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

namespace Executables_API
{
    class Program
    {
        static void Main(string[] args)
        {
            // Create the package and add the BulkInsertTask.
            Package pkg = new Package();
            Executable exec = pkg.Executables.Add("STOCK:BulkInsertTask");

            // Obtain the collection.
            Executables pgkExecs = pkg.Executables;

            //Create the Enumerator.
            ExecutableEnumerator myEnumerator = pgkExecs.GetEnumerator();
            Console.WriteLine("The collection contains the following values:");
            int i = 0;
            Executable myExec;
            TaskHost myTH;
            while ((myEnumerator.MoveNext()) && (myEnumerator.Current != null))
            {
                myExec = (Executable)myEnumerator.Current;
                myTH = (TaskHost)myExec;
                Console.WriteLine("[{0}] {1}", i++, myTH.Name);
            }
            // Reset puts the index pointer before the beginning.
            // Do not retrieve from the collection until MoveNext is called.
            myEnumerator.Reset();
            myEnumerator.MoveNext();

        }
    }
}

Imports System
Imports System.Collections.Generic
Imports System.Text
Imports Microsoft.SqlServer.Dts.Runtime
 
Namespace Executables_API
    Class Program
        Shared  Sub Main(ByVal args() As String)
            ' Create the package and add the BulkInsertTask.
            Dim pkg As Package =  New Package() 
            Dim exec As Executable =  pkg.Executables.Add("STOCK:BulkInsertTask") 
 
            ' Obtain the collection.
            Dim pgkExecs As Executables =  pkg.Executables 
 
            'Create the Enumerator.
            Dim myEnumerator As ExecutableEnumerator =  pgkExecs.GetEnumerator() 
            Console.WriteLine("The collection contains the following values:")
            Dim i As Integer =  0 
            Dim myExec As Executable
            Dim myTH As TaskHost
            While (myEnumerator.MoveNext()) &&(myEnumerator.Current <> Nothing)
                myExec = CType(myEnumerator.Current, Executable)
                myTH = CType(myExec, TaskHost)
                Console.WriteLine("[{0}] {1}",i = Console.WriteLine("[{0}] {1}",i + 1
            End While
            ' Reset puts the index pointer before the beginning.
            ' Do not retrieve from the collection until MoveNext is called.
            myEnumerator.Reset()
            myEnumerator.MoveNext()
         End Sub
    End Class
End Namespace

Sample Output:

The collection contains the following values:

[0] {C435F0C7-97E8-4DCC-A0FF-C6C805D9F64E}

See Also

Reference

Executables Class

Microsoft.SqlServer.Dts.Runtime Namespace