Partager via


SqlConnectionStringBuilder.TryGetValue(String, Object) Méthode

Définition

Récupère une valeur correspondant à la clé fournie à partir de cet objet SqlConnectionStringBuilder.

public:
 override bool TryGetValue(System::String ^ keyword, [Runtime::InteropServices::Out] System::Object ^ % value);
public override bool TryGetValue (string keyword, out object value);
override this.TryGetValue : string * obj -> bool
Public Overrides Function TryGetValue (keyword As String, ByRef value As Object) As Boolean

Paramètres

keyword
String

Clé de l'élément à récupérer.

value
Object

Valeur correspondant à keyword.

Retours

true si keyword a été trouvé dans la chaîne de connexion ; sinon, false.

Exceptions

keyword contient une valeur Null (Nothing en Visual Basic).

Exemples

L’exemple suivant illustre le comportement de la méthode TryGetValue .

using Microsoft.Data.SqlClient;


class Program
{
    static void Main()
    {
        SqlConnectionStringBuilder builder = new SqlConnectionStringBuilder();
        builder.ConnectionString = GetConnectionString();

        // Call TryGetValue method for multiple
        // key names. Note that these keys are converted
        // to well-known synonynms for data retrieval.
        DisplayValue(builder, "Data Source");
        DisplayValue(builder, "Trusted_Connection");
        DisplayValue(builder, "InvalidKey");
        DisplayValue(builder, null);

        Console.WriteLine("Press any key to continue.");
        Console.ReadLine();
    }

    private static void DisplayValue(
        SqlConnectionStringBuilder builder, string key)
    {
        object value = null;

        // Although TryGetValue handles missing keys,
        // it doesn't handle passing in a null
        // key. This example traps for that particular error, but
        // passes any other unknown exceptions back out to the
        // caller. 
        try
        {
            if (builder.TryGetValue(key, out value))
            {
                Console.WriteLine("{0}='{1}'", key, value);
            }
            else
            {
                Console.WriteLine("Unable to retrieve value for '{0}'", key);
            }
        }
        catch (ArgumentNullException)
        {
            Console.WriteLine("Unable to retrieve value for null key.");
        }
    }

    private static string GetConnectionString()
    {
        // To avoid storing the connection string in your code,
        // you can retrieve it from a configuration file. 
        return "Server=(local);Integrated Security=SSPI;" +
            "Initial Catalog=AdventureWorks";
    }
}

Cet exemple affiche les résultats suivants :

Data Source=(local)  
Trusted_Connection=True  
Unable to retrieve value for 'InvalidKey'  
Unable to retrieve value for null key.  

Remarques

La méthode TryGetValue permet aux développeurs de récupérer en toute sécurité une valeur à partir d'un SqlConnectionStringBuilder sans avoir à vérifier que le nom de clé fourni est valide. Étant donné que TryGetValue ne déclenche pas d’exception lorsque vous l’appelez, en passant une clé inexistante, vous n’avez pas besoin de rechercher une clé avant de récupérer sa valeur. L’appel de TryGetValue avec une clé inexistante place la valeur null (Nothing en Visual Basic) dans le value paramètre .

S’applique à