Variable Members
Represents a variable on a package, task, or container. This class cannot be inherited.
The following tables list the members exposed by the Variable type.
Public Properties
| Name | Description | |
|---|---|---|
.gif "ms213201.pubproperty(en-US,SQL.90).gif") |
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. |
|
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 | |
|
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. |
Top
Public Methods
(see also Protected Methods )
| Name | Description | |
|---|---|---|
.gif "ms213201.pubmethod(en-US,SQL.90).gif") |
Dispose | This method is inherited from the IDisposable.Dispose method, which is a mechanism to explicitly tell an object to perform cleanup. |
|
Equals | Overloaded. (inherited from DtsObject ) |
|
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. |
.gif "ms213201.static(en-US,SQL.90).gif") |
op_Equality | (inherited from DtsObject ) |
|
op_Inequality | (inherited from DtsObject ) |
|
ReferenceEquals | (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 ) |
Top
Protected Methods
| Name | Description | |
|---|---|---|
.gif "ms213201.protmethod(en-US,SQL.90).gif") |
Finalize | (inherited from Object ) |
|
MemberwiseClone | (inherited from Object ) |
Top
Public Events
| Name | Description | |
|---|---|---|
.gif "ms213201.pubevent(en-US,SQL.90).gif") |
Disposed | Adds an event handler to listen to the Disposed event on the Variable. |
Top