Executables.Add(String) Méthode

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

Paramètres

Retours

Un TaskHost objet issu de l’objet nouvellement créé Executable . Pour définir des propriétés ou appeler des méthodes sur le nouvel objet, vous avez deux options : Utilisez la Properties collection de la TaskHost. Par exemple, pour obtenir une propriété de l’objet, utilisez th. Propriétés[« nom de propriété »]. GetValue(th)). Pour définir une propriété, utilisez th. Propriétés[« nom de propriété »]. SetValue(th, <value>) ;. Lancer le InnerObject de la TaskHost classe de tâche. Par exemple, pour lancer la tâche Insertion en masse vers a BulkInsertTask après qu’elle ait été ajoutée à un package en tant qu’an Executable puis ensuite envoyée vers un TaskHost, utilisez BulkInsertTask myTask = th. InnerObject sous le nom de BulkInsertTask ;. Utiliser la TaskHost classe dans le code sans faire de casting vers la classe spécifique à la tâche présente ces avantages : Le TaskHostProperties fournisseur ne nécessite pas une référence à l’assembleur dans le code. Vous pouvez coder des routines génériques qui fonctionnent pour n’importe quelle tâche, car vous n’avez pas besoin de connaître le nom de la tâche au moment de la compilation. Ces routines génériques peuvent être des méthodes où vous passez le nom de la tâche à la méthode, et le code de la méthode fonctionne pour toutes les tâches. C’est une bonne méthode pour écrire du code de test. Le casting de la TaskHost classe spécifique à la tâche présente les avantages suivants : Le projet Visual Studio vous offre la complétion des instructions (IntelliSense). Le code peut tourner plus vite. Produit des objets à liaison précoce Pour plus d’informations sur la liaison précoce et tardive, voir Binding précoce et tardif dans Visual Basic Language Concepts. Selon vos besoins, vous pouvez ou non caster l’objet vers sa classe spécifique à la tâche.

Exemples

L’exemple de code suivant ajoute la tâche Bulk Insert comme exécutable au paquet.

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  

Exemple de sortie :

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

Remarques

Utilisez-le Add lorsque vous créez un nouveau conteneur ou une tâche et souhaitez l’ajouter à la Executables collection. Le paramètre de la méthode est une chaîne, qui peut être le nom CLSID, PROGID, STOCK ou CreationName la propriété de l’objet TaskInfo . La méthode renvoie l’objet TaskHost de la tâche nouvellement créée comme un Executable objet. Pour plus d’informations, consultez Ajouter ou supprimer une tâche ou un conteneur dans un flux de contrôle.