DbConnectionStringBuilder.TryGetValue(String, Object) Méthode

Définition

Espace de noms:

System.Data.Common

Assembly:

System.Data.Common.dll

Source:

DbConnectionStringBuilder.cs

Récupère une valeur correspondant à la clé fournie à partir de cet objet DbConnectionStringBuilder.

public:
 virtual bool TryGetValue(System::String ^ keyword, [Runtime::InteropServices::Out] System::Object ^ % value);

public virtual bool TryGetValue (string keyword, out object? value);

abstract member TryGetValue : string * obj -> bool
override this.TryGetValue : string * obj -> bool

Public Overridable Function TryGetValue (keyword As String, ByRef value As Object) As Boolean

Paramètres

keyword

String

Clé de l'élément à récupérer.

value

Object

Valeur correspondant au keyword.

Retours

Boolean

true si keyword a été trouvé dans la chaîne de connexion ; sinon, false.

Exceptions

ArgumentNullException

keyword contient une valeur Null (Nothing en Visual Basic).

Exemples

L’exemple suivant appelle la TryGetValue méthode, montrant plusieurs résultats possibles.

static void Main()
{
    DbConnectionStringBuilder builder = new DbConnectionStringBuilder();
    builder.ConnectionString =
        "Provider=sqloledb;Data Source=192.168.168.1,1433;" +
        "Network Library=DBMSSOCN;Initial Catalog=pubs;" +
        "Integrated Security=SSPI;";

    // Call TryGetValue method for multiple
    // key names.
    DisplayValue(builder, "Provider");
    DisplayValue(builder, "DATA SOURCE");
    DisplayValue(builder, "InvalidKey");
    DisplayValue(builder, null);

    Console.ReadLine();
}

private static void DisplayValue(
    DbConnectionStringBuilder 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
    // bubbles 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.");
    }
}

Sub Main()
    Dim builder As New DbConnectionStringBuilder
    builder.ConnectionString = _
        "Provider=sqloledb;Data Source=192.168.168.1,1433;" & _
        "Network Library=DBMSSOCN;Initial Catalog=pubs;" & _
        "Integrated Security=SSPI;"

    ' Call TryGetValue method for multiple
    ' key names.
    DisplayValue(builder, "Provider")
    DisplayValue(builder, "DATA SOURCE")
    DisplayValue(builder, "InvalidKey")
    DisplayValue(builder, Nothing)

    Console.ReadLine()
End Sub

Private Sub DisplayValue( _
 ByVal builder As DbConnectionStringBuilder, ByVal key As String)
    Dim value As Object

    ' Although TryGetValue handles missing keys,
    ' it doesn't handle passing in a null (Nothing in Visual Basic)
    ' key. This example traps for that particular error, but
    ' bubbles any other unknown exceptions back out to the
    ' caller. 
    Try
        If builder.TryGetValue(key, value) Then
            Console.WriteLine("{0}={1}", key, value)
        Else
            Console.WriteLine("Unable to retrieve value for '{0}'", key)
        End If
    Catch ex As ArgumentNullException
        Console.WriteLine("Unable to retrieve value for null key.")
    End Try
End Sub

Cet exemple affiche les résultats suivants :

Provider=sqloledb
DATA SOURCE=192.168.168.1,1433
Unable to retrieve value for //InvalidKey//
Unable to retrieve value for null key.

Remarques

La TryGetValue méthode permet aux développeurs de récupérer en toute sécurité une valeur d’un DbConnectionStringBuilder sans avoir à appeler la ContainsKey méthode. Étant donné que TryGetValue ne déclenche pas d’exception lorsque vous l’appelez, en passant une clé inexistante, vous n’avez pas besoin de rechercher une clé avant de récupérer sa valeur. L’appel TryGetValue avec une clé inexistante place la valeur Null (Nothing en Visual Basic) dans le value paramètre .

Voir aussi

• Chaînes de connexion dans ADO.NET
• Vue d'ensemble d’ADO.NET