ScriptObjectModel クラス

定義

名前空間:

Microsoft.SqlServer.Dts.Tasks.ScriptTask

アセンブリ:

Microsoft.SqlServer.ScriptTask.dll

スクリプト タスクの開発者に、グローバル Dts オブジェクトを使用してパッケージで定義されているオブジェクトにプログラムでアクセスできるようにします。 Dts オブジェクトは、クラスの ScriptObjectModel インスタンスです。

public ref class ScriptObjectModel

public class ScriptObjectModel

type ScriptObjectModel = class

Public Class ScriptObjectModel

継承

Object

ScriptObjectModel

例

スクリプト タスク内で使用する次のサンプル コードは、Variables、Events、および TaskResult プロパティの使用方法を示します。 詳細については、「 スクリプト タスクを使用した Active Directory のクエリ」を参照してください。

Public Sub Main()  

    Dim directory As DirectoryServices.DirectorySearcher  
    Dim result As DirectoryServices.SearchResult  
    Dim email As String  

    email = Dts.Variables("email").Value.ToString  

    Try  
        directory = New _  
            DirectoryServices.DirectorySearcher("(mail=" & email & ")")  
        result = directory.FindOne  
        Dts.Variables("name").Value = _  
            result.Properties("displayname").ToString  
        Dts.Variables("title").Value = _  
            result.Properties("title").ToString  
        Dts.TaskResult = ScriptResults.Success  
    Catch ex As Exception  
        Dts.Events.FireError(0, _  
            "Script Task Example", _  
            ex.Message & ControlChars.CrLf & ex.StackTrace, _  
            String.Empty, 0)  
        Dts.TaskResult = ScriptResults.Failure  
    End Try  

End Sub  

注釈

Microsoft Visual Studio Tools for Applications (VSTA) スクリプト環境内では、スクリプト タスクはグローバル Dts オブジェクトを提供します。これにより、開発者は、パッケージ内の他の場所で定義されているオブジェクト (接続、変数、イベントなど) に、クラスのScriptObjectModelプロパティとメソッドを使用してプログラムでアクセスできます。 Dts オブジェクトは、ScriptObjectModel クラスのインスタンスです。

プロパティ

Connections	スクリプト タスクを含むパッケージで定義された既存の接続の Connections コレクションを返します。
Events	スクリプト タスクを含むパッケージで定義された既存のイベントの IDTSComponentEvents コレクションを返します。
ExecutionValue	タスクの実行結果についての追加情報を提供するユーザー定義のオブジェクトを取得します。値の設定も可能です。
TaskResult	スクリプト タスクの DTSExecResult を返します。
Transaction	スクリプト タスクのコンテナーに関連付けられたトランザクションを返します。
VariableDispenser	既存の変数と連携するためにスクリプト タスク内で使用できる VariableDispenser を返します。
Variables	スクリプト タスクを含むパッケージで定義された既存の変数の Variables コレクションを返します。

メソッド

Log(String, Int32, Byte[])

有効なすべてのログ プロバイダーにエントリを記録します。