ScriptTask Class

Artículo
12/15/2008

Defines the classes for the Script task, which lets developers write custom code to perform functions that are not available in the built-in tasks provided by Integration Services.

Espacio de nombres: Microsoft.SqlServer.Dts.Tasks.ScriptTask
Ensamblado: Microsoft.SqlServer.ScriptTask (in microsoft.sqlserver.scripttask.dll)

Sintaxis

'Declaración
<GuidAttribute("2EC4E475-058D-3590-8909-279F833D8B9C")> _
<ComVisibleAttribute(True)> _
Public Class ScriptTask
    Inherits Task
    Implements IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist

[GuidAttribute("2EC4E475-058D-3590-8909-279F833D8B9C")] 
[ComVisibleAttribute(true)] 
public class ScriptTask : Task, IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist

[GuidAttribute(L"2EC4E475-058D-3590-8909-279F833D8B9C")] 
[ComVisibleAttribute(true)] 
public ref class ScriptTask : public Task, IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist

/** @attribute GuidAttribute("2EC4E475-058D-3590-8909-279F833D8B9C") */ 
/** @attribute ComVisibleAttribute(true) */ 
public class ScriptTask extends Task implements IDTSBreakpointSite, IDTSSuspend, 
    IDTSComponentPersist

GuidAttribute("2EC4E475-058D-3590-8909-279F833D8B9C") 
ComVisibleAttribute(true) 
public class ScriptTask extends Task implements IDTSBreakpointSite, IDTSSuspend, 
    IDTSComponentPersist

Notas

The ScriptTask class defines the Script task and handles the interaction of the Script task with the runtime and with Visual Studio for Applications.

For more information, see Tarea Secuencia de comandos and Coding and Debugging the Script Task.

Inheritance Hierarchy

System.Object
   Microsoft.SqlServer.Dts.Runtime.DtsObject
     Microsoft.SqlServer.Dts.Runtime.Task
      Microsoft.SqlServer.Dts.Tasks.ScriptTask.ScriptTask

Ejemplo

The following code sample, implemented in a console application, adds a ScriptTask to the package and displays the default values of some of its properties.

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 = 
        "Project name: " + 
        thTask.Properties["VsaProjectName"].GetValue(thTask) + newLine + 
        "Entry point: " + 
        thTask.Properties["EntryPoint"].GetValue(thTask) + newLine + 
        "Script Language: " + 
        thTask.Properties["ScriptLanguage"].GetValue(thTask) + newLine + 
        "Precompiled?: " + 
        thTask.Properties["PreCompile"].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 = "Project name: " & _
      thTask.Properties("VsaProjectName").GetValue(thTask) & newLine & _
      "Entry point: " & _
      thTask.Properties("EntryPoint").GetValue(thTask) & newLine & _
      "Script Language: " & _
      thTask.Properties("ScriptLanguage").GetValue(thTask) & newLine & _
      "Precompiled?: " & _
      thTask.Properties("PreCompile").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

Seguridad para subprocesos

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Plataformas

Plataformas de desarrollo

Para obtener una lista de las plataformas compatibles, vea Requisitos de hardware y software para instalar SQL Server 2005.

Plataformas de destino