Compartilhar via


ScriptTask Classe

Definição

Define as classes para a tarefa Script, que permite que os desenvolvedores escrevam código personalizado para executar funções que não estão disponíveis nas tarefas internas fornecidas pelo 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
Herança
ScriptTask
Atributos
Implementações

Exemplos

O exemplo de código a seguir, implementado em um aplicativo de console, adiciona um ScriptTask ao pacote e exibe os valores padrão de algumas de suas propriedades.

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  

Comentários

A ScriptTask classe define a tarefa Script e manipula a interação da tarefa Script com o runtime e com o Visual Studio para Aplicativos.

Para obter mais informações, consulte Tarefa Script e Codificação e Depuração da Tarefa Script.

Construtores

ScriptTask()

Inicializa uma nova instância da classe ScriptTask.

Propriedades

BreakpointManager

Obtém o BreakpointManager usado para controlar pontos de interrupção nesta tarefa.

Breakpoints

Obtém uma matriz de conjunto de pontos de interrupção nesta tarefa.

DebugMode

Obtém ou define um valor que indica se a tarefa está sendo executada em modo de depuração e se ela deve gerar o evento OnBreakpointHit(IDTSBreakpointSite, BreakpointTarget) enquanto a tarefa está em execução.

DefaultActiveItem

Obtém o script padrão.

EntryPoint

Obtém ou define o nome da classe que é executada como o ponto de entrada.

ExecutionValue

Obtém um objeto definido pelo usuário. Este campo é somente leitura.

ProjectTemplatePath

Obtém o caminho do modelo de projeto especificado.

ReadOnlyVariables

Obtém ou define a lista delimitada por vírgulas de variáveis existentes disponibilizadas ao pacote pelo usuário para acesso somente leitura.

ReadWriteVariables

Obtém ou define a lista delimitada por vírgulas de variáveis existentes disponibilizadas ao pacote pelo usuário para acesso de leitura/gravação.

ScriptingEngine

Obtém a classe VSTATaskScriptingEngine.

ScriptLanguage

Obtém ou define a linguagem de programação na qual o script é gravado.

ScriptLoaded

Obtém um valor que indica se a tarefa contém script personalizado.

ScriptProjectName

Obtém ou define o nome do projeto de script.

ScriptStorage

Obtém o VSTAScriptProjectStorage para o script.

SuspendRequired

Obtém ou define um booliano que indica se uma tarefa deve suspender a execução quando a tarefa encontra um ponto de interrupção. Esse valor é definido pelo mecanismo de tempo de execução para tarefas e contêineres quando um ponto de interrupção é encontrado.

TargetServerVersion

Define as classes para a tarefa Script, que permite que os desenvolvedores escrevam código personalizado para executar funções que não estão disponíveis nas tarefas internas fornecidas pelo Integration Services.

(Herdado de Task)
Version

Membro preterido; consulte Comentários. *** Retorna a versão da tarefa. Esta propriedade é somente para leitura.

(Herdado de Task)

Métodos

AcceptBreakpointManager(BreakpointManager)

Passa um BreakpointManager para a tarefa. Esse método é chamado pelo runtime e não é usado em código.

CanUpdate(String)

Membro preterido; consulte Comentários. Um booliano que indica se o novo XML do pacote pode atualizar o XML do pacote antigo.

(Herdado de Task)
Equals(Object)

Determina se duas instâncias de objeto são iguais.

(Herdado de DtsObject)
Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object)

Executa o script contido nesta instância da Tarefa de Script DTS.

Finalize()

Libera todos os recursos usados pelo ScriptTask.

GetConnectionID(Connections, String)

Obtém uma cadeia de caracteres que contém a ID da conexão.

(Herdado de Task)
GetConnectionName(Connections, String)

Obtém uma cadeia de caracteres que contém o nome da conexão.

(Herdado de Task)
GetHashCode()

Retorna o código hash para a instância.

(Herdado de DtsObject)
InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker)

Inicializa as propriedades associadas à tarefa Script. Esse método é chamado pelo runtime e não é usado em código.

LoadFromXML(XmlElement, IDTSInfoEvents)

Implementa o carregamento de propriedades de documento XML.

ReportBreakpointChanges()

Relata as alterações de ponto de interrupção da tarefa.

ResumeExecution()

Continua a execução da tarefa ou do contêiner pelo mecanismo de tempo de execução depois da pausa.

SaveToXML(XmlDocument, IDTSInfoEvents)

Implementa a gravação de propriedades em documento XML.

SetUniqueScriptProjectName()

Define o nome exclusivo do projeto de script.

SuspendExecution()

Indica se o executável deve suspender a execução. Esse método é chamado pelo mecanismo de tempo de execução.

Update(String)

Membro preterido; consulte Comentários. Esse método atualiza o XML do pacote antigo com o novo XML do pacote se CanUpdate(String) for definido como true.

(Herdado de Task)
Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging)

Verifica se o componente está configurado corretamente.

Aplica-se a