SqlConnectionStringBuilder.TryGetValue(String, Object) Metodo

Definizione

Spazio dei nomi:

Microsoft.Data.SqlClient

Assembly:

Microsoft.Data.SqlClient.dll

Pacchetto:

Microsoft.Data.SqlClient v5.2.0

Recupera un valore che corrisponde alla chiave fornita da questo oggetto 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

Parametri

keyword

String

Chiave dell'elemento da recuperare.

value

Object

Valore corrispondente a keyword.

Restituisce

Boolean

true se keyword è stato rilevato all'interno della stringa di connessione; altrimenti, false.

Eccezioni

ArgumentNullException

keyword contiene un valore Null (Nothing in Visual Basic).

Esempio

Nell'esempio seguente viene illustrato il comportamento del metodo 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";
    }
}

Nello stesso esempio vengono visualizzati i seguenti risultati:

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

Commenti

Il metodo TryGetValue consente agli sviluppatori di recuperare in modo sicuro un valore da un oggetto SqlConnectionStringBuilder, senza la necessità di verificare che il nome della chiave fornito sia un nome di chiave valido. Poiché TryGetValue non genera un'eccezione quando la si chiama, passando una chiave inesistente, non è necessario cercare una chiave prima di recuperarne il valore. La chiamata a TryGetValue con una chiave inesistente inserisce il valore null (Nothing in Visual Basic) nel value parametro .