Variable.GetPackagePath Method
Returns the path of the package that the variable belongs to.
Namespace: Microsoft.SqlServer.Dts.Runtime
Assembly: Microsoft.SqlServer.ManagedDTS (in Microsoft.SqlServer.ManagedDTS.dll)
Syntax
'Declaration
Public Function GetPackagePath As String
'Usage
Dim instance As Variable
Dim returnValue As String
returnValue = instance.GetPackagePath()
public string GetPackagePath()
public:
virtual String^ GetPackagePath() sealed
abstract GetPackagePath : unit -> string
override GetPackagePath : unit -> string
public final function GetPackagePath() : String
Return Value
Type: System.String
A String that contains the path of the package.
Implements
IDTSPackagePath.GetPackagePath()
Examples
The following example creates a new package, sets EnableConfigurations to true, and sets the ExportConfigurationFile property. The example then adds a new variable to the Variables collection, sets the value, and retrieves the package path using GetPackagePath. Also, a configuration is added to the configurations collection of the package values of the ConfigurationString, ConfigurationType, and PackagePath.
static void Main(string[] args)
{
// Create a package and set two properties.
Package pkg = new Package();
pkg.EnableConfigurations = true;
pkg.ExportConfigurationFile(@"C:\conf.xml");
// Create a variable object and add it to the
// package Variables collection.
Variable varPkg = pkg.Variables.Add("var", false, "", 100);
varPkg.Value = 1;
string packagePathToVariable = varPkg.GetPackagePath();
// Create a configuration object and add it to the
// package configuration collection
Configuration config = pkg.Configurations.Add();
// Set properties on the configuration object.
config.ConfigurationString = "conf.xml";
config.ConfigurationType = DTSConfigurationType.ConfigFile;
config.PackagePath = packagePathToVariable;
//save the package and its configuration
Application app = new Application();
app.SaveToXml(@"c:\pkg.xml", pkg, null);
//Reload the package
Package p1 = app.LoadPackage(@"c:\pkg.xml", null);
//Review its Variables collection
Console.WriteLine("The value of variable VAR = " + p1.Variables["var"].Value);
}
Shared Sub Main(ByVal args() As String)
' Create a package and set two properties.
Dim pkg As Package = New Package()
pkg.EnableConfigurations = True
pkg.ExportConfigurationFile("C:\conf.xml")
' Create a variable object and add it to the
' package Variables collection.
Dim varPkg As Variable = pkg.Variables.Add("var",False,"",100)
varPkg.Value = 1
Dim packagePathToVariable As String = varPkg.GetPackagePath()
' Create a configuration object and add it to the
' package configuration collection
Dim config As Configuration = pkg.Configurations.Add()
' Set properties on the configuration object.
config.ConfigurationString = "conf.xml"
config.ConfigurationType = DTSConfigurationType.ConfigFile
config.PackagePath = packagePathToVariable
'save the package and its configuration
Dim app As Application = New Application()
app.SaveToXml("c:\pkg.xml", pkg, Nothing)
'Reload the package
Dim p1 As Package = app.LoadPackage("c:\pkg.xml",Nothing)
'Review its Variables collection
Console.WriteLine("The value of variable VAR = " + p1.Variables("var").Value)
End Sub
Sample Output:
The value of variable VAR = 1