Export (0) Print
Expand All

Configuration Class

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

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)

public sealed class Configuration : DtsObject, 
	IDTSPersist, IDTSName

The Configuration type exposes the following members.

  NameDescription
Public propertyConfigurationStringGets or sets the location of the configuration.
Public propertyConfigurationTypeGets or sets a value from the DTSConfigurationType that describes what kind of file the configuration information is stored in.
Public propertyCreationNameReturns 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.
Public propertyDescriptionGets or sets the description of the configuration. This property is read-only.
Public propertyIDReturns the ID assigned to the configuration. This property is read-only.
Public propertyNameGests or sets the name given to this configuration.
Public propertyPackagePathGets or sets the path of the package that the configuration applies to.
Top

  NameDescription
Public methodEqualsDetermines whether two object instances are equal. (Inherited from DtsObject.)
Public methodGetHashCodeReturns the hash code for this instance. (Inherited from DtsObject.)
Public methodGetType (Inherited from Object.)
Public methodLoadFromXMLThis method is not callable by your application code. To load a package saved as .xml, use the Application.LoadPackage method.
Public methodSaveToXMLThis method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method.
Public methodToString (Inherited from Object.)
Top

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.

Community Additions

ADD
Show:
© 2014 Microsoft