VariableDispenser.LockOneForRead Method (Microsoft.SqlServer.Dts.Runtime)

Collapse All

Other versions are also available for the following:

SQL Server 2005

VariableDispenser..::.LockOneForRead Method

Puts the variable in a list, and then locks it for read-only access.

Namespace: Microsoft.SqlServer.Dts.Runtime
Assembly: Microsoft.SqlServer.ManagedDTS (in Microsoft.SqlServer.ManagedDTS.dll)

Syntax

Visual Basic (Declaration)

Public Sub LockOneForRead ( _
    variable As String, _
    ByRef variables As Variables _
)

Visual Basic (Usage)

Dim instance As VariableDispenser
Dim variable As String
Dim variables As Variables

instance.LockOneForRead(variable, variables)

public void LockOneForRead(
    string variable,
    ref Variables variables
)

Visual C++

public:
void LockOneForRead(
    String^ variable, 
    Variables^% variables
)

member LockOneForRead : 
        variable:string * 
        variables:Variables byref -> unit

JScript

public function LockOneForRead(
    variable : String, 
    variables : Variables
)

Parameters

variable: Type: System..::.String
The variable you want to lock for read-only access.

variables: Type: Microsoft.SqlServer.Dts.Runtime..::.Variables%
The name of the variables collection to put the requested variable into.

Remarks

This method combines the work of the LockForRead method and the GetVariables method in one call, because it applies to a single variable only.

If the call succeeds, the requested variable is returned as a one-entry collection in the variable collection specified by the parameter variables, and the variable is locked for read-only access. To unlock the variable, release the variable collection by using the Unlock method of the Variables class. If the call to the LockOneForRead method fails, the variable is not locked.

Calls to this method do not affect the lock list generated via calls to LockForRead.

Note
It is recommended that you do not make multiple calls to this method when acquiring locks for variables to be used together because this could lead to deadlocks. All variables being used together should be requested and locked together by using the methods LockForRead or LockForWrite, followed by a call to GetVariables.

If a lock was successful, you can clear it by calling Unlock.

Reference

VariableDispenser Class

Microsoft.SqlServer.Dts.Runtime Namespace