VariableDispenser.GetVariables(Variables) Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Блокирует переменные в доступном только для чтения списке, а также списке, доступном для чтения и записи.
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
Комментарии
Вызовите этот метод, чтобы заблокировать все переменные, ранее добавленные в список только для чтения или списка чтения и записи.
При успешном вызове списки освобождаются, а запрошенные переменные объединяются в одну коллекцию, при этом каждая переменная заблокирована для указанного доступа. Чтобы разблокировать переменные, отпустите коллекцию переменных с помощью UnlockVariables коллекции.
Если вызов завершается сбоем, списки остаются, но переменные не блокируются.
Примечание
Желательно сохранить блокировку переменной в течение минимального периода времени. Это позволяет другим компонентам и задачам получать блокировки и упрощать совместное использование переменных.