Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
MSDN Library

ScriptTask Class

 

Applies To: SQL Server 2016 Preview

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)

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

[<GuidAttribute("A6564AF4-CE42-4CCF-9DA9-CEF88F19DE2F")>]
[<ComVisibleAttribute(true)>]
type ScriptTask = 
    class
        inherit Task
        interface IDTSBreakpointSite
        interface IDTSSuspend
        interface IDTSComponentPersist
    end

NameDescription
System_CAPS_pubmethodScriptTask()

Initializes a new instance of the ScriptTask class.

NameDescription
System_CAPS_pubpropertyBreakpointManager

Gets the BreakpointManager used for controlling breakpoints on this task.

System_CAPS_pubpropertyBreakpoints

Gets an array of breakpoints set on this task.

System_CAPS_pubpropertyDebugMode

Gets 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.

System_CAPS_pubpropertyDefaultActiveItem

Gets the default script.

System_CAPS_pubpropertyEntryPoint

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

System_CAPS_pubpropertyExecutionValue

Gets a user-defined object. This field is read-only.(Overrides Task.ExecutionValue.)

System_CAPS_pubpropertyProjectTemplatePath

Gets the path of the specified project template.

System_CAPS_pubpropertyReadOnlyVariables

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

System_CAPS_pubpropertyReadWriteVariables

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

System_CAPS_pubpropertyScriptingEngine

Gets the VSTATaskScriptingEngine class.

System_CAPS_pubpropertyScriptLanguage

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

System_CAPS_pubpropertyScriptLoaded

Gets a value indicating whether the task contains custom script.

System_CAPS_pubpropertyScriptProjectName

Gets or sets the name of the script project.

System_CAPS_pubpropertyScriptStorage

Gets the VSTAScriptProjectStorage for the script.

System_CAPS_pubpropertySuspendRequired

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.

System_CAPS_pubpropertyVersion

*** Member deprecated; see Remarks. ***   Returns the version of the task. This property is read-only.(Inherited from Task.)

NameDescription
System_CAPS_pubmethodAcceptBreakpointManager(BreakpointManager)

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

System_CAPS_pubmethodCanUpdate(String)

*** Member deprecated; see Remarks. ***   A Boolean that indicates whether the new package XML can update the old package XML.(Inherited from Task.)

System_CAPS_pubmethodEquals(Object)

Determines whether two object instances are equal.(Inherited from DtsObject.)

System_CAPS_pubmethodExecute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object)

Executes the script contained in this instance of DTS Script Task.(Overrides Task.Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object).)

System_CAPS_protmethodFinalize()

Releases all resources used by the ScriptTask.(Overrides Object.Finalize().)

System_CAPS_pubmethodGetConnectionID(Connections, String)

Gets a String containing the ID of the connection.(Inherited from Task.)

System_CAPS_pubmethodGetConnectionName(Connections, String)

Gets a String containing the name of the connection.(Inherited from Task.)

System_CAPS_pubmethodGetHashCode()

Returns the hash code for this instance.(Inherited from DtsObject.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodInitializeTask(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.(Overrides Task.InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker).)

System_CAPS_pubmethodLoadFromXML(XmlElement, IDTSInfoEvents)

Implements loading of properties from XML document.

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodReportBreakpointChanges()

This API supports the product infrastructure and is not intended to be used directly from your code. Reports the breakpoint changes from the task.

System_CAPS_pubmethodResumeExecution()

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

System_CAPS_pubmethodSaveToXML(XmlDocument, IDTSInfoEvents)

Implements saving of properties to XML document.

System_CAPS_pubmethodSetUniqueScriptProjectName()

Sets the unique name of the script project.

System_CAPS_pubmethodSuspendExecution()

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

System_CAPS_pubmethodToString()

(Inherited from Object.)

System_CAPS_pubmethodUpdate(String)

*** 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.)

System_CAPS_pubmethodValidate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging)

Verifies that the component is correctly configured.(Overrides Task.Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging).)

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.

Legacy Code 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.

No code example is currently available or this language may not be supported.

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

Return to top

Community Additions

Show:
© 2015 Microsoft