ScriptTask Members

  • Article

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.

The following tables list the members exposed by the ScriptTask type.

Public Constructors

  Name Description
ScriptTask Initializes a new instance of the ScriptTask class.

Top

Public Fields

  Name Description
ms215013.pubfield(en-US,SQL.90).gif ScriptLanguageInfo Contains a ScriptLanguageInfo structure.

Top

Public Properties

  Name Description
ms215013.pubproperty(en-US,SQL.90).gif BreakpointManager Returns the BreakpointManager used for controlling breakpoints on this task.
ms215013.pubproperty(en-US,SQL.90).gif Breakpoints Returns an array of breakpoints set on this task.
ms215013.pubproperty(en-US,SQL.90).gif CodeProvider  
ms215013.pubproperty(en-US,SQL.90).gif 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.
ms215013.pubproperty(en-US,SQL.90).gif EntryPoint Gets or sets the name of the class that is executed as the entry point.
ms215013.pubproperty(en-US,SQL.90).gif ExecutionValue Overridden. Returns a user-defined object. This field is read-only.
ms215013.pubproperty(en-US,SQL.90).gif PreCompile Gets or sets a value indicating whether the VSA script is compiled when the package is saved.
ms215013.pubproperty(en-US,SQL.90).gif ReadOnlyVariables Gets or sets the comma-delimited list of existing variables made available to the package by the user for read-only access.
ms215013.pubproperty(en-US,SQL.90).gif ReadWriteVariables Gets or sets the comma-delimited list of existing variables made available to the package by the user for read/write access.
ms215013.pubproperty(en-US,SQL.90).gif ScriptLanguage Gets or sets the programming language in which the script is written.
ms215013.pubproperty(en-US,SQL.90).gif ScriptLoaded Gets a value indicating whether the task contains custom script.
ms215013.pubproperty(en-US,SQL.90).gif 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.
ms215013.pubproperty(en-US,SQL.90).gif Version  Returns the version of the task. This property is read-only. (inherited from Task)
ms215013.pubproperty(en-US,SQL.90).gif VsaProjectName Gets or sets the name of the Visual Studio for Applications (VSA) project that the Script task uses.
ms215013.pubproperty(en-US,SQL.90).gif WaitForMe  Returns a Boolean that indicates whether the parent container should wait for completion of this task. This property is read-only. (inherited from Task)

Top

Public Methods

(see also Protected Methods )

  Name Description
ms215013.pubmethod(en-US,SQL.90).gif AcceptBreakpointManager Passes a BreakpointManager to the task. This method is called by the runtime and is not used in code.
ms215013.pubmethod(en-US,SQL.90).gif CanUpdate  (inherited from Task )
ms215013.pubmethod(en-US,SQL.90).gif Equals  Overloaded. (inherited from DtsObject )
ms215013.pubmethod(en-US,SQL.90).gif Execute Overridden. Runs the Script task.
ms215013.pubmethod(en-US,SQL.90).gif GetConnectionID  (inherited from Task )
ms215013.pubmethod(en-US,SQL.90).gif GetConnectionName  (inherited from Task )
ms215013.pubmethod(en-US,SQL.90).gif GetHashCode  Returns the hash code for this instance. (inherited from DtsObject)
ms215013.pubmethod(en-US,SQL.90).gif GetType  (inherited from Object )
ms215013.pubmethod(en-US,SQL.90).gif InitializeTask Overridden. Initializes the properties associated with the Script task. This method is called by the runtime and is not used in code.
ms215013.pubmethod(en-US,SQL.90).gif LoadFromXML Loads the Script task data from XML. This method is not callable by your application code. To load a package saved as .xml, use the Application.LoadPackage method.
ms215013.pubmethod(en-US,SQL.90).gifms215013.static(en-US,SQL.90).gif op_Equality  (inherited from DtsObject )
ms215013.pubmethod(en-US,SQL.90).gifms215013.static(en-US,SQL.90).gif op_Inequality  (inherited from DtsObject )
ms215013.pubmethod(en-US,SQL.90).gifms215013.static(en-US,SQL.90).gif ReferenceEquals  (inherited from Object )
ms215013.pubmethod(en-US,SQL.90).gif ReportBreakpointChanges  
ms215013.pubmethod(en-US,SQL.90).gif ResumeExecution Resumes execution of the task or container by the run-time engine after pausing.
ms215013.pubmethod(en-US,SQL.90).gif SaveToXML Saves the Script task component to XML. This method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method.
ms215013.pubmethod(en-US,SQL.90).gif SetUniqueVsaProjectName This method sets the VsaProjectName property of the task to a unique value.
ms215013.pubmethod(en-US,SQL.90).gif SuspendExecution Indicates that the executable must suspend execution. This method is called by the run-time engine.
ms215013.pubmethod(en-US,SQL.90).gif ToString  (inherited from Object )
ms215013.pubmethod(en-US,SQL.90).gif Update  (inherited from Task )
ms215013.pubmethod(en-US,SQL.90).gif Validate Overridden. Verifies that the component is correctly configured.

Top

Protected Methods

  Name Description
ms215013.protmethod(en-US,SQL.90).gif Finalize Overridden. Releases all resources used by the ScriptTask.
ms215013.protmethod(en-US,SQL.90).gif MemberwiseClone  (inherited from Object )

Top

See Also

Reference

ScriptTask Class
Microsoft.SqlServer.Dts.Tasks.ScriptTask Namespace