ScriptTask Members
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 | |
---|---|---|
ScriptLanguageInfo | Contains a ScriptLanguageInfo structure. |
Top
Public Properties
Name | Description | |
---|---|---|
BreakpointManager | Returns the BreakpointManager used for controlling breakpoints on this task. | |
Breakpoints | Returns an array of breakpoints set on this task. | |
CodeProvider | ||
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. | |
EntryPoint | Gets or sets the name of the class that is executed as the entry point. | |
ExecutionValue | Overridden. Returns a user-defined object. This field is read-only. | |
PreCompile | Gets or sets a value indicating whether the VSA script is compiled when the package is saved. | |
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. | |
ScriptLanguage | Gets or sets the programming language in which the script is written. | |
ScriptLoaded | Gets a value indicating whether the task contains custom 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. | |
Version | Returns the version of the task. This property is read-only. (inherited from Task) | |
VsaProjectName | Gets or sets the name of the Visual Studio for Applications (VSA) project that the Script task uses. | |
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 | |
---|---|---|
AcceptBreakpointManager | Passes a BreakpointManager to the task. This method is called by the runtime and is not used in code. | |
CanUpdate | (inherited from Task ) | |
Equals | Overloaded. (inherited from DtsObject ) | |
Execute | Overridden. Runs the Script task. | |
GetConnectionID | (inherited from Task ) | |
GetConnectionName | (inherited from Task ) | |
GetHashCode | Returns the hash code for this instance. (inherited from DtsObject) | |
GetType | (inherited from Object ) | |
InitializeTask | Overridden. Initializes the properties associated with the Script task. This method is called by the runtime and is not used in code. | |
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. | |
op_Equality | (inherited from DtsObject ) | |
op_Inequality | (inherited from DtsObject ) | |
ReferenceEquals | (inherited from Object ) | |
ReportBreakpointChanges | ||
ResumeExecution | Resumes execution of the task or container by the run-time engine after pausing. | |
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. | |
SetUniqueVsaProjectName | This method sets the VsaProjectName property of the task to a unique value. | |
SuspendExecution | Indicates that the executable must suspend execution. This method is called by the run-time engine. | |
ToString | (inherited from Object ) | |
Update | (inherited from Task ) | |
Validate | Overridden. Verifies that the component is correctly configured. |
Top
Protected Methods
Name | Description | |
---|---|---|
Finalize | Overridden. Releases all resources used by the ScriptTask. | |
MemberwiseClone | (inherited from Object ) |
Top
See Also
Reference
ScriptTask Class
Microsoft.SqlServer.Dts.Tasks.ScriptTask Namespace