Configuration Class

Article
04/26/2013

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

Inheritance Hierarchy

System.Object
Microsoft.SqlServer.Dts.Runtime.DtsObject
Microsoft.SqlServer.Dts.Runtime.Configuration

Namespace: Microsoft.SqlServer.Dts.Runtime
Assembly: Microsoft.SqlServer.ManagedDTS (in Microsoft.SqlServer.ManagedDTS.dll)

Syntax

'Declaration
Public NotInheritable Class Configuration _
    Inherits DtsObject _
    Implements IDTSPersist, IDTSName
'Usage
Dim instance As Configuration

public sealed class Configuration : DtsObject, 
    IDTSPersist, IDTSName

public ref class Configuration sealed : public DtsObject, 
    IDTSPersist, IDTSName

[<SealedAttribute>]
type Configuration =  
    class 
        inherit DtsObject 
        interface IDTSPersist 
        interface IDTSName 
    end

public final class Configuration extends DtsObject implements IDTSPersist, IDTSName

The Configuration type exposes the following members.

Properties

	Name	Description
	ConfigurationString	Gets or sets the location of the configuration.
	ConfigurationType	Gets or sets a value from the DTSConfigurationType that describes what kind of file the configuration information is stored in.
	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	Gets or sets the description of the configuration. This property is read-only.
	ID	Returns the ID assigned to the configuration. This property is read-only.
	Name	Gests or sets the name given to this configuration.
	PackagePath	Gets or sets the path of the package that the configuration applies to.

Top

Methods

	Name	Description
	Equals	Determines whether two object instances are equal. (Inherited from DtsObject.)
	GetHashCode	Returns the hash code for this instance. (Inherited from DtsObject.)
	GetType	(Inherited from Object.)
	LoadFromXML	This method is not callable by your application code. To load a package saved as .xml, use the Application.LoadPackage method.
	SaveToXML	This method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method.
	ToString	(Inherited from Object.)

Top

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.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Share via