VariableDispenser.Contains Method
Specifies whether an item can be retrieved from the VariableDispenser collection by using indexing without throwing an exception.
Namespace: Microsoft.SqlServer.Dts.Runtime
Assembly: Microsoft.SqlServer.ManagedDTS (in Microsoft.SqlServer.ManagedDTS.dll)
Parameters
- variable
- Type: System.String
The name of the variable to locate in the VariableDispenser collection.
Return Value
Type: System.Booleantrue 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.
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); } } }
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
