VariableDispenser.GetVariables(Variables) 方法
定義
重要
部分資訊涉及發行前產品，在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊，不做任何明確或隱含的瑕疵擔保。
鎖定唯讀清單和讀/寫清單中的變數。
public:
void GetVariables(Microsoft::SqlServer::Dts::Runtime::Variables ^ % variables);public void GetVariables (ref Microsoft.SqlServer.Dts.Runtime.Variables variables);member this.GetVariables : Variables -> unitPublic 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 。
如果呼叫失敗，則會保留清單，但不會鎖定變數。
注意
建議您針對所需的最小時間長度，維護變數的鎖定。 這可讓其他元件和工作取得鎖定，並促進變數的共用。