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

定義

名前空間:
System.Data.Common
アセンブリ:
System.Data.Common.dll
アセンブリ:
System.Data.dll
アセンブリ:
netstandard.dll

この 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 = "..."

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

適用対象

こちらもご覧ください