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	タスクがブレークポイントを検出したときにタスクの実行を中断するかどうかを示すブール型 (Boolean) の値を取得または設定します。 この値は、ブレークポイントに到達したときにタスクおよびコンテナーに対してランタイム エンジンで設定されます。
TargetServerVersion	スクリプト タスクのクラスを定義します。これにより、開発者は Integration Services によって提供される組み込みタスクでは使用できない関数を実行するカスタム コードを記述できます。 (継承元 Task)
Version	*** このメンバーは非推奨です。「解説」を参照してください。 タスクのバージョンを返します。 このプロパティは読み取り専用です。 (継承元 Task)

メソッド

AcceptBreakpointManager(BreakpointManager)	タスクに BreakpointManager を渡します。 このメソッドはランタイムから呼び出されるメソッドであり、コードでは使用されません。
CanUpdate(String)	*** このメンバーは非推奨です。「解説」を参照してください。 新しいパッケージ XML が古いパッケージ XML を更新できるかどうかを示すブール値。 (継承元 Task)
Equals(Object)	2 つのオブジェクト インスタンスが等しいかどうかを判断します。 (継承元 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)	*** このメンバーは非推奨です。「解説」を参照してください。 このメソッドは、true に設定されている場合 CanUpdate(String) 、新しいパッケージ XML で古いパッケージ XML を更新します。 (継承元 Task)
Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging)	コンポーネントが正しく構成されていることを確認します。