ForEachLoop.Properties Property

Reference

Definition

Namespace:: Microsoft.SqlServer.Dts.Runtime

Assembly:: Microsoft.SqlServer.ManagedDTS.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Returns a collection of DtsProperty objects associated with the ForEachLoop.

public:
 property Microsoft::SqlServer::Dts::Runtime::DtsProperties ^ Properties { Microsoft::SqlServer::Dts::Runtime::DtsProperties ^ get(); };

public Microsoft.SqlServer.Dts.Runtime.DtsProperties Properties { get; }

member this.Properties : Microsoft.SqlServer.Dts.Runtime.DtsProperties

Public ReadOnly Property Properties As DtsProperties

Property Value

DtsProperties

A DtsProperties collection.

Implements

Properties

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

Applies to

Share via