Variables Variables Variables Variables Class

Definition

Contains a collection of Variables objects, which are accessed through several objects. This class cannot be inherited.

public ref class Variables sealed : Microsoft::SqlServer::Dts::Runtime::DTSReadOnlyCollectionBase
public sealed class Variables : Microsoft.SqlServer.Dts.Runtime.DTSReadOnlyCollectionBase
type Variables = class
    inherit DTSReadOnlyCollectionBase
Public NotInheritable Class Variables
Inherits DTSReadOnlyCollectionBase
Inheritance

Remarks

Integration Services (SSIS) provides system variables and supports custom user variables. When you create a new package, add a container or a task to the package, or create an event handler, SSIS automatically includes a set of system variables for the item. System variables are always located in the System namespace. System variables contain useful information about the package and its containers, tasks, and event handlers. System variables contain information such as the name of the computer on which the package runs and the time the package starts. You can view the information that is contained in a system variable, but you cannot add to or update system variables.

You can also create custom variables for use in packages, containers, tasks, transformations, and precedence constraints. Custom variables can be created in the User namespace or a namespace of your choice. Custom variables can be used in the expressions that the For Loop container, the Derived Column transformation, the Conditional Split transformation, and precedence constraints may contain. For more information, see Use Variables in Packages.

Every container in the SSIS object model has a Variables collection. This collection is accessible to each child of the container. A variable is accessed from the collection by using its name or its index. The Variables collection on a container represents an aggregation of the variables in the collection of its parent. The Variables collection of the Package class is visible to all objects in the package, providing a globally visible collection. Conversely, the variables contained in a task are limited in scope and visibility, and are only visible by the task.

Important

The Variables is used with the Runtime classes. If you are using data flow components (Microsoft.SqlServer.Dts.Pipeline), you may be required to use the IDTSVariables100. To know which variables collection to use, see the documentation for the object you are acquiring variables on, and verify the return value.

Properties

Count Count Count Count

Gets the number of elements contained in the DTSReadOnlyCollectionBase instance.

(Inherited from DTSReadOnlyCollectionBase)
IsSynchronized IsSynchronized IsSynchronized IsSynchronized

Gets a value that indicates whether access to the DTSReadOnlyCollectionBase is synchronized (thread-safe).

(Inherited from DTSReadOnlyCollectionBase)
Item[Object] Item[Object] Item[Object] Item[Object]

Returns a Variable object from the Variables collection.

Locked Locked Locked Locked

A Boolean indicating whether the variables in the Variables collection are locked.

SyncRoot SyncRoot SyncRoot SyncRoot

Gets an object that can be used to synchronize access to the DTSReadOnlyCollectionBase.

(Inherited from DTSReadOnlyCollectionBase)

Methods

Add(String, Boolean, String, Object) Add(String, Boolean, String, Object) Add(String, Boolean, String, Object) Add(String, Boolean, String, Object)

Adds a Variable object to the Variables collection.

Contains(Object) Contains(Object) Contains(Object) Contains(Object)

Returns a Boolean that indicates whether the items in the collection can be accessed by using indexing without throwing an exception.

CopyTo(Array, Int32) CopyTo(Array, Int32) CopyTo(Array, Int32) CopyTo(Array, Int32)

Copies the entire DTSReadOnlyCollectionBase to a compatible one-dimensional array, starting at the specified index of the target array.

(Inherited from DTSReadOnlyCollectionBase)
CreateManagedObject(Object) CreateManagedObject(Object) CreateManagedObject(Object) CreateManagedObject(Object)

Creates managed object from an unmanaged object.

(Inherited from DTSReadOnlyCollectionBase)
GetCount() GetCount() GetCount() GetCount()

Retrieves the number of objects in the collection.

(Inherited from DTSReadOnlyCollectionBase)
GetEnumerator() GetEnumerator() GetEnumerator() GetEnumerator()

Returns a VariableEnumerator enumerator for use in iterating over the Variables collection.

GetManagedEnumerator(Object) GetManagedEnumerator(Object) GetManagedEnumerator(Object) GetManagedEnumerator(Object)

Gets the managed enumerator from an unmanaged enumerator.

(Inherited from DTSReadOnlyCollectionBase)
Join(Variable) Join(Variable) Join(Variable) Join(Variable)

Joins the Variable to the Variables collection.

Remove(Object) Remove(Object) Remove(Object) Remove(Object)

Removes a Variable object from the Variables collection.

Unlock() Unlock() Unlock() Unlock()

Releases the locks on the variables collection and flags the state of the variables collection as invalid or unknown.

Fields

m_unmanagedColl m_unmanagedColl m_unmanagedColl m_unmanagedColl

The unmanaged collection.

(Inherited from DTSReadOnlyCollectionBase)

Applies to