Propriété ConfigurationString

Gets or sets the location of the configuration.

Espace de noms :  Microsoft.SqlServer.Dts.Runtime
Assembly :  Microsoft.SqlServer.ManagedDTS (en Microsoft.SqlServer.ManagedDTS.dll)

Syntaxe

'Déclaration
Public Property ConfigurationString As String
    Get
    Set
'Utilisation
Dim instance As Configuration
Dim value As String

value = instance.ConfigurationString

instance.ConfigurationString = value

public string ConfigurationString { get; set; }

public:
property String^ ConfigurationString {
    String^ get ();
    void set (String^ value);
}

member ConfigurationString : string with get, set

function get ConfigurationString () : String
function set ConfigurationString (value : String)

Valeur de propriété

Type : System. . :: . .String
A String that contains the location of the configuration. The location can be a path, an environment variable, a parent package variable name, or a registry key.

Exemples

The following code example creates a package, enables configurations, and enables the export of the configuration file. It adds a new Configuration to the package Configurations collection, and sets several properties on the configuration. After saving and reloading the package, the configuration properties are displayed.

using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.SqlServer.Dts.Runtime;
using Microsoft.SqlServer.Dts.Tasks.BulkInsertTask;

namespace configuration_API
{
    class Program
    {    
        static void Main(string[] args)
        {
        // Create a package and set two properties.
            Package pkg = new Package();
            pkg.EnableConfigurations = true;
            pkg.ExportConfigurationFile(@"C:\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();

            // Create a configuration object and add it to the 
           // package configuration collection.
            Configuration config = pkg.Configurations.Add();

           // Set properties on the configuration object.
            config.ConfigurationString = "conf.xml";
            config.Description = "My configuration description";
            config.ConfigurationType = DTSConfigurationType.ConfigFile;
            config.PackagePath = packagePathToVariable;

            // Save the package and its configuration.
            Application app = new Application();
            app.SaveToXml(@"c:\pkg.xml", pkg, null);
            
            // Reload the package.
            Package p1 = app.LoadPackage(@"c:\pkg.xml", null);
            // Review the configuration information.
            Configurations configs_After = pkg.Configurations;
            foreach(Configuration confAfter in configs_After)
            {
                Console.WriteLine("ConfigurationString is {0}", confAfter.ConfigurationString);
                Console.WriteLine("ConfigurationType is {0}", confAfter.ConfigurationType);
                Console.WriteLine("CreationName is {0}", confAfter.CreationName);
                Console.WriteLine("Description is {0}", confAfter.Description);
                Console.WriteLine("Assigned ID is {0}", confAfter.ID);
                Console.WriteLine("Name is {0}", confAfter.Name);
            }
        }
    }
}

Imports System
Imports System.Collections.Generic
Imports System.Text
Imports Microsoft.SqlServer.Dts.Runtime
Imports Microsoft.SqlServer.Dts.Tasks.BulkInsertTask
 
Namespace configuration_API
    Class Program
        ' Create a package and set two properties.
            Dim pkg As Package =  New Package() 
            pkg.EnableConfigurations = True
            pkg.ExportConfigurationFile("C:\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() 
 
            ' Create a configuration object and add it to the 
           ' package configuration collection.
            Dim config As Configuration = pkg.Configurations.Add() 
 
           ' Set properties on the configuration object.
            config.ConfigurationString = "conf.xml"
            config.Description = "My configuration description"
            config.ConfigurationType = DTSConfigurationType.ConfigFile
            config.PackagePath = packagePathToVariable
 
            ' Save the package and its configuration.
            Dim app As Application = New Application() 
            app.SaveToXml("c:\pkg.xml", pkg, Nothing)
 
            ' Reload the package.
            Dim p1 As Package =  app.LoadPackage("c:\pkg.xml",Nothing) 
            ' Review the configuration information.
            Dim configs_After As Configurations = pkg.Configurations 
            Dim confAfter As Configuration
            For Each confAfter In configs_After
                Console.WriteLine("ConfigurationString is {0}", confAfter.ConfigurationString)
                Console.WriteLine("ConfigurationType is {0}", confAfter.ConfigurationType)
                Console.WriteLine("CreationName is {0}", confAfter.CreationName)
                Console.WriteLine("Description is {0}", confAfter.Description)
                Console.WriteLine("Assigned ID is {0}", confAfter.ID)
                Console.WriteLine("Name is {0}", confAfter.Name)
            Next
    End Class
End Namespace

Sample Output:

The value of variable var = 1

ConfigurationString is conf.xml

ConfigurationType is ConfigFile

CreationName is

Description is My configuration description

Assigned ID is {9CF65E37-0833-44CD-A99D-EBFE38FAB31B}

Name is {9CF65E37-0833-44CD-A99D-EBFE38FAB31B}

Package Path is \Package.Variables[::var]

Voir aussi

Référence

Configuration Classe

Espace de noms Microsoft.SqlServer.Dts.Runtime