Variable 类

Represents a variable on a package, task, or container. This class cannot be inherited.

继承层次结构

System.Object
  Microsoft.SqlServer.Dts.Runtime.DtsObject
    Microsoft.SqlServer.Dts.Runtime.Variable

命名空间:  Microsoft.SqlServer.Dts.Runtime
程序集:  Microsoft.SqlServer.ManagedDTS(在 Microsoft.SqlServer.ManagedDTS.dll 中)

语法

声明
Public NotInheritable Class Variable _
    Inherits DtsObject _
    Implements IDTSPersist, IDTSName, IDTSPropertiesProvider, IDTSPackagePath,  _
    IDTSExecutionPath, IComponent, IDisposable
用法
Dim instance As Variable
public sealed class Variable : DtsObject, 
    IDTSPersist, IDTSName, IDTSPropertiesProvider, IDTSPackagePath, IDTSExecutionPath, 
    IComponent, IDisposable
public ref class Variable sealed : public DtsObject, 
    IDTSPersist, IDTSName, IDTSPropertiesProvider, IDTSPackagePath, IDTSExecutionPath, 
    IComponent, IDisposable
[<SealedAttribute>]
type Variable =  
    class 
        inherit DtsObject 
        interface IDTSPersist 
        interface IDTSName 
        interface IDTSPropertiesProvider 
        interface IDTSPackagePath 
        interface IDTSExecutionPath 
        interface IComponent 
        interface IDisposable 
    end
public final class Variable extends DtsObject implements IDTSPersist, IDTSName, IDTSPropertiesProvider, IDTSPackagePath, IDTSExecutionPath, IComponent, IDisposable

Variable 类型公开以下成员。

属性

  名称 说明
公共属性 CreationName Gets the string that the runtime engine gives when it creates an instance of the Variable object and adds the object to the Variables collection. This property is read-only.
公共属性 DataType Gets a TypeCode enumeration that describes the data type of the variable. This property is read-only.
公共属性 Description Gets or sets the description for the variable.
公共属性 EvaluateAsExpression Gets or sets a Boolean that indicates whether the variable contains an expression.
公共属性 Expression Gets or sets the expression contained in a variable.
公共属性 ID Gets the GUID assigned to the variable. This field is read-only.
公共属性 IncludeInDebugDump Gets or sets a value that specifies whether the variable value for a user-defined variable or a system variable is included in the debug dump files.
公共属性 Name Gets or sets the name of the variable.
公共属性 Namespace Gets or sets the namespace that the variable belongs to.
公共属性 Parent Gets the parent container of the Variable instance.
公共属性 Properties Gets a collection of DtsProperty objects. This property is read-only.
公共属性 QualifiedName Gets the fully qualified name of the variable, including the namespace. This property is read-only.
公共属性 RaiseChangedEvent Gets or sets a Boolean that indicates if the variable has been flagged to raise the OnVariableValueChanged event when the value of the variable changes.
公共属性 ReadOnly Gets or sets a Boolean that indicates that the variable is read-only and cannot have its value modified.
公共属性 Site 基础结构。Gets or sets the site of the variable.
公共属性 SystemVariable Gets a Boolean that indicates whether the variable is a system variable. This property is read-only.
公共属性 Value Gets or sets the value assigned to the variable.

页首

方法

  名称 说明
公共方法 Dispose This method is inherited from the IDisposable.Dispose method, which is a mechanism to explicitly tell an object to perform cleanup.
公共方法 Equals Determines whether two object instances are equal. (从 DtsObject 继承。)
公共方法 GetExecutionPath Returns the execution path of the current Variable object.
公共方法 GetExpression The GetExpression method is not supported on Variable objects. Use the EvaluateAsExpression property instead.
公共方法 GetHashCode Returns the hash code for this instance. (从 DtsObject 继承。)
公共方法 GetPackagePath Returns the path of the package that the variable belongs to.
公共方法 GetSensitiveValue Returns the sensitive variable value.
公共方法 GetType (从 Object 继承。)
公共方法 LoadFromXML This method is not callable by your application code. Loads a package saved as .xml, use the Application.LoadPackage method.
公共方法 SaveToXML This method is not callable by your application code. Saves a package as .xml, use the Application.SaveToXml method.
公共方法 SetExpression The SetExpression method is not supported on Variable objects. Use the EvaluateAsExpression property instead.
公共方法 ToString (从 Object 继承。)

页首

事件

  名称 说明
公共事件 Disposed Adds an event handler to listen to the Disposed event on the variable.

页首

注释

Variables are grouped into namespaces for disambiguation. The System namespace is created automatically for every package and contains read-only properties. The User namespace contains custom properties that you can add. You can also create a namespace of your choosing to which to add variables. This class inherits from several classes and interfaces, including two from the Visual Studio .NET Framework:

线程安全

此类型的任何公共 static(在 Visual Basic 中为 Shared) 成员都是线程安全的。不保证所有实例成员都是线程安全的。

请参阅

参考

Microsoft.SqlServer.Dts.Runtime 命名空间