0 out of 2 rated this helpful - Rate this topic

ScriptTask Class

SQL Server 2005

SQL Server 2012

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.

Namespace: Microsoft.SqlServer.Dts.Tasks.ScriptTask
Assembly: Microsoft.SqlServer.ScriptTask (in microsoft.sqlserver.scripttask.dll)

Syntax

C++

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

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

JScript

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

Remarks

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 Script Task 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

Example

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();
    }
  }
}

Thread Safety

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.

Platforms

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Additions

ADD

ScriptTask Class

Development Platforms

Target Platforms

Reference

Community Additions