SqlConnectionStringBuilder.TryGetValue(String, Object) Methode

Definition

Namespace:

Microsoft.Data.SqlClient

Assembly:

Microsoft.Data.SqlClient.dll

Paket:

Microsoft.Data.SqlClient v5.2.0

Ruft einen Wert ab, der dem von diesem SqlConnectionStringBuilder bereitgestellten Schlüssel entspricht.

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

Parameter

keyword

String

Der Schlüssel des abzurufenden Elements.

value

Object

Der Wert, der keyword entspricht.

Gibt zurück

Boolean

true, wenn keyword in der Verbindungszeichenfolge gefunden wurde, andernfalls false.

Ausnahmen

ArgumentNullException

keyword enthält einen NULL-Wert (Nothing in Visual Basic).

Beispiele

Im folgenden Beispiel wird das Verhalten der TryGetValue-Methode veranschaulicht.

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

In diesem Beispiel werden die folgenden Ergebnisse angezeigt:

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

Hinweise

Mit der TryGetValue-Methode können Entwickler einen Wert sicher aus einem SqlConnectionStringBuilder abrufen, ohne die Gültigkeit des bereitgestellten Schlüsselnamens überprüfen zu müssen. Da TryGetValue beim Aufrufen keine Ausnahme auslöst, indem Sie einen nicht vorhandenen Schlüssel übergeben, müssen Sie vor dem Abrufen des Werts nicht nach einem Schlüssel suchen. Wenn TryGetValue mit einem nicht vorhandenen Schlüssel aufgerufen wird, wird der Wert NULL (Nothing in Visual Basic) im value Parameter platziert.