语言

Executables.Add(String) 方法

定义

向集合添加一个新的容器或任务对象 Executables 。

public:
 Microsoft::SqlServer::Dts::Runtime::Executable ^ Add(System::String ^ moniker);
public Microsoft.SqlServer.Dts.Runtime.Executable Add(string moniker);
member this.Add : string -> Microsoft.SqlServer.Dts.Runtime.Executable
Public Function Add (moniker As String) As Executable

参数

moniker
String

可执行文件的名称。

返回

来自新创建Executable对象的对象TaskHost。要设置属性或调用新对象的方法,你有两个选择:使用Properties集合。TaskHost 例如,要从对象中获得属性,使用th。房产[“propertyname”]。GetValue(th))。 要设置属性,请使用 th。房产[“propertyname”]。SetValue(th, <value>);.将 的 TaskHost 投射InnerObject到 任务类。 例如,要在批量插入任务 BulkInsertTask 被添加到包 Executable 中并随后转换为 TaskHost,使用批量插入任务 myTask = th。InnerObject 作为 BulkInsertTask;.在代码中使用该 TaskHost 类而不转换为任务特定类具有以下优势: TaskHostProperties 提供者不需要在代码中引用汇编。 你可以编写通用例程,适用于任何任务,因为编译时不需要知道任务名称。 这些通用例程可以是将任务名称传递给方法的方法,方法代码适用于所有任务。 这是编写测试代码的一个好方法。将 从 的 TaskHost 转换为任务特定类有以下优势:Visual Studio 项目为你提供语句补全功能(IntelliSense)。 代码可能会更快运行。 生成早期绑定对象 关于早期绑定和晚期绑定的更多信息,请参见 Visual Basic 语言概念中的早期绑定和晚期绑定。根据你的需求,你可以或不将对象投射到其任务特定类。

示例

以下代码示例将批量插入任务作为可执行文件添加到软件包中。

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");  
            }  
        }  
    }  
}  
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)  
            Dim pkg As Package =  New Package()   
            Dim exec As Executable =  pkg.Executables.Add("STOCK:BulkInsertTask")   

            ' Obtain the collection.  
            Dim pgkExecs As Executables =  pkg.Executables   
            Dim eachExec As Executable  
            For Each eachExec In pgkExecs  
                Dim th As TaskHost =  exec as TaskHost   
                Console.WriteLine("Executable creation name is: {0}", th.CreationName)  
            Next  
                        ' Show that at least one executable exists.  
            If pgkExecs.Contains(0) Then  
                Console.WriteLine("Contains returned true")  
            Else   
                Console.WriteLine("Contains returned false")  
            End If  
        End Sub  
        End Class  
End Namespace  

示例输出:

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

注解

当你创建新的容器或任务并想添加到Executables集合时使用Add。 方法参数是一个字符串,可以是 CLSID、PROGID、STOCK 名称或 CreationName 对象的 TaskInfo 属性。 该方法将新创建任务的对象返回 TaskHost 为 Executable 对象。 有关详细信息,请参阅 在控制流中添加或删除任务或容器。

适用于