Export (0) Print
Expand All

ScriptTask Class

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.

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

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

'Declaration
<GuidAttribute("A6564AF4-CE42-4CCF-9DA9-CEF88F19DE2F")> _
<ComVisibleAttribute(True)> _
Public Class ScriptTask _
	Inherits Task _
	Implements IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist
'Usage
Dim instance As ScriptTask

The ScriptTask type exposes the following members.

  NameDescription
Public methodScriptTaskInitializes a new instance of the ScriptTask class.
Top

  NameDescription
Public propertyBreakpointManagerGets the BreakpointManager used for controlling breakpoints on this task.
Public propertyBreakpointsGets an array of breakpoints set on this task.
Public propertyDebugModeGets or sets a value indicating whether the task is running in debug mode, and whether it should raise the OnBreakpointHit event while the task is running.
Public propertyDefaultActiveItemGets the default script.
Public propertyEntryPointGets or sets the name of the class that is executed as the entry point.
Public propertyExecutionValueGets a user-defined object. This field is read-only. (Overrides Task.ExecutionValue.)
Public propertyProjectTemplatePathGets the path of the specified project template.
Public propertyReadOnlyVariablesGets or sets the comma-delimited list of existing variables made available to the package by the user for read-only access.
Public propertyReadWriteVariablesGets or sets the comma-delimited list of existing variables made available to the package by the user for read/write access.
Public propertyScriptingEngineGets the VSTATaskScriptingEngine class.
Public propertyScriptLanguageGets or sets the programming language in which the script is written.
Public propertyScriptLoadedGets a value indicating whether the task contains custom script.
Public propertyScriptProjectNameGets or sets the name of the script project.
Public propertyScriptStorageGets the [VSTAScriptProjectStorage] for the script.
Public propertySuspendRequiredGets 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.
Public propertyVersion*** Member deprecated; see Remarks. ***   Returns the version of the task. This property is read-only. (Inherited from Task.)
Top

  NameDescription
Public methodAcceptBreakpointManagerPasses a BreakpointManager to the task. This method is called by the runtime and is not used in code.
Public methodCanUpdate*** Member deprecated; see Remarks. ***   A Boolean that indicates whether the new package XML can update the old package XML. (Inherited from Task.)
Public methodEqualsDetermines whether two object instances are equal. (Inherited from DtsObject.)
Public methodExecuteExecutes the script contained in this instance of DTS Script Task. (Overrides Task.Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object).)
Protected methodFinalizeReleases all resources used by the ScriptTask. (Overrides ObjectFinalize.)
Public methodGetConnectionIDGets a String containing the ID of the connection. (Inherited from Task.)
Public methodGetConnectionNameGets a String containing the name of the connection. (Inherited from Task.)
Public methodGetHashCodeReturns the hash code for this instance. (Inherited from DtsObject.)
Public methodGetType (Inherited from Object.)
Public methodInitializeTaskInitializes the properties associated with the Script task. This method is called by the runtime and is not used in code. (Overrides Task.InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker).)
Public methodLoadFromXMLImplements loading of properties from XML document.
Protected methodMemberwiseClone (Inherited from Object.)
Public methodReportBreakpointChangesInfrastructure. Reports the breakpoint changes from the task.
Public methodResumeExecutionResumes execution of the task or container by the run-time engine after pausing.
Public methodSaveToXMLImplements saving of properties to XML document.
Public methodSetUniqueScriptProjectNameSets the unique name of the script project.
Public methodSuspendExecutionIndicates that the executable must suspend execution. This method is called by the run-time engine.
Public methodToString (Inherited from Object.)
Public methodUpdate*** Member deprecated; see Remarks. ***   This method updates the old package XML with the new package XML if CanUpdate is set to true. (Inherited from Task.)
Public methodValidateVerifies that the component is correctly configured. (Overrides Task.Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging).)
Top

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.

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.

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

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

Community Additions

ADD
Show:
© 2014 Microsoft