通过

  • 项目

ScriptTask 类

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.

继承层次结构

System. . :: . .Object
  Microsoft.SqlServer.Dts.Runtime. . :: . .DtsObject
    Microsoft.SqlServer.Dts.Runtime. . :: . .Task
      Microsoft.SqlServer.Dts.Tasks.ScriptTask..::..ScriptTask

命名空间：  Microsoft.SqlServer.Dts.Tasks.ScriptTask
程序集：  Microsoft.SqlServer.ScriptTask（在 Microsoft.SqlServer.ScriptTask.dll 中）

语法

声明
<GuidAttribute("2EC4E475-058D-3590-8909-279F833D8B9C")> _
<ComVisibleAttribute(True)> _
Public Class ScriptTask _
    Inherits Task _
    Implements IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist
用法
Dim instance As ScriptTask

[GuidAttribute("2EC4E475-058D-3590-8909-279F833D8B9C")]
[ComVisibleAttribute(true)]
public class ScriptTask : Task, IDTSBreakpointSite, 
    IDTSSuspend, IDTSComponentPersist

[GuidAttribute(L"2EC4E475-058D-3590-8909-279F833D8B9C")]
[ComVisibleAttribute(true)]
public ref class ScriptTask : public Task, 
    IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist

[<GuidAttribute("2EC4E475-058D-3590-8909-279F833D8B9C")>]
[<ComVisibleAttribute(true)>]
type ScriptTask =  
    class
        inherit Task
        interface IDTSBreakpointSite
        interface IDTSSuspend
        interface IDTSComponentPersist
    end

public class ScriptTask extends Task implements IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist

ScriptTask 类型公开以下成员。

构造函数

  名称 说明
公共方法 ScriptTask Initializes a new instance of the ScriptTask class.

页首

属性

  名称 说明
公共属性 BreakpointManager Returns the BreakpointManager used for controlling breakpoints on this task.
公共属性 Breakpoints Returns an array of breakpoints set on this task.
公共属性 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 Returns a user-defined object. This field is read-only. （覆盖 Task. . :: . .ExecutionValue。）
公共属性 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.
公共属性 ScriptingEngine Gets the VSTATaskScriptingEngine class.
公共属性 ScriptLanguage Gets or sets the programming language in which the script is written.
公共属性 ScriptLoaded Gets a value indicating whether the task contains custom script.
公共属性 ScriptProjectName Gets or sets the name of the script project.
公共属性 ScriptStorage Gets the [VSTAScriptProjectStorage].
公共属性 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 *** Member deprecated; see Remarks. ***    Returns the version of the task. This property is read-only. （从 Task 继承。）

页首

方法

  名称 说明
公共方法 AcceptBreakpointManager Passes a BreakpointManager to the task. 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. （从 Task 继承。）
公共方法 Equals Determines whether two object instances are equal. （从 DtsObject 继承。）
公共方法 Execute Runs the Script task. （覆盖 Task. . :: . .Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object)。）
受保护方法 Finalize Releases all resources used by the ScriptTask. （覆盖 Object. . :: . .Finalize() () () ()。）
公共方法 GetConnectionID Gets a String containing the ID of the connection. （从 Task 继承。）
公共方法 GetConnectionName Gets a String containing the name of the connection. （从 Task 继承。）
公共方法 GetHashCode Returns the hash code for this instance. （从 DtsObject 继承。）
公共方法 GetType （从 Object 继承。）
公共方法 InitializeTask Initializes the properties associated with the Script task. This method is called by the runtime and is not used in code. （覆盖 Task. . :: . .InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker)。）
公共方法 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.
受保护方法 MemberwiseClone （从 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.
公共方法 SetUniqueScriptProjectName Sets the unique name of the script project.
公共方法 SuspendExecution Indicates that the executable must suspend execution. This method is called by the run-time engine.
公共方法 ToString （从 Object 继承。）
公共方法 Update *** Member deprecated; see Remarks. ***    This method updates the old package XML with the new package XML if CanUpdate is set to true. （从 Task 继承。）
公共方法 Validate Verifies that the component is correctly configured. （覆盖 Task. . :: . .Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging)。）

页首

注释

The ScriptTask class defines the Script task and handles the interaction of the Script task with the runtime and with Visual Studio for Applications.

For more information, see 脚本任务 and 脚本任务的编码和调试.

示例

The following code sample, implemented in a console application, adds a ScriptTask to the package and displays the default values of some of its properties.

using System;
using Microsoft.SqlServer.Dts.Runtime;

namespace ScriptTaskCS
{
  class Program
  {
    static void Main(string[] args)
    {
      Package pkg = new Package();
      string newLine = System.Environment.NewLine;

      Executable exe = pkg.Executables.Add("STOCK:ScriptTask");
      TaskHost thTask = (TaskHost)exe;

      string taskInfo;
      taskInfo = 
        
        "Entry point: " + 
        thTask.Properties["EntryPoint"].GetValue(thTask) + newLine + 
        "Script Language: " + 
        thTask.Properties["ScriptLanguage"].GetValue(thTask) + newLine + 
        "ReadOnlyVariables: " + 
        thTask.Properties["ReadOnlyVariables"].GetValue(thTask) + newLine + 
        "ReadWriteVariables: " + 
        thTask.Properties["ReadWriteVariables"].GetValue(thTask);

      Console.WriteLine(taskInfo);
      Console.Read();
    }
  }
}

Imports Microsoft.SqlServer.Dts.Runtime

Module Module1

  Sub Main()

    Dim pkg As New Package
    Dim newLine As String = System.Environment.NewLine

    Dim exe As Executable = pkg.Executables.Add("STOCK:ScriptTask")
    Dim thTask As TaskHost = CType(exe, TaskHost)

    Dim taskInfo As String
    taskInfo = 
      
      "Entry point: " & _
      thTask.Properties("EntryPoint").GetValue(thTask) & newLine & _
      "Script Language: " & _
      thTask.Properties("ScriptLanguage").GetValue(thTask) & newLine & _
      "ReadOnlyVariables: " & _
      thTask.Properties("ReadOnlyVariables").GetValue(thTask) & newLine & _
      "ReadWriteVariables: " & _
      thTask.Properties("ReadWriteVariables").GetValue(thTask)

    Console.WriteLine(taskInfo)
    Console.Read()

  End Sub

End Module

线程安全

此类型的任何公共 static（在 Visual Basic 中为 Shared） 成员都是线程安全的。不保证所有实例成员都是线程安全的。