ForEachLoop.VariableMappings Property
Returns a ForEachVariableMappings collection that contains the variable mappings for the ForEachLoop.
Namespace: Microsoft.SqlServer.Dts.Runtime
Assembly: Microsoft.SqlServer.ManagedDTS (in Microsoft.SqlServer.ManagedDTS.dll)
Syntax
'Declaration
Public ReadOnly Property VariableMappings As ForEachVariableMappings
Get
'Usage
Dim instance As ForEachLoop
Dim value As ForEachVariableMappings
value = instance.VariableMappings
public ForEachVariableMappings VariableMappings { get; }
public:
property ForEachVariableMappings^ VariableMappings {
ForEachVariableMappings^ get ();
}
member VariableMappings : ForEachVariableMappings
function get VariableMappings () : ForEachVariableMappings
Property Value
Type: Microsoft.SqlServer.Dts.Runtime.ForEachVariableMappings
A ForEachVariableMappings collection.
Examples
The following code example creates a ForEachLoop, sets some properties using the Properties collection, creates a VariableMappings object, and adds a VariableMappings where a variable is mapped to a value.
// Create the new package.
Package package = new Package();
// Add variables.
package.Variables.Add("Id", false, "", 0);
// Create ForEachLoop task
Executables executables = package.Executables;
ForEachLoop forEachLoop = executables.Add("STOCK:FOREACHLOOP") as ForEachLoop;
// Set name and description properties on the ForEachLoop.
// Show how to set them using the Properties collection.
forEachLoop.Properties["Name"].SetValue(forEachLoop, "ForEachLoop Container");
forEachLoop.Properties["Description"].SetValue(forEachLoop, "ForEachLoop Container");
// Create a VariableMappings and VariableMapping objects.
ForEachVariableMappings forEachVariableMappings = forEachLoop.VariableMappings;
ForEachVariableMapping forEachVariableMapping = forEachVariableMappings.Add();
// Create a mapping between the variable and its value.
forEachVariableMapping.VariableName = "Id";
forEachVariableMapping.ValueIndex = 0;
' Create the new package.
Dim package As Package = New Package()
' Add variables.
package.Variables.Add("Id", False, "", 0)
' Create ForEachLoop task
Dim executables As Executables = package.Executables
Dim forEachLoop As ForEachLoop = executables.Add("STOCK:FOREACHLOOP") as ForEachLoop
' Set name and description properties on the ForEachLoop.
' Show how to set them using the Properties collection.
forEachLoop.Properties("Name").SetValue(forEachLoop, "ForEachLoop Container")
forEachLoop.Properties("Description").SetValue(forEachLoop, "ForEachLoop Container")
Create a VariableMappings and VariableMapping objects.
Dim forEachVariableMappings As ForEachVariableMappings = forEachLoop.VariableMappings
Dim forEachVariableMapping As ForEachVariableMapping = forEachVariableMappings.Add()
' Create a mapping between the variable and its value.
forEachVariableMapping.VariableName = "Id"
forEachVariableMapping.ValueIndex = 0