VariableDispenser.GetQualifiedName Method
Returns the qualified name of the variable.
Namespace: Microsoft.SqlServer.Dts.Runtime
Assembly: Microsoft.SqlServer.ManagedDTS (in Microsoft.SqlServer.ManagedDTS.dll)
Parameters
- variable
- Type: System.String
The variable whose fully qualified name you want to know.
Return Value
Type: System.StringThe qualified name of the variable, which includes the variable name and the namespace that it belongs to.
This method returns the full name of the variable, but does not lock the variable.
If the GetQualifiedName method is called by using only the name of the variable and not specifying the namespace, the method returns the first matching entry.
If this method returns the DTS_E_AMBIGUOUSVARIABLENAME method, it means that the reference is ambiguous, and you must provide a namespace together with the variable in the variable parameter. This error occurs when a variable with the same name exists in different namespaces. Specifying the namespace lets you locate the correct variable.
The following code example creates a VariableDispenser and adds two system variables to the list that is locked for reading, and one system variable to the list that is locked for writing. Then the GetVariables is called to lock all three variables in the collection. The fully-qualified name of the PackageName variable is output by using GetQualifiedName.
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
