Share via

  • [アーティクル]

Locked プロパティ

Variables コレクション内の変数がロックされているかどうかを示す Boolean です。

名前空間:  Microsoft.SqlServer.Dts.Runtime
アセンブリ:  Microsoft.SqlServer.ManagedDTS (Microsoft.SqlServer.ManagedDTS.dll)

構文

'宣言
Public ReadOnly Property Locked As Boolean
    Get
'使用
Dim instance As Variables
Dim value As Boolean

value = instance.Locked

public bool Locked { get; }

public:
property bool Locked {
    bool get ();
}

member Locked : bool

function get Locked () : boolean

プロパティ値

型: System. . :: . .Boolean
true の場合は、コレクションがロックされていることを示します。値が false の場合は、コレクションのロックが解除されていることを示します。

説明

Variables コレクションには、Locked プロパティが含まれています。このプロパティは、変数ディスペンサで管理されている変数のコレクションがロックされている (true) かロックが解除されている (false) かを示します。このプロパティを確認する理由は、一部のタスクでは使用する変数のロックが明示的に解放され、Unlock を 2 度呼び出すとエラーが発生するためです。したがって、Unlock を呼び出す前に、Locked プロパティを使用して、ディスペンサで管理されているコレクションがロックされているかどうかを確認してください。

使用例

次のコード例では、GetVariables が呼び出されると、変数のコレクションがロックされます。その後、コレクションがロックされているかどうかを確認し、ロックされている場合は Unlock を呼び出します。

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.LockForWrite("System::InteractiveMode");
            variableDispenser.GetVariables(ref vars);           
            // Determine whether the variable collection is locked before unlocking.
            Boolean isLocked = vars.Locked;

            // Verify the value of vars.Locked. If the lock failed,
            // call Reset.
            if (isLocked)
            {
                vars.Unlock();
            }
            else
            {
                variableDispenser.Reset();
            }
        }
    }
}

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.LockForWrite("System::InteractiveMode")
            variableDispenser.GetVariables( vars)
            ' Determine whether the variable collection is locked before unlocking.
            Dim isLocked As Boolean =  vars.Locked 
 
            ' Verify the value of vars.Locked. If the lock failed,
            ' call Reset.
            If isLocked = True Then
                vars.Unlock()
            Else 
                variableDispenser.Reset()
            End If
        End Sub
    End Class
End Namespace