OdbcConnectionStringBuilder.TryGetValue(String, Object) Méthode

Définition

Espace de noms:

System.Data.Odbc

Assembly:

System.Data.Odbc.dll

Paquet:

System.Data.Odbc v9.0.0-preview.3.24172.9

Source:

OdbcConnectionStringbuilder.cs

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

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

Paramètres

keyword

String

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

value

Object

Valeur correspondant à keyword.

Retours

Boolean

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

Exemples

L’exemple suivant illustre le comportement de la TryGetValue méthode.

using System.Data.Odbc;

class Program
{
    static void Main()
    {
        OdbcConnectionStringBuilder builder =
            new OdbcConnectionStringBuilder();
        builder.ConnectionString = GetConnectionString();

        // Call TryGetValue method for multiple
        // key names. Demonstrate that the search is not
        // case sensitive.
        DisplayValue(builder, "Driver");
        DisplayValue(builder, "SERVER");
        // How about a property you did not set?
        DisplayValue(builder, "DNS");
        // Invalid keys?
        DisplayValue(builder, "Invalid Key");
        // Null values?
        DisplayValue(builder, null);

        Console.WriteLine("Press any key to continue.");
        Console.ReadLine();
    }

    private static string GetConnectionString()
    {
        // To avoid storing the connection string in your code,
        // you can retrieve it from a configuration file using the
        // System.Configuration.ConfigurationSettings.AppSettings property.
        return "Driver={SQL Server};Server=(local);" +
            "Database=AdventureWorks;Trusted_Connection=yes;";
    }

    private static void DisplayValue(OdbcConnectionStringBuilder builder, string key)
    {
        object value = null;

        // Although TryGetValue handles missing keys,
        // it does not handle passing in a null (Nothing in Visual Basic)
        // key. This example traps for that particular error, but
        // throws 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 ex)
        {
            Console.WriteLine("Unable to retrieve value for null key.");
        }
    }
}

Imports System.Data.Odbc
    
Module Module1

  Sub Main()
    Dim builder As New OdbcConnectionStringBuilder
    builder.ConnectionString = GetConnectionString()

    ' Call TryGetValue method for multiple
    ' key names. Demonstrate that the search is not
    ' case sensitive.
    DisplayValue(builder, "Driver")
    DisplayValue(builder, "SERVER")
    ' How about a property you did not set?
    DisplayValue(builder, "DNS")
    ' Invalid keys?
    DisplayValue(builder, "Invalid Key")
    ' Null values?
    DisplayValue(builder, Nothing)

    Console.WriteLine("Press any key to continue.")
    Console.ReadLine()
  End Sub

  Private Sub DisplayValue( _
   ByVal builder As OdbcConnectionStringBuilder, ByVal key As String)
    Dim value As Object = Nothing

    ' Although TryGetValue handles missing keys,
    ' it does not handle passing in a null (Nothing in Visual Basic)
    ' key. This example traps for that particular error, but
    ' throws 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

  Private Function GetConnectionString() As String
    ' To avoid storing the connection string in your code,
    ' you can retrieve it from a configuration file using the 
    ' System.Configuration.ConfigurationSettings.AppSettings property. 
    Return "Driver={SQL Server};Server=(local);" & _
      "Database=AdventureWorks;Trusted_Connection=yes;"
  End Function
End Module

Remarques

La méthode TryGetValue permet aux développeurs de récupérer en toute sécurité une valeur à partir d'un OdbcConnectionStringBuilder sans avoir à vérifier que le nom de clé fourni est valide. Étant donné que TryGetValue ne déclenche pas d’exception lorsque vous passez 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

• Builders de chaînes de connexion
• Chaînes de connexion dans ADO.NET