VariableDispenser.Contains Method

Specifies whether an item can be retrieved from the VariableDispenser collection by using indexing without throwing an exception.

Espace de noms: Microsoft.SqlServer.Dts.Runtime
Assembly: Microsoft.SqlServer.ManagedDTS (in microsoft.sqlserver.manageddts.dll)

Syntaxe

'Déclaration
Public Function Contains ( _
    variable As String _
) As Boolean

public bool Contains (
    string variable
)

public:
bool Contains (
    String^ variable
)

public boolean Contains (
    String variable
)

public function Contains (
    variable : String
) : boolean

Paramètres

variable
The name of the variable to locate in the VariableDispenser collection.

Valeur de retour

true indicates that the syntax VariableDispenser[x] can be used without throwing an exception. A value of false indicates that indexing cannot be used to retrieve items from the collection.

Notes

Exemple de code mis à jour :17 juillet 2006

Exemple

The following code example creates a VariableDispenser and uses the Contains method to return a Boolean to determine whether indexing syntax can be used on the collection.

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

namespace Microsoft.SqlServer.SSIS.Sample
{
    class Program
    {
        static void Main(string[] args)
        {
            Package pkg = new Package();
            Variables vars = null;
            VariableDispenser variableDispenser = pkg.VariableDispenser;
            variableDispenser.LockForRead("System::PackageName");
            variableDispenser.LockForRead("System::OfflineMode");
            variableDispenser.GetVariables(ref vars);           
            // Verify that the variable is locked before unlocking.
            Console.WriteLine("Variables are locked? {0}", vars.Locked);
            foreach (Variable myVar in vars)
            {
                Console.WriteLine("Name        {0}", myVar.Name);
                Console.WriteLine("Description {0}", myVar.Description);
                Console.WriteLine();
            }
            // Use Contains to determine whether indexing can be used.
            Boolean pkgName = variableDispenser.Contains("PackageName");
            String qName = variableDispenser.GetQualifiedName("PackageName");
            Console.WriteLine("Contains is valid?       {0}", pkgName);
            Console.WriteLine("Fully qualified name is: {0}", qName);

            vars.Unlock();

            Console.WriteLine("Variables are locked? {0}", vars.Locked);
        }
    }
}

Imports System
Imports System.Collections.Generic
Imports System.Text
Imports Microsoft.SqlServer.Dts.Runtime
 
Namespace Microsoft.SqlServer.SSIS.Sample
    Class Program
        Shared  Sub Main(ByVal args() As String)
            Dim pkg As Package =  New Package() 
            Dim vars As Variables =  Nothing 
            Dim variableDispenser As VariableDispenser =  pkg.VariableDispenser 
            variableDispenser.LockForRead("System::PackageName")
            variableDispenser.LockForRead("System::OfflineMode")
            variableDispenser.GetVariables( vars)
            ' Verify that the variable is locked before unlocking.
            Console.WriteLine("Variables are locked? {0}", vars.Locked)
            Dim myVar As Variable
            For Each myVar In vars
                Console.WriteLine("Name        {0}", myVar.Name)
                Console.WriteLine("Description {0}", myVar.Description)
                Console.WriteLine()
            Next
            ' Use Contains to determine whether indexing can be used.
            Dim pkgName As Boolean =  variableDispenser.Contains("PackageName") 
            Dim qName As String =  variableDispenser.GetQualifiedName("PackageName") 
            Console.WriteLine("Contains is valid?       {0}", pkgName)
            Console.WriteLine("Fully qualified name is: {0}", qName)

            vars.Unlock()

            Console.WriteLine("Variables are locked? {0}", vars.Locked)
        End Sub
    End Class
End Namespace

Sample Output:

Variables are locked? True

Name OfflineMode

Description The offline mode currently set for the package

Name PackageName

Description The package name

Contains is valid? True

Fully qualified name is: System::PackageName

Variables are locked? False

Sécurité des threads

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.

Plateformes

Plateformes de développement

Pour obtenir la liste des plateformes prises en charge, consultez Configuration matérielle et logicielle requise pour l'installation de SQL Server 2005.

Plateformes cibles