Variables プロパティ

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

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

構文

'宣言
Public ReadOnly Property Variables As Variables
    Get
'使用
Dim instance As ScriptObjectModel
Dim value As Variables

value = instance.Variables

public Variables Variables { get; }

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

member Variables : Variables

function get Variables () : Variables

プロパティ値

型: Microsoft.SqlServer.Dts.Runtime. . :: . .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 = ScriptResults.Failure
    Else
            Dts.TaskResult = ScriptResults.Success
    End If

End Sub

関連項目

参照

ScriptObjectModel クラス

ScriptObjectModel メンバー

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