ScriptTask 類別

發行項
04/26/2013

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("8D1A24AD-9B5D-49E4-B160-53CD9D6ACCFD")> _
<ComVisibleAttribute(True)> _
Public Class ScriptTask _
    Inherits Task _
    Implements IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist
'用途
Dim instance As ScriptTask

[GuidAttribute("8D1A24AD-9B5D-49E4-B160-53CD9D6ACCFD")]
[ComVisibleAttribute(true)]
public class ScriptTask : Task, IDTSBreakpointSite, 
    IDTSSuspend, IDTSComponentPersist

[GuidAttribute(L"8D1A24AD-9B5D-49E4-B160-53CD9D6ACCFD")]
[ComVisibleAttribute(true)]
public ref class ScriptTask : public Task, 
    IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist

[<GuidAttribute("8D1A24AD-9B5D-49E4-B160-53CD9D6ACCFD")>]
[<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	Gets the BreakpointManager used for controlling breakpoints on this task.
	Breakpoints	Gets 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.
	DefaultActiveItem	Gets the default script.
	EntryPoint	Gets or sets the name of the class that is executed as the entry point.
	ExecutionValue	Gets a user-defined object. This field is read-only. (覆寫 Task.ExecutionValue。)
	ProjectTemplatePath	Gets the path of the specified project template.
	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] for the 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	* 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	Executes the script contained in this instance of DTS 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	Implements loading of properties from XML document.
	MemberwiseClone	(繼承自 Object。)
	ReportBreakpointChanges	基礎結構。Reports the breakpoint changes from the task.
	ResumeExecution	Resumes execution of the task or container by the run-time engine after pausing.
	SaveToXML	Implements saving of properties to XML document.
	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) 成員都是執行緒安全的。並不是所有的執行個體成員都保證可以用於所有的執行緒。

請參閱

參考

Microsoft.SqlServer.Dts.Tasks.ScriptTask 命名空間

共用方式為

ScriptTask 類別

繼承階層

語法

建構函式

屬性

方法

備註

範例

執行緒安全性

請參閱

參考

其他資源