VariableDispenser.GetVariables(Variables) Methode

Definition

Sperrt die Variablen, die in der Liste für schreibgeschützten Zugriff und der Liste für Lese-/Schreibzugriff enthalten sind.

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)

Parameter

variables
Variables

Die Auflistung, die alle Variablen in der Liste für schreibgeschützten Zugriff und der Liste für Lese-/Schreibzugriff enthält.

Beispiele

Im folgenden Codebeispiel wird eine VariableDispenser Systemvariable erstellt und der Liste hinzugefügt, die für das Lesen gesperrt ist. Anschließend GetVariables wird aufgerufen, beide Variablen in der Auflistung zu sperren, und die Listen werden freigestellt und für neue Variablen zur Verfügung gestellt.

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  

Beispielausgabe:

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

Hinweise

Rufen Sie diese Methode auf, um alle Variablen zu sperren, die zuvor der Schreibgeschützten Liste oder der Lese-/Schreibliste hinzugefügt wurden.

Wenn der Aufruf erfolgreich ist, werden die Listen freigestellt, und die angeforderten Variablen werden in eine einzelne Auflistung kombiniert, wobei jede Variable für den angegebenen Zugriff gesperrt ist. Um die Variablen zu entsperren, geben Sie die Variablensammlung mithilfe Unlock der Variables Auflistung frei.

Wenn der Aufruf fehlschlägt, bleiben die Listen erhalten, aber die Variablen sind nicht gesperrt.

Hinweis

Es ist wünschenswert, eine Sperre auf der Variable für die minimale Zeitmenge beizubehalten, die erforderlich ist. Dadurch können andere Komponenten und Aufgaben Sperrungen erwerben und die Freigabe der Variablen erleichtern.

Gilt für: