Export (0) Print
Expand All
0 out of 1 rated this helpful - 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)
public sealed class Variable : DtsObject, 
	IDTSPersist, IDTSName, IDTSPropertiesProvider, IDTSPackagePath, IDTSExecutionPath, 
	IComponent, IDisposable

The Variable type exposes the following members.

  NameDescription
Public propertyCreationNameGets 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 propertyDataTypeGets a TypeCode enumeration that describes the data type of the variable. This property is read-only.
Public propertyDescriptionGets or sets the description for the variable.
Public propertyEvaluateAsExpressionGets or sets a Boolean that indicates whether the variable contains an expression.
Public propertyExpressionGets or sets the expression contained in a variable.
Public propertyIDGets the GUID assigned to the variable. This field is read-only.
Public propertyIncludeInDebugDumpGets 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 propertyNameGets or sets the name of the variable.
Public propertyNamespaceGets or sets the namespace that the variable belongs to.
Public propertyParentGets the parent container of the Variable instance.
Public propertyPropertiesGets a collection of DtsProperty objects. This property is read-only.
Public propertyQualifiedNameGets the fully qualified name of the variable, including the namespace. This property is read-only.
Public propertyRaiseChangedEventGets 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 propertyReadOnlyGets or sets a Boolean that indicates that the variable is read-only and cannot have its value modified.
Public propertySiteInfrastructure. Gets or sets the site of the variable.
Public propertySystemVariableGets a Boolean that indicates whether the variable is a system variable. This property is read-only.
Public propertyValueGets or sets the value assigned to the variable.
Top
  NameDescription
Public methodDisposeThis method is inherited from the IDisposable.Dispose method, which is a mechanism to explicitly tell an object to perform cleanup.
Public methodEqualsDetermines whether two object instances are equal. (Inherited from DtsObject.)
Public methodGetExecutionPathReturns the execution path of the current Variable object.
Public methodGetExpressionThe GetExpression method is not supported on Variable objects. Use the EvaluateAsExpression property instead.
Public methodGetHashCodeReturns the hash code for this instance. (Inherited from DtsObject.)
Public methodGetPackagePathReturns the path of the package that the variable belongs to.
Public methodGetSensitiveValueReturns the sensitive variable value.
Public methodGetType (Inherited from Object.)
Public methodLoadFromXMLThis method is not callable by your application code. Loads a package saved as .xml, use the Application.LoadPackage method.
Public methodSaveToXMLThis method is not callable by your application code. Saves a package as .xml, use the Application.SaveToXml method.
Public methodSetExpressionThe SetExpression method is not supported on Variable objects. Use the EvaluateAsExpression property instead.
Public methodToString (Inherited from Object.)
Top
  NameDescription
Public eventDisposedAdds 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)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.