Configuration Configuration Configuration Class

Definition

Represents a configuration class that contains information about how a package is configured. This class cannot be inherited.

public ref class Configuration sealed : Microsoft::SqlServer::Dts::Runtime::DtsObject, Microsoft::SqlServer::Dts::Runtime::IDTSName, Microsoft::SqlServer::Dts::Runtime::IDTSPersist
public sealed class Configuration : Microsoft.SqlServer.Dts.Runtime.DtsObject, Microsoft.SqlServer.Dts.Runtime.IDTSName, Microsoft.SqlServer.Dts.Runtime.IDTSPersist
Public NotInheritable Class Configuration
Inherits DtsObject
Implements IDTSName, IDTSPersist
Inheritance
ConfigurationConfigurationConfiguration
Implements

Remarks

Configurations are useful when deploying packages to many different servers, and make it easy to move packages from development to production environments.

You can use variables to update packages dynamically, which enables you to customize package functionality and adapt packages to the environments in which they run. To update package properties at run time by using variables, map variables to package object properties, create configurations for the variables, deploy the configurations with the package, and then update the variable values in the configuration file to suit the new environment. At run time, the package automatically uses the updated values. This flexibility is useful when the packages that you have deployed connect to different servers, run different SQL statements, or run different child packages. For more information, see Create Package Configurations and Use Variables in Packages.

Properties

ConfigurationString ConfigurationString ConfigurationString

Gets or sets the location of the configuration.

ConfigurationType ConfigurationType ConfigurationType

Gets or sets a value from the DTSConfigurationType that describes what kind of file the configuration information is stored in.

CreationName CreationName CreationName

Returns the string that is used by the run-time engine to create an instance of the Configuration object and to add the object to the Configurations collection. This property is read-only.

Description Description Description

Gets or sets the description of the configuration. This property is read-only.

ID ID ID

Returns the ID assigned to the configuration. This property is read-only.

Name Name Name

Gests or sets the name given to this configuration.

PackagePath PackagePath PackagePath

Gets or sets the path of the package that the configuration applies to.

Methods

Equals(Object) Equals(Object) Equals(Object)

Determines whether two object instances are equal.

(Inherited from DtsObject)
GetHashCode() GetHashCode() GetHashCode()

Returns the hash code for this instance.

(Inherited from DtsObject)
LoadFromXML(XmlNode, IDTSEvents) LoadFromXML(XmlNode, IDTSEvents) LoadFromXML(XmlNode, IDTSEvents)

This method is not callable by your application code. To load a package saved as .xml, use the LoadPackage(String, IDTSEvents) method.

SaveToXML(XmlDocument, XmlNode, IDTSEvents) SaveToXML(XmlDocument, XmlNode, IDTSEvents) SaveToXML(XmlDocument, XmlNode, IDTSEvents)

This method is not callable by your application code. To save a package as .xml, use the SaveToXml(String, Package, IDTSEvents) method.

Applies to