Package.EnableConfigurations 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.

Gets or sets a value that indicates whether the package loads configurations.

public:
 property bool EnableConfigurations { bool get(); void set(bool value); };

[Microsoft.SqlServer.Dts.Runtime.Localization.LocalizablePropertyDescription(typeof(Microsoft.SqlServer.Dts.Runtime.Localized), "EnableConfigurationsDesc")]
public bool EnableConfigurations { get; set; }

[<Microsoft.SqlServer.Dts.Runtime.Localization.LocalizablePropertyDescription(typeof(Microsoft.SqlServer.Dts.Runtime.Localized), "EnableConfigurationsDesc")>]
member this.EnableConfigurations : bool with get, set

Public Property EnableConfigurations As Boolean

Property Value

Boolean

true if the package loads configurations; otherwise, false.

Attributes: LocalizablePropertyDescriptionAttribute

Examples

The following example creates a new package, and then sets the EnableConfigurations to true, as well as the ExportConfigurationFile property. The example then adds a new configuration to the package and sets the value of several properties.

Package pkg = new Package();  
pkg.EnableConfigurations = true;  
pkg.ExportConfigurationFile("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();  

Configuration config = pkg.Configurations.Add();  
config.ConfigurationString = "conf.xml";  
config.ConfigurationType = DTSConfigurationType.ConfigFile;  
config.PackagePath = packagePathToVariable;  
// more code here.

Dim pkg As Package =  New Package()   
pkg.EnableConfigurations = True  
pkg.ExportConfigurationFile("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()   

Dim config As Configuration =  pkg.Configurations.Add()   
config.ConfigurationString = "conf.xml"  
config.ConfigurationType = DTSConfigurationType.ConfigFile  
config.PackagePath = packagePathToVariable  
' more code here.

Remarks

If this property is set to false, the persisted values in the package will be used, rather than overwritten by the loaded configurations.

When deploying the package, you can set this to false with the last configuration. Then, when the package is first run after deployment, the package values will be overwritten once by the configuration values. For more information about configurations used by a package, see Create Package Configurations.

Applies to

Sdílet prostřednictvím