SqlConnectionStringBuilder.TryGetValue(String, Object) Метод

Определение

Пространство имен:

Microsoft.Data.SqlClient

Сборка:

Microsoft.Data.SqlClient.dll

Пакет:

Microsoft.Data.SqlClient v5.2.0

Получает значение, соответствующее заданному ключу, из данного объекта 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

Параметры

keyword

String

Ключ искомого элемента.

value

Object

Значение, соответствующее keyword.

Возвращаемое значение

Boolean

Значение true, если значение keyword найдено в строке подключения. В противном случае — значение false.

Исключения

ArgumentNullException

keyword содержит значение NULL (Nothing в Visual Basic).

Примеры

В следующем примере показано поведение метода 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";
    }
}

В результате выполнения данного образца выдаются следующие результаты:

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

Комментарии

Метод TryGetValue позволяет разработчикам получать значение из объекта SqlConnectionStringBuilder, не проверяя допустимость передаваемого ключевого слова. Так как TryGetValue не вызывает исключение при его вызове, передавая несуществующий ключ, вам не нужно искать ключ перед получением его значения. Вызов TryGetValue с несуществующим ключом поместит значение NULL (Nothing в Visual Basic) в value параметр .