Export (0) Print
Expand All

Executables.Add Method

Adds a new container or task object to the Executables collection.

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

public Executable Add(
	string moniker
)

Parameters

moniker
Type: String
The moniker to the executable.

Return Value

Type: Microsoft.SqlServer.Dts.Runtime.Executable
A TaskHost object from the newly created Executable object.To set properties or to call methods on the new object, you have two options:
  1. Use the Properties collection of the TaskHost. For example, to get a property from the object, use th.Properties["propertyname"].GetValue(th)). To set a property, use th.Properties["propertyname"].SetValue(th, <value>);.

  2. Cast the InnerObject of the TaskHost to the task class. For example, to cast the Bulk Insert task to a BulkInsertTask after it has been added to a package as an Executable and subsequently cast to a TaskHost, use BulkInsertTask myTask = th.InnerObject as BulkInsertTask;.

Using the TaskHost class in code without casting to the task-specific class has these advantages:
  • The TaskHost Properties provider does not require a reference to the assembly in the code.

  • You can code generic routines that work for any task, because you do not have to know the name of the task at compile time. These generic routines can be methods where you pass in the name of the task to the method, and the method code works for all tasks. This is a good method for writing test code.

Casting from the TaskHost to the task-specific class has the following advantages:
  • The Visual Studio project provides you with statement completion (IntelliSense).

  • The code may run faster.

  • Produces early-bound objects For more information on early and late binding, see Early and Late Binding in Visual Basic Language Concepts.

Depending on your needs, you may or may not cast the object to its task-specific class.

Use Add when you create a new container or task and want to add it to the Executables collection. The method parameter is a string, which can be the CLSID, PROGID, STOCK moniker, or CreationName property of the TaskInfo object. The method returns the TaskHost object of the newly created task as an Executable object. For more information, see Add or Delete a Task or a Container in a Control Flow.

The following code example adds the Bulk Insert task as an executable to the package.

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

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

            // Obtain the collection.
            Executables pgkExecs = pkg.Executables;
            foreach (Executable eachExec in pgkExecs)
            {
                TaskHost th = exec as TaskHost;
                Console.WriteLine("Executable creation name is: {0}", th.CreationName);
            }
                        // Show that at least one executable exists.
            if (pgkExecs.Contains(0))
            {
                Console.WriteLine("Contains returned true");
            }
            else
            {
                Console.WriteLine("Contains returned false");
            }
        }
    }
}

Sample Output:

Executable creation name is: Microsoft.SqlServer.Dts.Tasks.BulkInsertTask.BulkInsertTask, Microsoft.SqlServer.BulkInsertTask, Version=10.0.000.0, Culture=neutral, PublicKeyToken=89845dcd8080cc91

Contains returned true

Community Additions

ADD
Show:
© 2014 Microsoft