SqlConnectionStringBuilder.TryGetValue(String, Object) Metoda

Definicja

Przestrzeń nazw:

System.Data.SqlClient

Zestaw:

System.Data.dll

Pakiet:

System.Data.SqlClient v4.8.6

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 znaleziono w parametry 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 System.Data.SqlClient;

using System;
using System.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";
    }
}

Imports System.Data.SqlClient
    
Module Module1
    Sub Main()
        Dim builder As 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, Nothing)

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

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

        ' 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
        ' passes 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. 
        Return "Server=(local);Integrated Security=SSPI;" & _
          "Initial Catalog=AdventureWorks"
    End Function
End Module

W przykładzie są wyświetlane 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 .

Zobacz też

• Parametry połączenia w ADO.NET
• Omówienie ADO.NET