Home Library Learn Downloads Support Community
Sign in | United States - English | |
This topic has not yet been rated - Rate this topic

Variable Class

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

Namespace:  Microsoft.SqlServer.Dts.Runtime
Assembly:  Microsoft.SqlServer.ManagedDTS (in Microsoft.SqlServer.ManagedDTS.dll)
C#
C++
F#
JScript
VB
Copy 
public sealed class Variable : DtsObject, 
	IDTSPersist, IDTSName, IDTSPropertiesProvider, IDTSPackagePath, IDTSExecutionPath, 
	IComponent, IDisposable

The Variable type exposes the following members.

  Name Description
Public property 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.
Public property DataType Gets a TypeCode enumeration that describes the data type of the variable. This property is read-only.
Public property Description Gets or sets the description for the variable.
Public property EvaluateAsExpression Gets or sets a Boolean that indicates whether the variable contains an expression.
Public property Expression Gets or sets the expression contained in a variable.
Public property ID Gets the GUID assigned to the variable. This field is read-only.
Public property 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.
Public property Name Gets or sets the name of the variable.
Public property Namespace Gets or sets the namespace that the variable belongs to.
Public property Parent Gets the parent container of the Variable instance.
Public property Properties Gets a collection of DtsProperty objects. This property is read-only.
Public property QualifiedName Gets the fully qualified name of the variable, including the namespace. This property is read-only.
Public property 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.
Public property ReadOnly Gets or sets a Boolean that indicates that the variable is read-only and cannot have its value modified.
Public property Site Infrastructure. Gets or sets the site of the variable.
Public property SystemVariable Gets a Boolean that indicates whether the variable is a system variable. This property is read-only.
Public property Value Gets or sets the value assigned to the variable.
Top
  Name Description
Public method Dispose This method is inherited from the IDisposable.Dispose method, which is a mechanism to explicitly tell an object to perform cleanup.
Public method Equals Determines whether two object instances are equal. (Inherited from DtsObject.)
Protected method Finalize (Inherited from Object.)
Public method GetExecutionPath Returns the execution path of the current Variable object.
Public method GetExpression The GetExpression method is not supported on Variable objects. Use the EvaluateAsExpression property instead.
Public method GetHashCode Returns the hash code for this instance. (Inherited from DtsObject.)
Public method GetPackagePath Returns the path of the package that the variable belongs to.
Public method GetSensitiveValue Returns the sensitive variable value.
Public method GetType (Inherited from Object.)
Public method LoadFromXML This method is not callable by your application code. Loads a package saved as .xml, use the Application.LoadPackage method.
Protected method MemberwiseClone (Inherited from Object.)
Public method SaveToXML This method is not callable by your application code. Saves a package as .xml, use the Application.SaveToXml method.
Public method SetExpression The SetExpression method is not supported on Variable objects. Use the EvaluateAsExpression property instead.
Public method ToString (Inherited from Object.)
Top
  Name Description
Public event Disposed Adds an event handler to listen to the Disposed event on the variable.
Top

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:

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)