Variable 类
定义
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
表示包、任务或容器上的变量。 此类不能被继承。
public ref class Variable sealed : Microsoft::SqlServer::Dts::Runtime::DtsObject, IDisposable, Microsoft::SqlServer::Dts::Runtime::IDTSExecutionPath, Microsoft::SqlServer::Dts::Runtime::IDTSName, Microsoft::SqlServer::Dts::Runtime::IDTSPackagePath, Microsoft::SqlServer::Dts::Runtime::IDTSPersist, Microsoft::SqlServer::Dts::Runtime::IDTSPropertiesProvider, System::ComponentModel::IComponent
public sealed class Variable : Microsoft.SqlServer.Dts.Runtime.DtsObject, IDisposable, Microsoft.SqlServer.Dts.Runtime.IDTSExecutionPath, Microsoft.SqlServer.Dts.Runtime.IDTSName, Microsoft.SqlServer.Dts.Runtime.IDTSPackagePath, Microsoft.SqlServer.Dts.Runtime.IDTSPersist, Microsoft.SqlServer.Dts.Runtime.IDTSPropertiesProvider, System.ComponentModel.IComponent
type Variable = class
inherit DtsObject
interface IDTSPersist
interface IDTSName
interface IDTSPropertiesProvider
interface IDTSPackagePath
interface IDTSExecutionPath
interface IComponent
interface IDisposable
Public NotInheritable Class Variable
Inherits DtsObject
Implements IComponent, IDisposable, IDTSExecutionPath, IDTSName, IDTSPackagePath, IDTSPersist, IDTSPropertiesProvider
- 继承
- 实现
注解
变量被分组到命名空间以消除歧义。
System命名空间为每个包自动创建,包含只读属性。 命名 User 空间包含你可以添加的自定义属性。 你也可以创建一个自定义命名空间,添加变量。 该类继承了多个类和接口,其中包括两个来自Visual Studio .NET框架:
属性
| 名称 | 说明 |
|---|---|
| CreationName |
获取运行时引擎在创建 Variable 该对象实例并添加该对象到 Variables 集合时给出的字符串。 此属性为只读。 |
| DataType |
获得一个TypeCode枚举,描述变量的数据类型。 此属性为只读。 |
| Description |
获取或设置变量的描述。 |
| EvaluateAsExpression |
获得或设置一个布尔值,表示变量是否包含表达式。 |
| Expression |
获取或设置变量中包含的表达式。 |
| ID |
它会为变量分配GUID。 此字段是只读的。 |
| IncludeInDebugDump |
获取或设置一个值,指定是用户定义变量还是系统变量的变量值被包含在调试转储文件中。 |
| Name |
获取或设置变量的名称。 |
| Namespace |
获取或设置变量所属的命名空间。 |
| Parent |
获取实例的 Variable 父容器。 |
| Properties |
获取对象的集合 DtsProperty 。 此属性为只读。 |
| QualifiedName |
获取变量的完全限定名称,包括命名空间。 此属性为只读。 |
| RaiseChangedEvent |
获取或设置一个布尔值,指示变量值变化时是否被标记触发 OnVariableValueChanged(DtsContainer, Variable, Boolean) 事件。 |
| ReadOnly |
获得或设置一个布尔值,表示该变量为只读且无法修改其值。 |
| Site |
获取或设定变量的位置。 |
| SystemVariable |
获得一个布尔值,表示该变量是否属于系统变量。 此属性为只读。 |
| Value |
获取或设置变量的值。 |
方法
| 名称 | 说明 |
|---|---|
| Dispose() |
该方法继承自 IDisposable.dispose 方法,后者是一种显式指示对象执行清理的机制。 |
| Equals(Object) |
确定两个对象实例是否相等。 (继承自 DtsObject) |
| GetExecutionPath() |
返回当前 Variable 对象的执行路径。 |
| GetExpression(String) |
该 GetExpression(String) 方法不支持对象 Variable 。 请改用EvaluateAsExpression属性。 |
| GetHashCode() |
返回此实例的哈希代码。 (继承自 DtsObject) |
| GetPackagePath() |
返回变量所属包的路径。 |
| GetSensitiveValue() |
返回敏感变量值。 |
| LoadFromXML(XmlNode, IDTSEvents) |
你的应用代码无法调用此方法。 加载一个保存为 .xml的包,使用该 LoadPackage(String, IDTSEvents) 方法。 |
| SaveToXML(XmlDocument, XmlNode, IDTSEvents) |
你的应用代码无法调用此方法。 把包裹保存为 .xml,用这个 SaveToXml(String, Package, IDTSEvents) 方法。 |
| SetExpression(String, String) |
该 SetExpression(String, String) 方法不支持对象 Variable 。 请改用EvaluateAsExpression属性。 |
活动
| 名称 | 说明 |
|---|---|
| Disposed |
添加一个事件处理程序来监听变量上的事件。Disposed |