ScriptTask Classe

Référence

Définition

Espace de noms:: Microsoft.SqlServer.Dts.Tasks.ScriptTask

Assembly:: Microsoft.SqlServer.ScriptTask.dll

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Définit les classes de la tâche script, qui permet aux développeurs d’écrire du code personnalisé pour effectuer des fonctions qui ne sont pas disponibles dans les tâches intégrées fournies par Integration Services.

public ref class ScriptTask : Microsoft::SqlServer::Dts::Runtime::Task, Microsoft::SqlServer::Dts::Runtime::IDTSBreakpointSite, Microsoft::SqlServer::Dts::Runtime::IDTSComponentPersist

[Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.scripttask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.ScriptTask.Localized), SamplesTag="SsisScriptTask", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.ScriptTask.ScriptTaskUI, Microsoft.SqlServer.ScriptTaskUI, Version=13.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
[System.Runtime.InteropServices.ComVisible(true)]
[System.Runtime.InteropServices.Guid("04FAEAC9-FB98-4F21-8F96-0E857B739740")]
public class ScriptTask : Microsoft.SqlServer.Dts.Runtime.Task, Microsoft.SqlServer.Dts.Runtime.IDTSBreakpointSite, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist

[System.Runtime.InteropServices.ComVisible(true)]
[Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.scripttask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.ScriptTask.Localized), SamplesTag="SsisScriptTask", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.ScriptTask.ScriptTaskUI, Microsoft.SqlServer.ScriptTaskUI, Version=14.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
[System.Runtime.InteropServices.Guid("4DF420FB-D5C2-4357-8FBE-ECB5E15554F8")]
public class ScriptTask : Microsoft.SqlServer.Dts.Runtime.Task, Microsoft.SqlServer.Dts.Runtime.IDTSBreakpointSite, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist

[System.Runtime.InteropServices.ComVisible(true)]
[Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.scripttask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.ScriptTask.Localized), SamplesTag="SsisScriptTask", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.ScriptTask.ScriptTaskUI, Microsoft.SqlServer.ScriptTaskUI, Version=15.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
[System.Runtime.InteropServices.Guid("C2F3965A-3FE3-482B-A6F3-2514B78E149D")]
public class ScriptTask : Microsoft.SqlServer.Dts.Runtime.Task, Microsoft.SqlServer.Dts.Runtime.IDTSBreakpointSite, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist

[<Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.scripttask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.ScriptTask.Localized), SamplesTag="SsisScriptTask", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.ScriptTask.ScriptTaskUI, Microsoft.SqlServer.ScriptTaskUI, Version=13.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")>]
[<System.Runtime.InteropServices.ComVisible(true)>]
[<System.Runtime.InteropServices.Guid("04FAEAC9-FB98-4F21-8F96-0E857B739740")>]
type ScriptTask = class
    inherit Task
    interface IDTSBreakpointSite
    interface IDTSSuspend
    interface IDTSComponentPersist

[<System.Runtime.InteropServices.ComVisible(true)>]
[<Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.scripttask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.ScriptTask.Localized), SamplesTag="SsisScriptTask", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.ScriptTask.ScriptTaskUI, Microsoft.SqlServer.ScriptTaskUI, Version=14.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")>]
[<System.Runtime.InteropServices.Guid("4DF420FB-D5C2-4357-8FBE-ECB5E15554F8")>]
type ScriptTask = class
    inherit Task
    interface IDTSBreakpointSite
    interface IDTSSuspend
    interface IDTSComponentPersist

[<System.Runtime.InteropServices.ComVisible(true)>]
[<Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.scripttask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.ScriptTask.Localized), SamplesTag="SsisScriptTask", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.ScriptTask.ScriptTaskUI, Microsoft.SqlServer.ScriptTaskUI, Version=15.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")>]
[<System.Runtime.InteropServices.Guid("C2F3965A-3FE3-482B-A6F3-2514B78E149D")>]
type ScriptTask = class
    inherit Task
    interface IDTSBreakpointSite
    interface IDTSSuspend
    interface IDTSComponentPersist

Public Class ScriptTask
Inherits Task
Implements IDTSBreakpointSite, IDTSComponentPersist

Héritage: Object

DtsObject

Task
ScriptTask

Attributs: DtsTaskAttribute ComVisibleAttribute GuidAttribute

Implémente: IDTSBreakpointSite IDTSComponentPersist IDTSSuspend

Exemples

L’exemple de code suivant, implémenté dans une application console, ajoute un ScriptTask au package et affiche les valeurs par défaut de certaines de ses propriétés.

using System;  
using Microsoft.SqlServer.Dts.Runtime;  

namespace ScriptTaskCS  
{  
  class Program  
  {  
    static void Main(string[] args)  
    {  
      Package pkg = new Package();  
      string newLine = System.Environment.NewLine;  

      Executable exe = pkg.Executables.Add("STOCK:ScriptTask");  
      TaskHost thTask = (TaskHost)exe;  

      string taskInfo;  
      taskInfo =   

        "Entry point: " +   
        thTask.Properties["EntryPoint"].GetValue(thTask) + newLine +   
        "Script Language: " +   
        thTask.Properties["ScriptLanguage"].GetValue(thTask) + newLine +   
        "ReadOnlyVariables: " +   
        thTask.Properties["ReadOnlyVariables"].GetValue(thTask) + newLine +   
        "ReadWriteVariables: " +   
        thTask.Properties["ReadWriteVariables"].GetValue(thTask);  

      Console.WriteLine(taskInfo);  
      Console.Read();  
    }  
  }  
}

