Variable Class
Represents a variable on a package, task, or container. This class cannot be inherited.
Assembly: Microsoft.SqlServer.ManagedDTS (in Microsoft.SqlServer.ManagedDTS.dll)
| Name | Description | |
|---|---|---|
![]() | 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 | This API supports the product infrastructure and is not intended to be used directly from your code. 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. |
| 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(Object^) | Determines whether two object instances are equal.(Inherited from DtsObject.) |
![]() | GetExecutionPath() | Returns the execution path of the current Variable object. |
![]() | GetExpression(String^) | 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. |
![]() | GetSensitiveValue() | Returns the sensitive variable value. |
![]() | GetType() | (Inherited from Object.) |
![]() | LoadFromXML(XmlNode^, IDTSEvents^) | This method is not callable by your application code. Loads a package saved as .xml, use the Application::LoadPackage method. |
![]() | SaveToXML(XmlDocument^%, XmlNode^, IDTSEvents^) | This method is not callable by your application code. Saves a package as .xml, use the Application::SaveToXml method. |
![]() | SetExpression(String^, String^) | 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:
Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.


