PipelineComponent.VariableDispenser Property

Definition

Namespace:

Microsoft.SqlServer.Dts.Pipeline

Assembly:

Microsoft.SqlServer.PipelineHost.dll

Important

This API is not CLS-compliant.

Gets the IDTSVariableDispenser100 of the data flow component.

public:
 property Microsoft::SqlServer::Dts::Runtime::Wrapper::IDTSVariableDispenser100 ^ VariableDispenser { Microsoft::SqlServer::Dts::Runtime::Wrapper::IDTSVariableDispenser100 ^ get(); };

[System.CLSCompliant(false)]
public Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSVariableDispenser100 VariableDispenser { get; }

[<System.CLSCompliant(false)>]
member this.VariableDispenser : Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSVariableDispenser100

Public ReadOnly Property VariableDispenser As IDTSVariableDispenser100

Property Value

IDTSVariableDispenser100

The IDTSVariableDispenser100 object provided to the component.

Attributes

CLSCompliantAttribute

Examples

The following example demonstrates how to use the VariableDispenser to lock a single variable, and multiple variables.

// Lock two variables, and then retrieve them by calling GetVariables.  
IDTSVariables100 variables = null;  

VariableDispenser.LockForRead("variable1");  
VariableDispenser.LockForRead("variable2");  
VariableDispenser.GetVariables(ref variables);  

object variable1 = variables[0].Value;  
object variable2 = variables[1].Value;  

// Retrieve a single variable.  
IDTSVariables100 variables = null;  
VariableDispenser.LockOneForRead("variable1", ref variables);  

object variable1 = variables[0].Value;  

' Lock two variables, and then retrieve them by calling GetVariables.  
Dim variables As IDTSVariables100 = Nothing   
VariableDispenser.LockForRead("variable1")   
VariableDispenser.LockForRead("variable2")   
VariableDispenser.GetVariables(variables)   
Dim variable1 As Object = variables(0).Value   
Dim variable2 As Object = variables(1).Value   
Dim variables As IDTSVariables100 = Nothing   
VariableDispenser.LockOneForRead("variable1", variables)   
Dim variable1 As Object = variables(0).Value  

Remarks

The VariableDispenser is used to read and write variables in the package that contains the component. Before reading or writing a variable, it must be locked using one of the following methods; LockForRead, LockForWrite, LockOneForRead, or LockOneForWrite. After the variables are locked using the dispenser, they are available through the IDTSVariables100 interface.