ScriptObjectModel.Variables Property

  • [アーティクル]

スクリプト タスクを含むパッケージで定義された既存の変数の Variables コレクションを返します。

名前空間: Microsoft.SqlServer.Dts.Tasks.ScriptTask
アセンブリ: Microsoft.SqlServer.ScriptTask (microsoft.sqlserver.scripttask.dll 内)

構文

'宣言
Public ReadOnly Property Variables As Variables

public Variables Variables { get; }

public:
property Variables^ Variables {
    Variables^ get ();
}

/** @property */
public Variables get_Variables ()

public function get Variables () : Variables

プロパティ値

スクリプト タスクを含むパッケージで定義された既存の変数の Variables コレクションです。

解説

タスクの ReadOnlyVariables プロパティおよび ReadWriteVariables プロパティによって使用可能な変数にアクセスするには、スクリプト タスク コードで Dts オブジェクトの Variables プロパティを使用します。

使用例

スクリプト タスク内で使用する次のサンプル コードは、パッケージ ワークフローのパスを確認するためにスクリプト タスクで変数にアクセスして使用する方法を示しています。このサンプルは、CustomerCount と MaxRecordCount という名前の整数変数を作成し、スクリプト タスク エディタ でそれらの変数を ReadOnlyVariables コレクションに追加していることを前提にします。両方の変数の値を設定します。MaxRecordCount の値より高い値と低い値の両方を CustomerCount に設定しています。CustomerCount 変数には、インポートされる顧客レコードの数が格納されています。この値が MaxRecordCount の値より大きいと、スクリプト タスクは失敗します。MaxRecordCount のしきい値を超えたために失敗した場合は、ワークフローのエラー パスに必要なクリーンアップ コードをすべて実装できます。

Public Sub Main()

    Dim customerCount As Integer
    Dim maxRecordCount As Integer

    If Dts.Variables.Contains("CustomerCount") = True AndAlso _
        Dts.Variables.Contains("MaxRecordCount") = True Then

        customerCount = _
            CType(Dts.Variables("CustomerCount").Value, Integer)
        maxRecordCount = _
            CType(Dts.Variables("MaxRecordCount").Value, Integer)

    End If

    If customerCount > maxRecordCount Then
            Dts.TaskResult = Dts.Results.Failure
    Else
            Dts.TaskResult = Dts.Results.Success
    End If

End Sub

スレッド セーフ

この型の public static (Microsoft Visual Basic では共有 ) メンバは、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

開発プラットフォーム

サポートされているプラットフォームの一覧については、「SQL Server 2005 のインストールに必要なハードウェアおよびソフトウェア」を参照してください。

対象プラットフォーム

サポートされているプラットフォームの一覧については、「SQL Server 2005 のインストールに必要なハードウェアおよびソフトウェア」を参照してください。

参照

関連項目

ScriptObjectModel Class
ScriptObjectModel Members
Microsoft.SqlServer.Dts.Tasks.ScriptTask Namespace