ScriptTask ScriptTask ScriptTask ScriptTask Class

Definition

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.

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=14.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
[System.Runtime.InteropServices.ComVisible(true)]
[System.Runtime.InteropServices.Guid("4DF420FB-D5C2-4357-8FBE-ECB5E15554F8")]
[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.Guid("04FAEAC9-FB98-4F21-8F96-0E857B739740")]
public class ScriptTask : Microsoft.SqlServer.Dts.Runtime.Task, Microsoft.SqlServer.Dts.Runtime.IDTSBreakpointSite, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist
type ScriptTask = class
    inherit Task
    interface IDTSBreakpointSite
    interface IDTSSuspend
    interface IDTSComponentPersist
Public Class ScriptTask
Inherits Task
Implements IDTSBreakpointSite, IDTSComponentPersist
Inheritance
Attributes
Implements

Examples

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 =   
  
        "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  

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.

Constructors

ScriptTask() ScriptTask() ScriptTask() ScriptTask()

Initializes a new instance of the ScriptTask class.

Properties

BreakpointManager BreakpointManager BreakpointManager BreakpointManager

Gets the BreakpointManager used for controlling breakpoints on this task.

Breakpoints Breakpoints Breakpoints Breakpoints

Gets an array of breakpoints set on this task.

DebugMode DebugMode DebugMode DebugMode

Gets or sets a value indicating whether the task is running in debug mode, and whether it should raise the OnBreakpointHit(IDTSBreakpointSite, BreakpointTarget) event while the task is running.

DefaultActiveItem DefaultActiveItem DefaultActiveItem DefaultActiveItem

Gets the default script.

EntryPoint EntryPoint EntryPoint EntryPoint

Gets or sets the name of the class that is executed as the entry point.

ExecutionValue ExecutionValue ExecutionValue ExecutionValue

Gets a user-defined object. This field is read-only.

ProjectTemplatePath ProjectTemplatePath ProjectTemplatePath ProjectTemplatePath

Gets the path of the specified project template.

ReadOnlyVariables ReadOnlyVariables ReadOnlyVariables ReadOnlyVariables

Gets or sets the comma-delimited list of existing variables made available to the package by the user for read-only access.

ReadWriteVariables ReadWriteVariables ReadWriteVariables ReadWriteVariables

Gets or sets the comma-delimited list of existing variables made available to the package by the user for read/write access.

ScriptingEngine ScriptingEngine ScriptingEngine ScriptingEngine

Gets the VSTATaskScriptingEngine class.

ScriptLanguage ScriptLanguage ScriptLanguage ScriptLanguage

Gets or sets the programming language in which the script is written.

ScriptLoaded ScriptLoaded ScriptLoaded ScriptLoaded

Gets a value indicating whether the task contains custom script.

ScriptProjectName ScriptProjectName ScriptProjectName ScriptProjectName

Gets or sets the name of the script project.

ScriptStorage ScriptStorage ScriptStorage ScriptStorage

Gets the VSTAScriptProjectStorage for the script.

SuspendRequired SuspendRequired SuspendRequired SuspendRequired

Gets or sets a Boolean indicating whether a task should suspend execution when the task encounters a breakpoint. This value is set by the run-time engine for tasks and containers when a breakpoint is encountered.

TargetServerVersion TargetServerVersion TargetServerVersion TargetServerVersion Inherited from Task
Version Version Version Version

*** Member deprecated; see Remarks. ***   Returns the version of the task. This property is read-only.

(Inherited from Task)

Methods

AcceptBreakpointManager(BreakpointManager) AcceptBreakpointManager(BreakpointManager) AcceptBreakpointManager(BreakpointManager) AcceptBreakpointManager(BreakpointManager)

Passes a BreakpointManager to the task. This method is called by the runtime and is not used in code.

CanUpdate(String) CanUpdate(String) CanUpdate(String) CanUpdate(String)

*** Member deprecated; see Remarks. ***   A Boolean that indicates whether the new package XML can update the old package XML.

(Inherited from Task)
Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determines whether two object instances are equal.

(Inherited from DtsObject)
Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object) Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object) Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object) Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object)

Executes the script contained in this instance of DTS Script Task.

Finalize() Finalize() Finalize() Finalize()

Releases all resources used by the ScriptTask.

GetConnectionID(Connections, String) GetConnectionID(Connections, String) GetConnectionID(Connections, String) GetConnectionID(Connections, String)

Gets a String containing the ID of the connection.

(Inherited from Task)
GetConnectionName(Connections, String) GetConnectionName(Connections, String) GetConnectionName(Connections, String) GetConnectionName(Connections, String)

Gets a String containing the name of the connection.

(Inherited from Task)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Returns the hash code for this instance.

(Inherited from DtsObject)
InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker) InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker) InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker) InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker)

Initializes the properties associated with the Script task. This method is called by the runtime and is not used in code.

LoadFromXML(XmlElement, IDTSInfoEvents) LoadFromXML(XmlElement, IDTSInfoEvents) LoadFromXML(XmlElement, IDTSInfoEvents) LoadFromXML(XmlElement, IDTSInfoEvents)

Implements loading of properties from XML document.

ReportBreakpointChanges() ReportBreakpointChanges() ReportBreakpointChanges() ReportBreakpointChanges()

Reports the breakpoint changes from the task.

ResumeExecution() ResumeExecution() ResumeExecution() ResumeExecution()

Resumes execution of the task or container by the run-time engine after pausing.

SaveToXML(XmlDocument, IDTSInfoEvents) SaveToXML(XmlDocument, IDTSInfoEvents) SaveToXML(XmlDocument, IDTSInfoEvents) SaveToXML(XmlDocument, IDTSInfoEvents)

Implements saving of properties to XML document.

SetUniqueScriptProjectName() SetUniqueScriptProjectName() SetUniqueScriptProjectName() SetUniqueScriptProjectName()

Sets the unique name of the script project.

SuspendExecution() SuspendExecution() SuspendExecution() SuspendExecution()

Indicates that the executable must suspend execution. This method is called by the run-time engine.

Update(String) Update(String) Update(String) Update(String)

*** Member deprecated; see Remarks. ***   This method updates the old package XML with the new package XML if CanUpdate(String) is set to true.

(Inherited from Task)
Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging) Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging) Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging) Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging)

Verifies that the component is correctly configured.

Applies to