Variables.Add Method

Article
12/03/2008

Adds a Variable object to the Variables collection.

Namespace: Microsoft.SqlServer.Dts.Runtime
Assembly: Microsoft.SqlServer.ManagedDTS (in microsoft.sqlserver.manageddts.dll)

Syntax

'Declaration
Public Function Add ( _
    name As String, _
    readOnly As Boolean, _
    nameSpace As String, _
    val As Object _
) As Variable

public Variable Add (
    string name,
    bool readOnly,
    string nameSpace,
    Object val
)

public:
Variable^ Add (
    String^ name, 
    bool readOnly, 
    String^ nameSpace, 
    Object^ val
)

public Variable Add (
    String name, 
    boolean readOnly, 
    String nameSpace, 
    Object val
)

public function Add (
    name : String, 
    readOnly : boolean, 
    nameSpace : String, 
    val : Object
) : Variable

Parameters

name
The name of the package, task, or container variable to add to the collection.

readOnly
A Boolean that indicates whether the variable is read-only or whether the variable can be modified.

nameSpace
The namespace for the variable. Default value is the User variable namespace. You can also create a namespace to identify variables you create that are used in a certain part of a package. You cannot add variables to the System variable namespace.

val
The design-time value of the variable.

Return Value

The newly created variable that was added to the Variables collection.

Remarks

For more information, see Using Variables in Packages.

Example

The following example creates a package, and adds a variable, myVar, to its variable collection.

static void Main(string[] args)
        {
            Package p = new Package();
            //Add a variable, myvar, to the package variables
            // collection. The variable has a value of 5, in the myNamespace
            // namespace.
            Variable var = p.Variables.Add("myVar", false, "myNamespace", 5);
            //
            // Enter the rest of your code here.
            //
        }

Shared  Sub Main(ByVal args() As String)
            Dim p As Package =  New Package() 
            'Add a variable, myvar, to the package variables
            ' collection. The variable has a value of 5, in the myNamespace
            ' namespace.
            Dim var As Variable =  p.Variables.Add("myVar",False,"myNamespace",5) 
            '
            ' Enter the rest of your code here.
            '
End Sub

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms