VariableDispenser.GetVariables(Variables) Método
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Bloqueia as variáveis que estão na lista somente leitura e de leitura e gravação.
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)
Parâmetros
- variables
- Variables
A coleção que contém todas as variáveis encontradas na lista somente leitura e de leitura e gravação.
Exemplos
O exemplo de código a seguir cria um VariableDispenser e adiciona duas variáveis de sistema à lista que está bloqueada para leitura. Em seguida, é GetVariables chamado para bloquear ambas as variáveis na coleção e as listas são liberadas e disponibilizadas para novas variáveis.
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
Saída de exemplo:
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
Comentários
Chame esse método para bloquear todas as variáveis adicionadas anteriormente à lista somente leitura ou à lista de leitura/gravação.
Se a chamada for bem-sucedida, as listas serão liberadas e as variáveis solicitadas serão combinadas em uma única coleção, com cada variável bloqueada para o acesso especificado. Para desbloquear as variáveis, libere a coleção de variáveis usando Unlock na Variables coleção.
Se a chamada falhar, as listas permanecerão, mas as variáveis não serão bloqueadas.
Observação
É desejável manter um bloqueio na variável pelo tempo mínimo necessário. Isso permite que outros componentes e tarefas adquiram bloqueios e facilita o compartilhamento das variáveis.