ScriptTask Clase

Definición

Espacio de nombres:

Microsoft.SqlServer.Dts.Tasks.ScriptTask

Ensamblado:

Microsoft.SqlServer.ScriptTask.dll

Define las clases de la tarea Script, que permite a los desarrolladores escribir código personalizado para realizar funciones que no están disponibles en las tareas integradas proporcionadas por Integration Services.

public ref 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

[<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

Herencia

Object

DtsObject

Task

ScriptTask

Atributos

DtsTaskAttribute ComVisibleAttribute GuidAttribute

Implementaciones

IDTSBreakpointSite IDTSComponentPersist IDTSSuspend

Ejemplos

En el ejemplo de código siguiente, implementado en una aplicación de consola, se agrega un ScriptTask elemento al paquete y se muestran los valores predeterminados de algunas de sus propiedades.

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  

Comentarios

La ScriptTask clase define la tarea Script y controla la interacción de la tarea Script con el tiempo de ejecución y con Visual Studio para Aplicaciones.

Para obtener más información, vea Tarea script y codificación y depuración de la tarea Script.

Constructores

ScriptTask()

Inicializa una nueva instancia de la clase ScriptTask.

Propiedades

BreakpointManager	Obtiene la clase BreakpointManager utilizada para controlar los puntos de interrupción en esta tarea.
Breakpoints	Obtiene una matriz de puntos de interrupción establecidos en esta tarea.
DebugMode	Obtiene o establece un valor que indica si la tarea se está ejecutando en modo de depuración, y si debería desencadenar el evento OnBreakpointHit(IDTSBreakpointSite, BreakpointTarget) mientras la tarea se está ejecutando.
DefaultActiveItem	Obtiene el script predeterminado.
EntryPoint	Obtiene o establece el nombre de la clase que se ejecuta como punto de entrada.
ExecutionValue	Obtiene un objeto definido por el usuario. Este campo es de solo lectura.
ProjectTemplatePath	Obtiene la ruta de acceso de la plantilla de proyecto especificada.
ReadOnlyVariables	Obtiene o establece la lista delimitada por comas de variables existentes puesta a disposición del paquete por el usuario para un acceso de solo lectura.
ReadWriteVariables	Obtiene o establece la lista delimitada por comas de variables existentes puesta a disposición del paquete por el usuario para un acceso de lectura y escritura.
ScriptingEngine	Obtiene la clase VSTATaskScriptingEngine.
ScriptLanguage	Obtiene o establece el lenguaje de programación del script.
ScriptLoaded	Obtiene un valor que indica si la tarea contiene un script personalizado.
ScriptProjectName	Obtiene o establece el nombre del proyecto de script.
ScriptStorage	Obtiene VSTAScriptProjectStorage para el script.
SuspendRequired	Obtiene o establece un valor booleano que indica si una tarea debe suspender la ejecución cuando la tarea encuentra un punto de interrupción. El motor de tiempo de ejecución establece este valor para tareas y contenedores cuando se encuentra un punto de interrupción.
TargetServerVersion	Define las clases de la tarea Script, que permite a los desarrolladores escribir código personalizado para realizar funciones que no están disponibles en las tareas integradas proporcionadas por Integration Services. (Heredado de Task)
Version	*** Miembro desusado; ver Comentarios. *** Devuelve la versión de la tarea. Esta propiedad es de solo lectura. (Heredado de Task)

Métodos

AcceptBreakpointManager(BreakpointManager)	Pasa una clase BreakpointManager a la tarea. El motor en tiempo de ejecución llama a este método, que no se usa en el código.
CanUpdate(String)	*** Miembro desusado; ver Comentarios. Valor booleano que indica si el nuevo paquete XML puede actualizar el XML del paquete anterior. (Heredado de Task)
Equals(Object)	Determina si dos instancias de objeto son iguales. (Heredado de DtsObject)
Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object)	Ejecuta el script que contiene en esta instancia de la tarea Script de DTS.
Finalize()	Libera todos los recursos que usa ScriptTask.
GetConnectionID(Connections, String)	Obtiene una cadena que contiene el identificador de la conexión. (Heredado de Task)
GetConnectionName(Connections, String)	Obtiene una cadena que contiene el nombre de la conexión. (Heredado de Task)
GetHashCode()	Devuelve el código hash de esta instancia. (Heredado de DtsObject)
InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker)	Inicializa las propiedades asociadas a la tarea Script. El motor en tiempo de ejecución llama a este método, que no se usa en el código.
LoadFromXML(XmlElement, IDTSInfoEvents)	Implementa la carga de propiedades desde el documento XML.
ReportBreakpointChanges()	Informa de los cambios de punto de interrupción de la tarea.
ResumeExecution()	El motor de ejecución reanuda la ejecución de la tarea o el contenedor después de la pausa.
SaveToXML(XmlDocument, IDTSInfoEvents)	Implementa el almacenamiento de propiedades en el documento XML.
SetUniqueScriptProjectName()	Establece el nombre único del proyecto de script.
SuspendExecution()	Indica que el ejecutable debe suspender la ejecución. El motor de ejecución llama a este método.
Update(String)	*** Miembro desusado; ver Comentarios. Este método actualiza el XML del paquete antiguo con el nuevo XML de paquete si CanUpdate(String) se establece en true. (Heredado de Task)
Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging)	Comprueba si el componente está configurado correctamente.