Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

Variables.Contains Method

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 bool Contains (
	Object index
)
public boolean Contains (
	Object index
)
public function Contains (
	index : Object
) : boolean

Parameters

index

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

Return Value

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.

using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.SqlServer.Dts.Runtime;

namespace Adding_Variables
{
    class Program
    {
        static void Main(string[] args)
        {
            Application app = new Application();
            Package pkg = app.LoadPackage(@"C:\Program Files\Microsoft SQL Server\90\Samples\Integration Services\Package Samples\CalculatedColumns Sample\CalculatedColumns\CalculatedColumns.dtsx", null);
            Variables pkgVars = pkg.Variables;
            Variable myVar = pkg.Variables.Add("myCustomVar", false, "User", "3");

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

            // Loop over the collection using the foreach keyword.
            foreach (Variable pkgVar in pkgVars)
            {
                // Print variables only from the User namespace.
                if (pkgVar.Namespace == "User")
                {
                Console.WriteLine("Variable: {0}, {1}", pkgVar.Name, pkgVar.Value.ToString());
                 }
            }
            Console.WriteLine("---------------------------");
            // Loop over the collection using the Enumerator. 
            VariableEnumerator myEnum = pkg.Variables.GetEnumerator();
            int i = 0;
            while ((myEnum.MoveNext()) && (myEnum.Current != null))
                // Again, show variables only from the User namespace.
                if (myEnum.Current.Namespace == "User")
                {                
                    Console.WriteLine("[{0}] {1}, {2}", i++, myEnum.Current.Name, myEnum.Current.Namespace);
                }

            myEnum.Reset();
            Console.WriteLine("---------------------------");

            //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);
            String nameOfFirstItem = pkgVars[0].Name;
            Console.WriteLine("The name of the first variable is: {0}", nameOfFirstItem);
            //}
        }
    }
}

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

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.

Development Platforms

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

Target Platforms

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.