Description プロパティ

構成の説明を取得します。値の設定も可能です。このプロパティは読み取り専用です。

名前空間:  Microsoft.SqlServer.Dts.Runtime
アセンブリ:  Microsoft.SqlServer.ManagedDTS (Microsoft.SqlServer.ManagedDTS.dll)

構文

'宣言
Public Property Description As String
    Get
    Set
'使用
Dim instance As Configuration
Dim value As String

value = instance.Description

instance.Description = value
public string Description { get; set; }
public:
virtual property String^ Description {
    String^ get () sealed;
    void set (String^ value) sealed;
}
abstract Description : string with get, set
override Description : string with get, set
final function get Description () : String
final function set Description (value : String)

プロパティ値

型: System. . :: . .String
構成に指定された説明を表す String です。

実装

IDTSName. . :: . .Description

説明

構成名は、パッケージ構成ウィザードを使用して割り当てることもできます。詳細については、「パッケージの構成の作成」を参照してください。

使用例

次のコード例では、パッケージを作成して構成を有効にし、構成ファイルのエクスポートを有効にします。また、パッケージの Configurations コレクションに新しい Configuration を追加し、いくつかのプロパティを設定します。パッケージの保存と再読み込みを実行すると、構成のプロパティが表示されます。

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    
        Shared  Sub Main(ByVal args() As String)
        ' 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 Sub
    End Class
End Namespace

サンプルの出力 :

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]