VariableDispenser.GetVariables(Variables) Метод

Определение

Пространство имен:

Microsoft.SqlServer.Dts.Runtime

Сборка:

Microsoft.SqlServer.ManagedDTS.dll

Блокирует переменные, которые находятся в списке только для чтения и списка чтения/записи.

public:
 void GetVariables(Microsoft::SqlServer::Dts::Runtime::Variables ^ % variables);

public void GetVariables(ref Microsoft.SqlServer.Dts.Runtime.Variables variables);

member this.GetVariables : Variables -> unit

Public Sub GetVariables (ByRef variables As Variables)

Параметры

variables

Variables

Коллекция, содержащая все переменные, найденные в списке только для чтения и списке чтения/записи.

Примеры

Следующий пример кода создаёт VariableDispenser и добавляет две системные переменные в список, заблокированный для чтения. Затем GetVariables вызывается блокировка обеих переменных в коллекции, и списки освобождаются и становятся доступными для новых переменных.

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.LockForRead("System::PackageName");  
            variableDispenser.LockForRead("System::OfflineMode");  
            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);  
                Console.WriteLine();  
            }  
            // 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);  

            vars.Unlock();  

            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.LockForRead("System::PackageName")  
            variableDispenser.LockForRead("System::OfflineMode")  
            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)  
                Console.WriteLine()  
            Next  
            ' 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)  

            vars.Unlock()  

            Console.WriteLine("Variables are locked? {0}", vars.Locked)  
        End Sub  
    End Class  
End Namespace  

Пример вывода:

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

Комментарии

Вызовите этот метод, чтобы заблокировать все ранее добавленные переменные в список только для чтения или список чтения/записи.

Если вызов выполнен успешно, списки освобождаются, а запрошенные переменные объединяются в единую коллекцию, при этом каждая переменная заблокирована для указанного доступа. Чтобы разблокировать переменные, освободите коллекцию переменных, используя Unlock на Variables коллекции.

Если вызов не выполняется, списки остаются, но переменные не заблокированы.

Note

Желательно поддерживать фиксацию переменной в течение минимального необходимого времени. Это позволяет другим компонентам и задачам получать блокировки и способствует совместному использованию переменных.