TechNet
Export (0) Print
Expand All

Variable Class

 

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)

System.Object
  Microsoft.SqlServer.Dts.Runtime.DtsObject
    Microsoft.SqlServer.Dts.Runtime.Variable

public sealed class Variable : DtsObject, IDTSPersist, IDTSName, 
	IDTSPropertiesProvider, IDTSPackagePath, IDTSExecutionPath, 
	IComponent, IDisposable

NameDescription
System_CAPS_pubpropertyCreationName

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.

System_CAPS_pubpropertyDataType

Gets a TypeCode enumeration that describes the data type of the variable. This property is read-only.

System_CAPS_pubpropertyDescription

Gets or sets the description for the variable.

System_CAPS_pubpropertyEvaluateAsExpression

Gets or sets a Boolean that indicates whether the variable contains an expression.

System_CAPS_pubpropertyExpression

Gets or sets the expression contained in a variable.

System_CAPS_pubpropertyID

Gets the GUID assigned to the variable. This field is read-only.

System_CAPS_pubpropertyIncludeInDebugDump

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.

System_CAPS_pubpropertyName

Gets or sets the name of the variable.

System_CAPS_pubpropertyNamespace

Gets or sets the namespace that the variable belongs to.

System_CAPS_pubpropertyParent

Gets the parent container of the Variable instance.

System_CAPS_pubpropertyProperties

Gets a collection of DtsProperty objects. This property is read-only.

System_CAPS_pubpropertyQualifiedName

Gets the fully qualified name of the variable, including the namespace. This property is read-only.

System_CAPS_pubpropertyRaiseChangedEvent

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.

System_CAPS_pubpropertyReadOnly

Gets or sets a Boolean that indicates that the variable is read-only and cannot have its value modified.

System_CAPS_pubpropertySite

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.

System_CAPS_pubpropertySystemVariable

Gets a Boolean that indicates whether the variable is a system variable. This property is read-only.

System_CAPS_pubpropertyValue

Gets or sets the value assigned to the variable.

NameDescription
System_CAPS_pubmethodDispose()

This method is inherited from the IDisposable.Dispose method, which is a mechanism to explicitly tell an object to perform cleanup.

System_CAPS_pubmethodEquals(Object)

Determines whether two object instances are equal.(Inherited from DtsObject.)

System_CAPS_pubmethodGetExecutionPath()

Returns the execution path of the current Variable object.

System_CAPS_pubmethodGetExpression(String)

The GetExpression method is not supported on Variable objects. Use the EvaluateAsExpression property instead.

System_CAPS_pubmethodGetHashCode()

Returns the hash code for this instance.(Inherited from DtsObject.)

System_CAPS_pubmethodGetPackagePath()

Returns the path of the package that the variable belongs to.

System_CAPS_pubmethodGetSensitiveValue()

Returns the sensitive variable value.

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodLoadFromXML(XmlNode, IDTSEvents)

This method is not callable by your application code. Loads a package saved as .xml, use the Application.LoadPackage method.

System_CAPS_pubmethodSaveToXML(XmlDocument, XmlNode, IDTSEvents)

This method is not callable by your application code. Saves a package as .xml, use the Application.SaveToXml method.

System_CAPS_pubmethodSetExpression(String, String)

The SetExpression method is not supported on Variable objects. Use the EvaluateAsExpression property instead.

System_CAPS_pubmethodToString()

(Inherited from Object.)

NameDescription
System_CAPS_pubeventDisposed

Adds an event handler to listen to the Disposed event on the variable.

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.

Return to top
Show:
© 2016 Microsoft