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.


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

public sealed class ActiveXScriptTask : Task, 
	IDTSComponentPersist, IDTSActiveXScriptTask, IDTSBreakpointSite, IDTSSuspend

The ActiveXScriptTask type exposes the following members.

Public methodActiveXScriptTaskInitializes a new instance of the ActiveXScriptTask class.

Public propertyDebugModeA Boolean that indicates if a task should check if breakpoints are enabled.
Public propertyEntryMethodStores the entry method for the corresponding scripting language.
Public propertyExecutionValueReturns a user-defined object. This field is read-only. (Overrides Task.ExecutionValue.)
Public propertyExecutionValuePropertyUses the ExecutionValueChoice to determine what the ExecutionValue will contain.
Public propertyScriptingLanguageGets or sets the name of the scripting language.
Public propertyScriptTextGets or sets the script to run.
Public propertySuspendRequiredGets or sets a Boolean that indicates whether tasks should suspend when they encounter a breakpoint.
Public propertyVersion*** Member deprecated; see Remarks. ***   Returns the version of the task. This property is read-only. (Inherited from Task.)

Public methodAcceptBreakpointManagerPasses 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 methodCanUpdate*** Member deprecated; see Remarks. ***   A Boolean that indicates whether the new package XML can update the old package XML. (Inherited from Task.)
Public methodEqualsDetermines whether two object instances are equal. (Inherited from DtsObject.)
Public methodExecuteRuns the task. (Overrides Task.Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object).)
Protected methodFinalize (Inherited from Object.)
Public methodGetConnectionIDGets a String containing the ID of the connection. (Inherited from Task.)
Public methodGetConnectionNameGets a String containing the name of the connection. (Inherited from Task.)
Public methodGetHashCodeReturns the hash code for this instance. (Inherited from DtsObject.)
Public methodGetType (Inherited from Object.)
Public methodInitializeTaskInitializes the properties associated with the task. This method is called by the runtime and is not used in code. (Inherited from Task.)
Public methodLoadFromXMLThis method is not callable by your application code. To load a package saved as .xml, use the Application.LoadPackage method.
Protected methodMemberwiseClone (Inherited from Object.)
Public methodResumeExecutionResumes execution of the task after pausing.
Public methodSaveToXMLThis method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method.
Public methodSuspendExecutionIndicates that the executable needs to suspend.
Public methodToString (Inherited from Object.)
Public methodUpdate*** 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 methodValidateVerifies that the task is properly configured. (Overrides Task.Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging).)

Public fieldVariablesStores 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.

Important noteImportant

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.

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

Community Additions