Executables.Add(String) メソッド

定義

名前空間:

Microsoft.SqlServer.Dts.Runtime

アセンブリ:

Microsoft.SqlServer.ManagedDTS.dll

新しいコンテナー オブジェクトまたはタスク オブジェクトを 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新しく作成Executableされたオブジェクトのオブジェクト。プロパティを設定したり、新しいオブジェクトのメソッドを呼び出したりするには、次の TaskHost2 つのオプションがあります。Properties たとえば、オブジェクトからプロパティを取得するには、次を使用します。Properties["propertyname"]。GetValue(th))。 プロパティを設定するには、次の値を使用します。Properties["propertyname"]。SetValue(th, <value>);. InnerObject タスク クラスにオブジェクト TaskHost をキャストします。 たとえば、パッケージに追加された後に一括挿入タスクを a BulkInsertTask に Executable キャストし、その後にキャストするには TaskHost、BulkInsertTask myTask = th を使用します。BulkInsertTask としての InnerObject;。タスク固有の TaskHost クラスにキャストせずにコードでクラスを使用すると、次の利点があります。プロバイダーは TaskHostProperties 、コード内のアセンブリへの参照を必要としません。 コンパイル時にタスクの名前を知る必要がないため、すべてのタスクで動作する汎用ルーチンをコーディングできます。 これらの汎用ルーチンでは、タスク名を引数として受け取るメソッドを記述できます。このメソッド コードはすべてのタスクで動作します。 これは、テスト コードを記述するための優れた方法です。タスク固有の TaskHost クラスへのキャストには、次の利点があります。Visual Studio プロジェクトでは、ステートメントの入力候補 (IntelliSense) が提供されます。 コードの実行が高速化する場合があります。 事前バインドされたオブジェクトを生成します。早期バインディングと遅延バインディングの詳細については、「Visual Basic Language Concepts の早期バインディングと遅延バインディング」を参照してください。必要に応じて、オブジェクトをタスク固有のクラスにキャストする場合とキャストしない場合があります。

例

次のコード例では、一括挿入タスクを実行可能オブジェクトとしてパッケージに追加します。

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

注釈

新しいコンテナーまたはタスクを作成して Add コレクションに追加する場合は、Executables を使用します。 このメソッドのパラメーターは文字列であり、CreationName オブジェクトの CLSID、PROGID、STOCK モニカー、または TaskInfo プロパティを指定できます。 このメソッドは、TaskHost オブジェクトとして新しく作成されたタスクの Executable オブジェクトを返します。 詳細については、「 制御フローのタスクまたはコンテナーを追加または削除する」を参照してください。