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.
Assembly: Microsoft.SqlServer.ScriptTask (in Microsoft.SqlServer.ScriptTask.dll)
Microsoft.SqlServer.Dts.Runtime::DtsObject
Microsoft.SqlServer.Dts.Runtime::Task
Microsoft.SqlServer.Dts.Tasks.ScriptTask::ScriptTask
| Name | Description | |
|---|---|---|
![]() | ScriptTask() | Initializes a new instance of the ScriptTask class. |
| Name | Description | |
|---|---|---|
![]() | BreakpointManager | Gets the BreakpointManager used for controlling breakpoints on this task. |
![]() | Breakpoints | Gets an array of breakpoints set on this task. |
![]() | DebugMode | 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. |
![]() | DefaultActiveItem | Gets the default script. |
![]() | EntryPoint | Gets or sets the name of the class that is executed as the entry point. |
![]() | ExecutionValue | Gets a user-defined object. This field is read-only.(Overrides Task::ExecutionValue.) |
![]() | ProjectTemplatePath | Gets the path of the specified project template. |
![]() | ReadOnlyVariables | Gets or sets the comma-delimited list of existing variables made available to the package by the user for read-only access. |
![]() | ReadWriteVariables | Gets or sets the comma-delimited list of existing variables made available to the package by the user for read/write access. |
![]() | ScriptingEngine | Gets the VSTATaskScriptingEngine class. |
![]() | ScriptLanguage | Gets or sets the programming language in which the script is written. |
![]() | ScriptLoaded | Gets a value indicating whether the task contains custom script. |
![]() | ScriptProjectName | Gets or sets the name of the script project. |
![]() | ScriptStorage | Gets the VSTAScriptProjectStorage for the script. |
![]() | 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 | (Inherited from Task.) |
![]() | Version | *** Member deprecated; see Remarks. *** Returns the version of the task. This property is read-only.(Inherited from Task.) |
| Name | Description | |
|---|---|---|
![]() | AcceptBreakpointManager(BreakpointManager^) | Passes a BreakpointManager to the task. This method is called by the runtime and is not used in code. |
![]() | 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^) | Determines whether two object instances are equal.(Inherited from DtsObject.) |
![]() | Execute(Connections^, VariableDispenser^, IDTSComponentEvents^, IDTSLogging^, Object^) | Executes the script contained in this instance of DTS Script Task.(Overrides Task::Execute(Connections^, VariableDispenser^, IDTSComponentEvents^, IDTSLogging^, Object^).) |
![]() | Finalize() | Releases all resources used by the ScriptTask.(Overrides Object::Finalize().) |
![]() | GetConnectionID(Connections^, String^) | Gets a String containing the ID of the connection.(Inherited from Task.) |
![]() | GetConnectionName(Connections^, String^) | Gets a String containing the name of the connection.(Inherited from Task.) |
![]() | GetHashCode() | Returns the hash code for this instance.(Inherited from DtsObject.) |
![]() | GetType() | (Inherited from Object.) |
![]() | 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.(Overrides Task::InitializeTask(Connections^, VariableDispenser^, IDTSInfoEvents^, IDTSLogging^, EventInfos^, LogEntryInfos^, ObjectReferenceTracker^).) |
![]() | LoadFromXML(XmlElement^, IDTSInfoEvents^) | Implements loading of properties from XML document. |
![]() | MemberwiseClone() | (Inherited from Object.) |
![]() | ReportBreakpointChanges() | This API supports the product infrastructure and is not intended to be used directly from your code. Reports the breakpoint changes from the task. |
![]() | ResumeExecution() | Resumes execution of the task or container by the run-time engine after pausing. |
![]() | SaveToXML(XmlDocument^, IDTSInfoEvents^) | Implements saving of properties to XML document. |
![]() | SetUniqueScriptProjectName() | Sets the unique name of the script project. |
![]() | SuspendExecution() | Indicates that the executable must suspend execution. This method is called by the run-time engine. |
![]() | ToString() | (Inherited from Object.) |
![]() | Update(String^%) | |
![]() | Validate(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.
Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.


