ForEachVariableMapping.VariableName Property
Gets or sets a String that contains the name of the variable
Namespace: Microsoft.SqlServer.Dts.Runtime
Assembly: Microsoft.SqlServer.ManagedDTS (in Microsoft.SqlServer.ManagedDTS.dll)
Syntax
'Declaration
Public Property VariableName As String
Get
Set
'Usage
Dim instance As ForEachVariableMapping
Dim value As String
value = instance.VariableName
instance.VariableName = value
public string VariableName { get; set; }
public:
property String^ VariableName {
String^ get ();
void set (String^ value);
}
member VariableName : string with get, set
function get VariableName () : String
function set VariableName (value : String)
Property Value
Type: System.String
A String that contains the variable name.
Examples
The following code example creates a ForEachVariableMapping, sets the read-write properties, views the read-only properties, and sets up a mapping using the VariableName and ValueIndex properties.
using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.SqlServer.Dts.Runtime;
using Microsoft.SqlServer.Dts.Runtime.Enumerators;
using Microsoft.SqlServer.Dts.Runtime.Enumerators.Item;
namespace Microsoft.SqlServer.SSIS.Samples
{
class Program
{
public static void Main()
{
// Create the new application and package.
Application app = new Application();
Package package = new Package();
// Create ForEachLoop task
Executables executables = package.Executables;
ForEachLoop forEachLoop = executables.Add("STOCK:FOREACHLOOP") as ForEachLoop;
// Create a VariableMappings and VariableMapping objects.
ForEachVariableMappings forEachVariableMappings = forEachLoop.VariableMappings;
ForEachVariableMapping forEachVariableMapping = forEachVariableMappings.Add();
// Set the properties.
forEachVariableMapping.Description = "My ForEach Variable Mapping";
forEachVariableMapping.Name = "My Name is ForEachVariableMapping";
// View the read-only properties. CreationName can be blank.
Console.WriteLine("ID: {0}", forEachVariableMapping.ID);
Console.WriteLine("CreationName: {0}", forEachVariableMapping.CreationName);
// Create a mapping between the variable and its value.
forEachVariableMapping.VariableName = @"Id";
forEachVariableMapping.ValueIndex = 0;
// Add other tasks to ForEachLoop container.
//...
// Run the package when the rest of the code is finished.
DTSExecResult status = package.Execute();
}
}
}
Imports System
Imports System.Collections.Generic
Imports System.Text
Imports Microsoft.SqlServer.Dts.Runtime
Imports Microsoft.SqlServer.Dts.Runtime.Enumerators
Imports Microsoft.SqlServer.Dts.Runtime.Enumerators.Item
Namespace Microsoft.SqlServer.SSIS.Samples
Class Program
Public Shared Sub Main()
' Create the new application and package.
Dim app As New Application()
Dim package As New Package()
' Create ForEachLoop task
Dim executables As Executables = package.Executables
Dim forEachLoop As ForEachLoop = CType(executables.Add("STOCK:FOREACHLOOP"), ForEachLoop)
' Create a VariableMappings and VariableMapping objects.
Dim forEachVariableMappings As ForEachVariableMappings = forEachLoop.VariableMappings
Dim forEachVariableMapping As ForEachVariableMapping = forEachVariableMappings.Add()
' Set the properties.
forEachVariableMapping.Description = "My ForEach Variable Mapping"
forEachVariableMapping.Name = "My Name is ForEachVariableMapping"
' View the read-only properties. CreationName can be blank.
Console.WriteLine("ID: {0}", forEachVariableMapping.ID)
Console.WriteLine("CreationName: {0}", forEachVariableMapping.CreationName)
' Create a mapping between the variable and its value.
forEachVariableMapping.VariableName = "Id"
forEachVariableMapping.ValueIndex = 0
Console.WriteLine()
' Add other tasks to ForEachLoop container.
'...
' Run the package when the rest of the code is finished.
Dim status As DTSExecResult = package.Execute()
End Sub 'Main
End Class 'Program
End Namespace 'Microsoft.SqlServer.SSIS.Samples
Sample Output:
ID: {DDCF34B7-853F-4013-B924-93D1A00DEC3F}
CreationName: