SqlConnectionStringBuilder.TryGetValue(String, Object) Metoda

Definice

Obor názvů:

Microsoft.Data.SqlClient

Sestavení:

Microsoft.Data.SqlClient.dll

Balíček:

Microsoft.Data.SqlClient v5.2.0

Načte hodnotu odpovídající zadanému klíči z tohoto 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

Parametry

keyword

String

Klíč položky, která se má načíst.

value

Object

Hodnota odpovídající hodnotě keyword.

Návraty

Boolean

true pokud keyword byl nalezen v připojovacím řetězci, falsev opačném případě .

Výjimky

ArgumentNullException

keyword obsahuje hodnotu null (Nothing v jazyce Visual Basic).

Příklady

Následující příklad ukazuje chování TryGetValue metoda.

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";
    }
}

Ukázka zobrazí následující výsledky:

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

Poznámky

Metoda TryGetValue umožňuje vývojářům bezpečně načíst hodnotu z SqlConnectionStringBuilder a, aniž by museli ověřit, že zadaný název klíče je platný název klíče. Vzhledem k tomu, že TryGetValue nevyvolá výjimku při volání, předání neexistující klíč, nemusíte hledat klíč před načtením jeho hodnoty. Volání tryGetValue s neexistujícím klíčem umístí hodnotu null (Nothing v jazyce Visual Basic) do parametru value .