SqlConnectionStringBuilder.TryGetValue(String, Object) Metode

Definisi

Ruang nama:

Microsoft.Data.SqlClient

Rakitan:

Microsoft.Data.SqlClient.dll

Paket:

Microsoft.Data.SqlClient v5.2.0

Mengambil nilai yang sesuai dengan kunci yang disediakan dari ini 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

Parameter

keyword

String

Kunci item yang akan diambil.

value

Object

Nilai yang keywordsesuai dengan .

Mengembalikan

Boolean

true jika keyword ditemukan dalam string koneksi; jika tidak, false.

Pengecualian

ArgumentNullException

keyword berisi nilai null (Nothing dalam Visual Basic).

Contoh

Contoh berikut menunjukkan perilaku metode 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";
    }
}

Sampel menampilkan hasil berikut:

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

Keterangan

Metode ini TryGetValue memungkinkan pengembang mengambil nilai dengan aman dari SqlConnectionStringBuilder tanpa perlu memverifikasi bahwa nama kunci yang disediakan adalah nama kunci yang valid. Karena TryGetValue tidak menimbulkan pengecualian saat Anda memanggilnya, meneruskan kunci yang tidak ada, Anda tidak perlu mencari kunci sebelum mengambil nilainya. Memanggil TryGetValue dengan kunci yang tidak ada akan menempatkan nilai null (Nothing di Visual Basic) dalam value parameter .