ForEachLoop.GetPackagePath ForEachLoop.GetPackagePath ForEachLoop.GetPackagePath Method

Definition

Returns a String that contains the relative path to the package location.

public:
 virtual System::String ^ GetPackagePath();
public string GetPackagePath ();
Public Function GetPackagePath () As String

Returns

A String that contains the path to the package.

Implements

Examples

The following code example creates a ForEachLoop, sets some properties using the Properties collection ,and retrieves the package path.

// Create the new package.  
Package package = new Package();  
// Add variables.  
package.Variables.Add("Id", false, "User", 0);  
// Create ForEachLoop task  
Executables executables = package.Executables;  
ForEachLoop forEachLoop = executables.Add("STOCK:FOREACHLOOP") as ForEachLoop;  
// Set properties on the ForEachLoop, like name and description.  
// Show how to set them using the Properties collection.  
forEachLoop.Properties["Name"].SetValue(forEachLoop, "ForEachLoop Container");  
forEachLoop.Properties["Description"].SetValue(forEachLoop, "ForEachLoop Container");  
  
// Retrieve the package path of the loop.  
String path = forEachLoop.GetPackagePath();  
Console.WriteLine("Package path: {0}", path);  
' Create the new package.  
Dim package As Package =  New Package()   
' Add variables.  
package.Variables.Add("Id", False, "User", 0)  
' Create ForEachLoop task  
Dim executables As Executables =  package.Executables   
Dim forEachLoop As ForEachLoop =  executables.Add("STOCK:FOREACHLOOP") as ForEachLoop   
' Set properties on the ForEachLoop, like name and description.  
' Show how to set them using the Properties collection.  
forEachLoop.Properties("Name").SetValue(forEachLoop, "ForEachLoop Container")  
forEachLoop.Properties("Description").SetValue(forEachLoop, "ForEachLoop Container")  
  
' Retrieve the package path of the loop.  
Dim path As String =  forEachLoop.GetPackagePath()   
Console.WriteLine("Package path: {0}", path)  

Sample Output:

Package path: \Package\ForEachLoop Container

Applies to