ScriptObjectModel.Variables Property

Reference

Definition

Namespace:: Microsoft.SqlServer.Dts.Tasks.ScriptTask

Assembly:: Microsoft.SqlServer.ScriptTask.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Returns the Variables collection of existing variables defined in the package that contains the Script task.

public:
 property Microsoft::SqlServer::Dts::Runtime::Variables ^ Variables { Microsoft::SqlServer::Dts::Runtime::Variables ^ get(); };

public Microsoft.SqlServer.Dts.Runtime.Variables Variables { get; }

member this.Variables : Microsoft.SqlServer.Dts.Runtime.Variables

Public ReadOnly Property Variables As Variables

Property Value

Variables

The Variables collection of existing variables defined in the package that contains the Script task.

Examples

The following sample of code for use inside a Script task demonstrates how to access and use variables in a Script task to determine the path of package workflow. The sample assumes that you have created integer variables named CustomerCount and MaxRecordCount and added them to the ReadOnlyVariables collection in the Script Task Editor. Set values for both variables; experiment with setting values for CustomerCount that are both higher and lower than the value of MaxRecordCount. The CustomerCount variable contains the number of customer records to be imported. If its value is greater than the value of MaxRecordCount, the Script task reports failure. When a failure occurs because the MaxRecordCount threshhold has been exceeded, the error path of the workflow can implement any required clean-up code.

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

Remarks

Use the Variables property of the Dts object in Script task code to access variables that are available through the ReadOnlyVariables and ReadWriteVariables properties of the task.

Applies to