ScriptTask 类

定义

命名空间:

Microsoft.SqlServer.Dts.Tasks.ScriptTask

程序集:

Microsoft.SqlServer.ScriptTask.dll

定义脚本任务的类，使开发人员能够编写自定义代码来执行 Integration Services 提供的内置任务中不可用的函数。

public ref class ScriptTask : Microsoft::SqlServer::Dts::Runtime::Task, Microsoft::SqlServer::Dts::Runtime::IDTSBreakpointSite, Microsoft::SqlServer::Dts::Runtime::IDTSComponentPersist

[System.Runtime.InteropServices.ComVisible(true)]
[Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.scripttask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.ScriptTask.Localized), SamplesTag="SsisScriptTask", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.ScriptTask.ScriptTaskUI, Microsoft.SqlServer.ScriptTaskUI, Version=15.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
[System.Runtime.InteropServices.Guid("C2F3965A-3FE3-482B-A6F3-2514B78E149D")]
public class ScriptTask : Microsoft.SqlServer.Dts.Runtime.Task, Microsoft.SqlServer.Dts.Runtime.IDTSBreakpointSite, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist

[<System.Runtime.InteropServices.ComVisible(true)>]
[<Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.scripttask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.ScriptTask.Localized), SamplesTag="SsisScriptTask", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.ScriptTask.ScriptTaskUI, Microsoft.SqlServer.ScriptTaskUI, Version=15.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")>]
[<System.Runtime.InteropServices.Guid("C2F3965A-3FE3-482B-A6F3-2514B78E149D")>]
type ScriptTask = class
    inherit Task
    interface IDTSBreakpointSite
    interface IDTSSuspend
    interface IDTSComponentPersist

Public Class ScriptTask
Inherits Task
Implements IDTSBreakpointSite, IDTSComponentPersist

继承

Object

DtsObject

Task

ScriptTask

属性

DtsTaskAttribute ComVisibleAttribute GuidAttribute

实现

IDTSBreakpointSite IDTSComponentPersist IDTSSuspend

示例

在控制台应用程序中实现的以下代码示例将添加到 ScriptTask 包中，并显示其某些属性的默认值。

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  

注解

该 ScriptTask 类定义脚本任务，并处理脚本任务与运行时和 Visual Studio for Applications 的交互。

有关详细信息，请参阅 脚本任务 和 编码和调试脚本任务。

构造函数

ScriptTask()

初始化 ScriptTask 类的新实例。

属性

BreakpointManager	获取用于控制此任务上的断点的 BreakpointManager。
Breakpoints	获取对此任务设置的断点的数组。
DebugMode	获取或设置一个值，该值指示该任务是否在调试模式下运行，以及在运行该任务时是否应引发 OnBreakpointHit(IDTSBreakpointSite, BreakpointTarget) 事件。
DefaultActiveItem	获取默认脚本。
EntryPoint	获取或设置作为入口点执行的类的名称。
ExecutionValue	获取用户定义对象。 此字段为只读。
ProjectTemplatePath	获取指定项目模板的路径。
ReadOnlyVariables	获取或设置可由具有只读访问权限的用户用于包的以逗号分隔的现有变量的列表。
ReadWriteVariables	获取或设置可由具有读/写访问权限的用户用于包的以逗号分隔的现有变量的列表。
ScriptingEngine	获取 VSTATaskScriptingEngine 类。
ScriptLanguage	获取或设置编写脚本所采用的编程语言。
ScriptLoaded	获取一个值，该值指示该任务是否包含自定义脚本。
ScriptProjectName	获取或设置脚本对象的名称。
ScriptStorage	获取脚本的 VSTAScriptProjectStorage。
SuspendRequired	获取或设置一个布尔值，该值指示任务在任务遇到断点时是否应暂停执行。 遇到断点时，将由任务和容器的运行时引擎设置此值。
TargetServerVersion	定义脚本任务的类，使开发人员能够编写自定义代码来执行 Integration Services 提供的内置任务中不可用的函数。 (继承自 Task)
Version	*** 不推荐使用的成员；请参阅“备注”。 *** 返回任务的版本。 此属性为只读。 (继承自 Task)

方法

AcceptBreakpointManager(BreakpointManager)	将 BreakpointManager 传递给该任务。 此方法由运行时调用，在代码中未使用。
CanUpdate(String)	*** 不推荐使用的成员；请参阅“备注”。 指示新包 XML 是否可以更新旧包 XML 的布尔值。 (继承自 Task)
Equals(Object)	确定两个对象实例是否相等。 (继承自 DtsObject)
Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object)	执行此 DTS 脚本任务实例中包含的脚本。
Finalize()	释放由 ScriptTask 使用的所有资源。
GetConnectionID(Connections, String)	获取包含连接 ID 的字符串。 (继承自 Task)
GetConnectionName(Connections, String)	获取包含连接名称的字符串。 (继承自 Task)
GetHashCode()	返回此实例的哈希代码。 (继承自 DtsObject)
InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker)	初始化与该脚本任务相关联的属性。 此方法由运行时调用，在代码中未使用。
LoadFromXML(XmlElement, IDTSInfoEvents)	实现从 XML 文档加载属性。
ReportBreakpointChanges()	报告任务的断点更改。
ResumeExecution()	在暂停后通过运行时引擎恢复任务或容器的执行。
SaveToXML(XmlDocument, IDTSInfoEvents)	实现将属性保存到 XML 文档。
SetUniqueScriptProjectName()	设置脚本对象的唯一名称。
SuspendExecution()	指示可执行文件必须挂起执行。 运行时引擎调用此方法。
Update(String)	*** 不推荐使用的成员；请参阅“备注”。 此方法使用新包 XML 更新旧包 XML（如果 CanUpdate(String) 设置为 true）。 (继承自 Task)
Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging)	验证该组件已正确配置。