Configuration.ID 属性
定义
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
返回分配给配置的 ID。 此属性为只读。
public:
property System::String ^ ID { System::String ^ get(); };
public string ID { get; }
member this.ID : string
Public ReadOnly Property ID As String
属性值
包含分配给此配置的唯一 ID 的字符串。
实现
示例
下面的代码示例创建一个包,启用配置,并启用配置文件的导出。 它会向包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
示例输出:
变量 var = 1 的值
ConfigurationString conf.xml
ConfigurationType 为 ConfigFile
CreationName 为
说明是“我的配置说明”
分配的 ID 为 {9CF65E37-0833-44CD-A99D-EBFE38FAB31B}
名称为 {9CF65E37-0833-44CD-A99D-EBFE38FAB31B}
包路径为 \Package.Variables[::var]
注解
创建配置时会分配 ID。 有关详细信息,请参阅 创建包配置。