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
System.Object
Microsoft.SqlServer.Dts.Runtime.DtsObject
Microsoft.SqlServer.Dts.Runtime.Task
Microsoft.SqlServer.Dts.Tasks.ActiveXScriptTask.ActiveXScriptTask
Namespace: Microsoft.SqlServer.Dts.Tasks.ActiveXScriptTask
Assembly: Microsoft.SqlServer.ActiveXScriptTask (in Microsoft.SqlServer.ActiveXScriptTask.dll)
Syntax
'Declaration
Public NotInheritable Class ActiveXScriptTask _
Inherits Task _
Implements IDTSComponentPersist, IDTSActiveXScriptTask, IDTSBreakpointSite, IDTSSuspend
'Usage
Dim instance As ActiveXScriptTask
public sealed class ActiveXScriptTask : Task,
IDTSComponentPersist, IDTSActiveXScriptTask, IDTSBreakpointSite, IDTSSuspend
public ref class ActiveXScriptTask sealed : public Task,
IDTSComponentPersist, IDTSActiveXScriptTask, IDTSBreakpointSite, IDTSSuspend
[<SealedAttribute>]
type ActiveXScriptTask =
class
inherit Task
interface IDTSComponentPersist
interface IDTSActiveXScriptTask
interface IDTSBreakpointSite
interface IDTSSuspend
end
public final class ActiveXScriptTask extends Task implements IDTSComponentPersist, IDTSActiveXScriptTask, IDTSBreakpointSite, IDTSSuspend
The ActiveXScriptTask type exposes the following members.
Constructors
Name | Description | |
---|---|---|
ActiveXScriptTask | Initializes a new instance of the ActiveXScriptTask class. |
Top
Properties
Name | Description | |
---|---|---|
DebugMode | A Boolean that indicates if a task should check if breakpoints are enabled. | |
EntryMethod | Stores the entry method for the corresponding scripting language. | |
ExecutionValue | Returns a user-defined object. This field is read-only. (Overrides Task.ExecutionValue.) | |
ExecutionValueProperty | Uses the ExecutionValueChoice to determine what the ExecutionValue will contain. | |
ScriptingLanguage | Gets or sets the name of the scripting language. | |
ScriptText | Gets or sets the script to run. | |
SuspendRequired | Gets or sets a Boolean that indicates whether tasks should suspend when they encounter a breakpoint. | |
Version | *** Member deprecated; see Remarks. *** Returns the version of the task. This property is read-only. (Inherited from Task.) |
Top
Methods
Name | Description | |
---|---|---|
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. | |
CanUpdate | *** Member deprecated; see Remarks. *** A Boolean that indicates whether the new package XML can update the old package XML. (Inherited from Task.) | |
Equals | Determines whether two object instances are equal. (Inherited from DtsObject.) | |
Execute | Runs the task. (Overrides Task.Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object).) | |
Finalize | (Inherited from Object.) | |
GetConnectionID | Gets a String containing the ID of the connection. (Inherited from Task.) | |
GetConnectionName | 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 | Initializes the properties associated with the task. This method is called by the runtime and is not used in code. (Inherited from Task.) | |
LoadFromXML | This method is not callable by your application code. To load a package saved as .xml, use the Application.LoadPackage method. | |
MemberwiseClone | (Inherited from Object.) | |
ResumeExecution | Resumes execution of the task after pausing. | |
SaveToXML | This method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method. | |
SuspendExecution | Indicates that the executable needs to suspend. | |
ToString | (Inherited from Object.) | |
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.) | |
Validate | Verifies that the task is properly configured. (Overrides Task.Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging).) |
Top
Fields
Name | Description | |
---|---|---|
Variables | Stores the Variables collection, which contains a collection of Variable objects. |
Top
Remarks
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.
Important
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.