Variables.Contains Method (Object)


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

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

Public Function Contains (
	index As Object
) As Boolean


Type: System.Object

The name, ID, description, or index of the variable to locate in the collection.

Return Value

Type: System.Boolean

A Boolean that indicates whether the collection can be accessed by using indexing. A value of true indicates that the collection can be accessed by using the syntax Variables[index].

If the Contains method returns false, this property will throw an exception. In C#, this property is the indexer for the Variables class.

The following code example adds a variable to the package. The code example uses various methods to locate the variable and print out its name, value, and namespace.

Imports System
Imports System.Collections.Generic
Imports System.Text
Imports Microsoft.SqlServer.Dts.Runtime

Namespace Adding_Variables
    Class Program
        Shared  Sub Main(ByVal args() As String)
            Dim app As Application =  New Application() 
            Dim pkg As Package =  app.LoadPackage("C:\Program Files\Microsoft SQL Server\100\Samples\Integration Services\Package Samples\CalculatedColumns Sample\CalculatedColumns\CalculatedColumns.dtsx",Nothing) 
            Dim pkgVars As Variables =  pkg.Variables 
            Dim myVar As Variable =  pkg.Variables.Add("myCustomVar",False,"User","3") 

            ' Verify whether the variable is in the collection now.
            Dim hasMyVar As Boolean =  pkg.Variables.Contains("myCustomVar") 
            Console.WriteLine("The variable was found? {0}", hasMyVar)

            ' Loop over the collection using the foreach keyword.
            Dim pkgVar As Variable
            For Each pkgVar In pkgVars
                ' Print variables only from the User namespace.
                If pkgVar.Namespace = "User" Then
                Console.WriteLine("Variable: {0}, {1}", pkgVar.Name, pkgVar.Value.ToString())
                End If
            ' Loop over the collection using the Enumerator. 
            Dim myEnum As VariableEnumerator =  pkg.Variables.GetEnumerator() 
            Dim i As Integer =  0 
            While (myEnum.MoveNext()) &&(myEnum.Current <> Nothing)
                    Console.WriteLine("[{0}] {1}, {2}",i = Console.WriteLine("[{0}] {1}, {2}",i + 1
            End While


            'Using the Item method syntax of [x], obtain the
            ' first entry in the collection.
            myVar = pkgVars(0)
            Console.WriteLine("The name and namespace of the first variable is: {0}, {1}", myVar.Name, myVar.Namespace)
            Dim nameOfFirstItem As String =  pkgVars(0).Name 
            Console.WriteLine("The name of the first variable is: {0}", nameOfFirstItem)
        End Sub
    End Class
End Namespace

Sample Output:

The variable was found? True

Variable: myCustomVar, 3


[0] myCustomVar, User


The name and namespace of the first variable is: CancelEvent, System

The name of the first variable is: CancelEvent

Return to top