VariableDispenser.GetVariables(Variables) VariableDispenser.GetVariables(Variables) VariableDispenser.GetVariables(Variables) VariableDispenser.GetVariables(Variables) Method


Locks the variables that are in the read-only list and the read/write list.

 void GetVariables(Microsoft::SqlServer::Dts::Runtime::Variables ^ % variables);
public void GetVariables (ref Microsoft.SqlServer.Dts.Runtime.Variables variables);
member this.GetVariables :  -> unit
Public Sub GetVariables (ByRef variables As Variables)


Variables Variables Variables Variables

The collection that contains all the variables found in the read-only list and the read/write list.


The following code example creates a VariableDispenser and adds two system variables to the list that is locked for reading. Then the GetVariables is called to lock both variables in the collection, and the lists are freed and made available for new variables.

using System;  
using System.Collections.Generic;  
using System.Text;  
using Microsoft.SqlServer.Dts.Runtime;  
namespace Microsoft.SqlServer.SSIS.Sample  
    class Program  
        static void Main(string[] args)  
            Package pkg = new Package();  
            Variables vars = null;  
            VariableDispenser variableDispenser = pkg.VariableDispenser;  
            variableDispenser.GetVariables(ref vars);             
            // Verify that the variable is locked before unlocking.  
            Console.WriteLine("Variables are locked? {0}", vars.Locked);  
            foreach (Variable myVar in vars)  
                Console.WriteLine("Name        {0}", myVar.Name);  
                Console.WriteLine("Description {0}", myVar.Description);  
            // Use Contains to determine whether indexing can be used.  
            Boolean pkgName = variableDispenser.Contains("PackageName");  
            String qName = variableDispenser.GetQualifiedName("PackageName");  
            Console.WriteLine("Contains is valid?       {0}", pkgName);  
            Console.WriteLine("Fully qualified name is: {0}", qName);  
            Console.WriteLine("Variables are locked? {0}", vars.Locked);  
Imports System  
Imports System.Collections.Generic  
Imports System.Text  
Imports Microsoft.SqlServer.Dts.Runtime  
Namespace Microsoft.SqlServer.SSIS.Sample  
    Class Program  
        Shared  Sub Main(ByVal args() As String)  
            Dim pkg As Package =  New Package()   
            Dim vars As Variables =  Nothing   
            Dim variableDispenser As VariableDispenser =  pkg.VariableDispenser   
            variableDispenser.GetVariables( vars)  
            ' Verify that the variable is locked before unlocking.  
            Console.WriteLine("Variables are locked? {0}", vars.Locked)  
            Dim myVar As Variable  
            For Each myVar In vars  
                Console.WriteLine("Name        {0}", myVar.Name)  
                Console.WriteLine("Description {0}", myVar.Description)  
            ' Use Contains to determine whether indexing can be used.  
            Dim pkgName As Boolean =  variableDispenser.Contains("PackageName")   
            Dim qName As String =  variableDispenser.GetQualifiedName("PackageName")   
            Console.WriteLine("Contains is valid?       {0}", pkgName)  
            Console.WriteLine("Fully qualified name is: {0}", qName)  
            Console.WriteLine("Variables are locked? {0}", vars.Locked)  
        End Sub  
    End Class  
End Namespace  

Sample Output:

Variables are locked? True

Name OfflineMode

Description The offline mode currently set for the package

Name PackageName

Description The package name

Contains is valid? True

Fully qualified name is: System::PackageName

Variables are locked? False


Call this method to lock all the variables previously added to the read-only list or the read/write list.

If the call succeeds, the lists are freed and the requested variables are combined into a single collection, with each variable locked for the access specified. To unlock the variables, release the variable collection using Unlock on the Variables collection.

If the call fails, the lists remain, but the variables are not locked.


It is desirable to maintain a lock on the variable for the minimum amount of time required. This allows other components and tasks to acquire locks and facilitates sharing of the variables.

Applies to