Variable Class
SQL Server 2008 R2
Represents a variable on a package, task, or container. This class cannot be inherited.
Namespace:
Microsoft.SqlServer.Dts.Runtime
Assembly: Microsoft.SqlServer.ManagedDTS (in Microsoft.SqlServer.ManagedDTS.dll)
The Variable type exposes the following members.
| Name | Description | |
|---|---|---|
 | CreationName | Returns 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 | Returns 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 that the variable contains an expression. |
| Expression | Gets or sets the expression contained in a variable. |
| ID | 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. |
| Properties | Returns 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 | 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 | Infrastructure. |
| SystemVariable | Returns a Boolean that indicates if the variable is a system variable. This property is read-only. |
| Value | Gets or sets the value assigned to the variable. |
| Name | Description | |
|---|---|---|
| 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. (Inherited from DtsObject.) |
| Finalize | (Inherited from Object.) |
| GetExpression | The GetExpression method is not supported on Variable objects. Use the EvaluateAsExpression property instead. |
| GetHashCode | Returns the hash code for this instance. (Inherited from DtsObject.) |
| GetPackagePath | Returns the path of the package that the variable belongs to. |
| GetType | (Inherited from Object.) |
| LoadFromXML | This method is not callable by your application code. To load a package saved as .xml, use the Application.LoadPackage method. |
| MemberwiseClone | (Inherited from Object.) |
| SaveToXML | This method is not callable by your application code. To save 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 | (Inherited from Object.) |
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:
