OleDbConnectionStringBuilder.TryGetValue メソッド

.NET Framework クラス ライブラリ リファレンス

OleDbConnectionStringBuilder.TryGetValue メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

指定されたキーに対応する値を OleDbConnectionStringBuilder のインスタンスから取得します。

名前空間: System.Data.OleDb
アセンブリ: System.Data (system.data.dll 内)
構文

Visual Basic (宣言)

Public Overrides Function
 TryGetValue ( _
    keyword As String, _
    <OutAttribute> ByRef value As Object
 _
) As Boolean

Visual Basic (使用法)

Dim instance As OleDbConnectionStringBuilder
Dim keyword As String
Dim value As Object
Dim returnValue As Boolean

returnValue = instance.TryGetValue(keyword, value)

C#

public override bool TryGetValue (
    string keyword,
    out Object value
)

C++

public:
virtual bool TryGetValue (
    String^ keyword, 
    [OutAttribute] Object^% value
) override

J#

public boolean TryGetValue (
    String keyword, 
    /** @attribute OutAttribute() */ /** @ref */ Object value
)

JScript

JScript では、値型の引数は参照渡しされません。

パラメータ

keyword

取得する項目のキー。

value

keyword に対応する値。

戻り値
keyword が接続文字列に存在する場合は true。それ以外の場合は false。

例外

例外の種類	条件
ArgumentNullException	keyword に null 値 (Visual Basic の場合は Nothing) が含まれています。

解説

TryGetValue メソッドを使用すると、有効なキー名が指定されているかどうかを検証しなくても、OleDbConnectionStringBuilder から値を安全に取得できます。TryGetValue では、呼び出し時に、存在しないキーが指定されても例外は発生しないため、対応する値を取得する前にキーを検索する必要はありません。存在しないキーで TryGetValue を呼び出すと、value パラメータには null 値 (Visual Basic の場合は Nothing) が設定されます。

使用例

TryGetValue メソッドの動作を示す例を次に示します。

Visual Basic

Imports System.Data.OleDb    

Module Module1
  Sub Main()
    Dim builder As New OleDbConnectionStringBuilder
    builder.ConnectionString = GetConnectionString()

    ' Call TryGetValue method for multiple
    ' key names. 
    DisplayValue(builder, "Data Source")
    DisplayValue(builder, "Extended Properties")
    ' How about implicitly added key/value pairs?
    DisplayValue(builder, "Jet OLEDB:System database")
    ' 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 OleDbConnectionStringBuilder,
 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 "Provider=Microsoft.Jet.OLEDB.4.0;"
 & _
      "Data Source=C:\ExcelDemo.xls;" & _
      "Extended Properties=""Excel
 8.0;HDR=Yes;IMEX=1"""
  End Function
End Module

C#

using System.Data.OleDb;

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

        // Call TryGetValue method for multiple
        // key names. 
        DisplayValue(builder, "Data Source");
        DisplayValue(builder, "Extended Properties");
        // How about implicitly added key/value pairs?
        DisplayValue(builder, "Jet OLEDB:System database");
        // Invalid keys?
        DisplayValue(builder, "Invalid Key");
        // Null values?
        DisplayValue(builder, null);

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

    static private void
 DisplayValue(OleDbConnectionStringBuilder 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)
        {
            Console.WriteLine("Unable to retrieve value for
 null key.");
        }
    }

    static private 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 "Provider=Microsoft.Jet.OLEDB.4.0;" +
            "Data Source=C:\\ExcelDemo.xls;" +
            "Extended Properties=\"Excel 8.0;HDR=Yes;IMEX=1\"";
    }
}

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
OleDbConnectionStringBuilder クラス
OleDbConnectionStringBuilder メンバ
System.Data.OleDb 名前空間
その他の技術情報
Building Connection Strings
接続文字列の使用