DbConnectionStringBuilder.TryGetValue(String, Object) メソッド

定義

名前空間:

System.Data.Common

アセンブリ:

System.Data.Common.dll

ソース:

DbConnectionStringBuilder.cs

提供されたキーに対応する値をこの 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

パラメーター

keyword

String

取得する項目のキー。

value

Object

keyword に対応する値。

戻り値

Boolean

keyword が接続文字列内で見つかった場合は true。それ以外の場合は false。

例外

ArgumentNullException

keyword に null 値 (Visual Basic の場合は Nothing) が含まれています。

例

次の例では、 メソッドを TryGetValue 呼び出し、考えられるいくつかの結果を示します。

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

このサンプルを実行すると、次の結果が表示されます。

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

注釈

メソッドを使用すると、開発者は TryGetValue 、最初に メソッドを呼び出すことなく、 から DbConnectionStringBuilder 値を安全に ContainsKey 取得できます。 TryGetValueを呼び出しても例外が発生しないため、存在しないキーを渡すと、その値を取得する前にキーを探す必要はありません。 存在しないキーを使用して を呼び出 TryGetValue すと、 パラメーターに null 値 (Nothing Visual Basic では) が value 配置されます。

こちらもご覧ください

• ADO.NET での接続文字列
• ADO.NET の概要