Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
MSDN Library

Configuration Class

 

Applies To: SQL Server 2016 Preview

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

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

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

public sealed class Configuration : DtsObject, IDTSPersist, IDTSName

NameDescription
System_CAPS_pubpropertyConfigurationString

Gets or sets the location of the configuration.

System_CAPS_pubpropertyConfigurationType

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

System_CAPS_pubpropertyCreationName

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.

System_CAPS_pubpropertyDescription

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

System_CAPS_pubpropertyID

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

System_CAPS_pubpropertyName

Gests or sets the name given to this configuration.

System_CAPS_pubpropertyPackagePath

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

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether two object instances are equal.(Inherited from DtsObject.)

System_CAPS_pubmethodGetHashCode()

Returns the hash code for this instance.(Inherited from DtsObject.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodLoadFromXML(XmlNode, IDTSEvents)

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

System_CAPS_pubmethodSaveToXML(XmlDocument, XmlNode, IDTSEvents)

This method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method.

System_CAPS_pubmethodToString()

(Inherited from Object.)

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.

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

Return to top

Community Additions

Show:
© 2015 Microsoft