SqlConnectionStringBuilder.TryGetValue(String, Object) Metoda

Definicja

Przestrzeń nazw:

Microsoft.Data.SqlClient

Zestaw:

Microsoft.Data.SqlClient.dll

Pakiet:

Microsoft.Data.SqlClient v5.2.0

Pobiera wartość odpowiadającą podanemu kluczowi z tego SqlConnectionStringBuilderelementu .

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

Klucz elementu do pobrania.

value

Object

Wartość odpowiadająca .keyword

Zwraca

Boolean

truejeśli keyword został znaleziony w parametrach połączenia; w przeciwnym razie . false

Wyjątki

ArgumentNullException

keyword zawiera wartość null (Nothing w Visual Basic).

Przykłady

W poniższym przykładzie pokazano zachowanie metody 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";
    }
}

W przykładzie zostaną wyświetlone następujące wyniki:

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

Uwagi

Metoda TryGetValue umożliwia deweloperom bezpieczne pobieranie wartości z elementu SqlConnectionStringBuilder bez konieczności sprawdzania, czy podana nazwa klucza jest prawidłową nazwą klucza. Ponieważ funkcja TryGetValue nie zgłasza wyjątku podczas jego wywoływania, przekazując nieistniejący klucz, nie trzeba szukać klucza przed pobraniem jego wartości. Wywołanie metody TryGetValue z nieistniejącym kluczem spowoduje umieszczenie wartości null (Nothing w Visual Basic) w parametrze value .