ActiveXScriptTask Class

Enables migration for ActiveX scripts created in SQL Server 2000. The ActiveXScriptTask is not intended for future use. This class cannot be inherited.

Inheritance Hierarchy


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


Public NotInheritable Class ActiveXScriptTask _
    Inherits Task _
    Implements IDTSComponentPersist, IDTSActiveXScriptTask, IDTSBreakpointSite, IDTSSuspend
Dim instance As ActiveXScriptTask
public sealed class ActiveXScriptTask : Task, 
    IDTSComponentPersist, IDTSActiveXScriptTask, IDTSBreakpointSite, IDTSSuspend
public ref class ActiveXScriptTask sealed : public Task, 
    IDTSComponentPersist, IDTSActiveXScriptTask, IDTSBreakpointSite, IDTSSuspend
type ActiveXScriptTask =  
        inherit Task
        interface IDTSComponentPersist
        interface IDTSActiveXScriptTask
        interface IDTSBreakpointSite
        interface IDTSSuspend
public final class ActiveXScriptTask extends Task implements IDTSComponentPersist, IDTSActiveXScriptTask, IDTSBreakpointSite, IDTSSuspend

The ActiveXScriptTask type exposes the following members.


  Name Description
Public method ActiveXScriptTask Initializes a new instance of the ActiveXScriptTask class.



  Name Description
Public property DebugMode A Boolean that indicates if a task should check if breakpoints are enabled.
Public property EntryMethod Stores the entry method for the corresponding scripting language.
Public property ExecutionValue Returns a user-defined object. This field is read-only. (Overrides Task.ExecutionValue.)
Public property ExecutionValueProperty Uses the ExecutionValueChoice to determine what the ExecutionValue will contain.
Public property ScriptingLanguage Gets or sets the name of the scripting language.
Public property ScriptText Gets or sets the script to run.
Public property SuspendRequired Gets or sets a Boolean that indicates whether tasks should suspend when they encounter a breakpoint.
Public property Version *** Member deprecated; see Remarks. ***    Returns the version of the task. This property is read-only. (Inherited from Task.)



  Name Description
Public method AcceptBreakpointManager Passes a BreakpointManager to a task. The task will use the breakpoint manager to create, remove, and check the status of breakpoints. This method is called by the runtime and is not used in code.
Public method CanUpdate *** Member deprecated; see Remarks. ***    A Boolean that indicates whether the new package XML can update the old package XML. (Inherited from Task.)
Public method Equals Determines whether two object instances are equal. (Inherited from DtsObject.)
Public method Execute Runs the task. (Overrides Task.Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object).)
Protected method Finalize (Inherited from Object.)
Public method GetConnectionID Gets a String containing the ID of the connection. (Inherited from Task.)
Public method GetConnectionName Gets a String containing the name of the connection. (Inherited from Task.)
Public method GetHashCode Returns the hash code for this instance. (Inherited from DtsObject.)
Public method GetType (Inherited from Object.)
Public method InitializeTask Initializes the properties associated with the task. This method is called by the runtime and is not used in code. (Inherited from Task.)
Public method LoadFromXML This method is not callable by your application code. To load a package saved as .xml, use the Application.LoadPackage method.
Protected method MemberwiseClone (Inherited from Object.)
Public method ResumeExecution Resumes execution of the task after pausing.
Public method SaveToXML This method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method.
Public method SuspendExecution Indicates that the executable needs to suspend.
Public method ToString (Inherited from Object.)
Public method Update *** 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 method Validate Verifies that the task is properly configured. (Overrides Task.Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging).)



  Name Description
Public field Variables Stores the Variables collection, which contains a collection of Variable objects.



The task is a successor in Integration Services for the legacy ActiveX script tasks. Any legacy tasks that use macros defined in SQL Server 2000 will not run in Integration Services. The task can run VBScript and JScript without accessing the Integration Services programming model.


This feature will be removed in the next version of Microsoft SQL Server. Do not use this feature in new development work, and modify applications that currently use this feature as soon as possible.

Thread Safety

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