GetVariables メソッド

構文

'宣言
Public Sub GetVariables ( _
    ByRef variables As Variables _
)
'使用
Dim instance As VariableDispenser
Dim variables As Variables

instance.GetVariables(variables)

public void GetVariables(
    ref Variables variables
)

public:
void GetVariables(
    Variables^% variables
)

member GetVariables : 
        variables:Variables byref -> unit 

public function GetVariables(
    variables : Variables
)

説明

このメソッドを呼び出して、読み取り専用ロック一覧または読み取り/書き込みロック一覧に以前追加されたすべての変数をロックします。

呼び出しが成功した場合は、一覧が解放され、要求された変数は、組み合わされて単一のコレクションになります。各変数は指定されたアクセス用にロックされた状態となります。変数のロックを解除するには、Variables コレクションに Unlock を使用して、変数コレクションを解放します。

呼び出しが失敗した場合は、一覧の状態は変更されず、変数はロックされません。

注
変数のロックを維持する時間の長さは、必要最低限にすることをお勧めします。これによって、他のコンポーネントおよびタスクがロックを取得できるようになり、変数の共有が容易になります。

使用例

次のコード例では、VariableDispenser を作成し、読み取り用にロックされる一覧に 2 つのシステム変数を追加します。次に、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

関連項目

参照