Imports Microsoft.SqlServer.Dts.Runtime  

Module Module1  

  Sub Main()  

    Dim pkg As New Package  
    Dim newLine As String = System.Environment.NewLine  

    Dim exe As Executable = pkg.Executables.Add("STOCK:ScriptTask")  
    Dim thTask As TaskHost = CType(exe, TaskHost)  

    Dim taskInfo As String  
    taskInfo =   

      "Entry point: " & _  
      thTask.Properties("EntryPoint").GetValue(thTask) & newLine & _  
      "Script Language: " & _  
      thTask.Properties("ScriptLanguage").GetValue(thTask) & newLine & _  
      "ReadOnlyVariables: " & _  
      thTask.Properties("ReadOnlyVariables").GetValue(thTask) & newLine & _  
      "ReadWriteVariables: " & _  
      thTask.Properties("ReadWriteVariables").GetValue(thTask)  

    Console.WriteLine(taskInfo)  
    Console.Read()  

  End Sub  

End Module

Remarques

La ScriptTask classe définit la tâche Script et gère l’interaction de la tâche de script avec le runtime et avec Visual Studio pour Applications.

Pour plus d’informations, consultez Tâche de script et codage et débogage de la tâche de script.

Constructeurs

ScriptTask()

Initialise une nouvelle instance de la classe ScriptTask.

Propriétés

BreakpointManager	Obtient l'objet BreakpointManager utilisé pour contrôler les points d'arrêt sur cette tâche.
Breakpoints	Obtient un tableau de points d'arrêt définis sur cette tâche.
DebugMode	Obtient ou définit une valeur qui indique si la tâche s'exécute en mode débogage, et si l'événement OnBreakpointHit(IDTSBreakpointSite, BreakpointTarget) doit se déclencher lors de l'exécution de la tâche.
DefaultActiveItem	Obtient le script par défaut.
EntryPoint	Obtient ou définit le nom de la classe exécutée comme point d'entrée.
ExecutionValue	Obtient un objet défini par l'utilisateur. Ce champ est en lecture seule.
ProjectTemplatePath	Obtient le chemin d'accès du modèle de projet spécifié.
ReadOnlyVariables	Obtient ou définit la liste délimitée par des virgules des variables existantes mises à disposition du package par l'utilisateur et accessibles en lecture seule.
ReadWriteVariables	Obtient ou définit la liste délimitée par des virgules des variables existantes mises à disposition du package par l'utilisateur et accessibles en lecture/écriture.
ScriptingEngine	Obtient la classe VSTATaskScriptingEngine.
ScriptLanguage	Obtient ou définit le langage de programmation dans lequel le script est écrit.
ScriptLoaded	Obtient une valeur indiquant si la tâche contient un script personnalisé.
ScriptProjectName	Obtient ou définit le nom du projet de script.
ScriptStorage	Obtient le VSTAScriptProjectStorage pour le script.
SuspendRequired	Obtient ou définit une valeur booléenne indiquant si une tâche doit suspendre l’exécution lorsque la tâche rencontre un point d’arrêt. Cette valeur est définie par le moteur d'exécution pour les tâches et les conteneurs lorsqu'un point d'arrêt est rencontré.
TargetServerVersion	Définit les classes de la tâche script, qui permet aux développeurs d’écrire du code personnalisé pour effectuer des fonctions qui ne sont pas disponibles dans les tâches intégrées fournies par Integration Services. (Hérité de Task)
Version	* Membre déconseillé ; consultez les Remarques. * Retourne la version de la tâche. Cette propriété est en lecture seule. (Hérité de Task)

Méthodes

AcceptBreakpointManager(BreakpointManager)	Transmet un objet BreakpointManager à la tâche. Cette méthode est appelée par le runtime et n'est pas utilisée dans le code.
CanUpdate(String)	*** Membre déconseillé ; consultez les Remarques. Valeur booléenne qui indique si le nouveau package XML peut mettre à jour l’ancien xml de package. (Hérité de Task)
Equals(Object)	Détermine si les deux instances d'objet sont égales. (Hérité de DtsObject)
Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object)	Exécute le script contenu dans cette instance de la tâche de script DTS.
Finalize()	Libère toutes les ressources utilisées par ScriptTask.
GetConnectionID(Connections, String)	Obtient une chaîne contenant l’ID de la connexion. (Hérité de Task)
GetConnectionName(Connections, String)	Obtient une chaîne contenant le nom de la connexion. (Hérité de Task)
GetHashCode()	Retourne le code de hachage de cette instance. (Hérité de DtsObject)
InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker)	Initialise les propriétés associées à la tâche de script. Cette méthode est appelée par le runtime et n'est pas utilisée dans le code.
LoadFromXML(XmlElement, IDTSInfoEvents)	Implémente le chargement de propriétés du document XML.
ReportBreakpointChanges()	Indique les modifications de point d'arrêt de la tâche.
ResumeExecution()	Reprend l'exécution de la tâche ou du conteneur par le moteur d'exécution après une interruption.
SaveToXML(XmlDocument, IDTSInfoEvents)	Implémente l'enregistrement de propriétés dans un document XML.
SetUniqueScriptProjectName()	Définit le nom unique du projet de script.
SuspendExecution()	Indique que l'exécutable doit suspendre l'exécution. Cette méthode est appelée par le moteur d'exécution.
Update(String)	*** Membre déconseillé ; consultez les Remarques. Cette méthode met à jour l’ancien xml de package avec le nouveau xml de package s’il CanUpdate(String) est défini sur true. (Hérité de Task)
Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging)	Vérifie que le composant est configuré correctement.

S’applique à