SqlConnectionStringBuilder.TryGetValue(String, Object) Método

Definición

Espacio de nombres:

Microsoft.Data.SqlClient

Ensamblado:

Microsoft.Data.SqlClient.dll

Paquete:

Microsoft.Data.SqlClient v5.2.0

Recupera un valor que corresponde a la clave proporcionada por este 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

Parámetros

keyword

String

Clave del elemento que se va a recuperar.

value

Object

Valor que corresponde a keyword.

Devoluciones

Boolean

Es true si keyword fue encontrado dentro de la cadena de conexión, en caso contrario, es false.

Excepciones

ArgumentNullException

keyword contiene un valor null (Nothing en Visual Basic).

Ejemplos

En el ejemplo siguiente se muestra el comportamiento del método 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";
    }
}

Este ejemplo muestra el siguiente resultado:

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

Comentarios

El método TryGetValue permite a los programadores recuperar de manera segura un valor de SqlConnectionStringBuilder sin tener que comprobar si el nombre de clave proporcionado es válido. Dado que TryGetValue no genera una excepción al llamarlo, pasando una clave inexistente, no es necesario buscar una clave antes de recuperar su valor. Al llamar a TryGetValue con una clave inexistente, el valor null (Nothing en Visual Basic) se colocará en el value parámetro .