DbConnectionStringBuilder.Item プロパティ

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

DbConnectionStringBuilder.Item プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

指定したキーに関連付けられている値を取得または設定します。

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

Visual Basic (宣言)

Public Overridable Default
 Property Item ( _
    keyword As String _
) As Object

Visual Basic (使用法)

Dim instance As DbConnectionStringBuilder
Dim keyword As String
Dim value As Object

value = instance(keyword)

instance(keyword) = value

C#

public virtual Object this [
    string keyword
] { get; set; }

C++

public:
virtual property Object^ default [String^] {
    Object^ get (String^ keyword);
    void set (String^ keyword, Object^ value);
}

J#

/** @property */
public Object get_Item (String keyword)

/** @property */
public void set_Item (String keyword, Object
 value)

JScript

JScript では、インデックス付きのプロパティは使用できますが、新規に宣言することはできません。.

パラメータ

keyword

取得または設定する項目のキー。

プロパティ値
指定したキーに関連付けられている値。指定したキーが見つからない場合、そのキーを取得しようとした場合は null 参照 (Visual Basic では Nothing) が返され、そのキーを設定しようとした場合は、指定したキーを使用して新しい要素が作成されます。 null (Visual Basic では Nothing) キーを渡すと、ArgumentNullException がスローされます。null 値を割り当てると、キー/値ペアが削除されます。

例外

例外の種類	条件
ArgumentNullException	keyword が null 参照 (Visual Basic の場合は Nothing) です。
NotSupportedException	このプロパティが設定されていますが、DbConnectionStringBuilder が読み取り専用です。 または このプロパティが設定されていますが、keyword がコレクション内に存在しません。また、DbConnectionStringBuilder が固定サイズです。

解説

このプロパティを設定すると、指定したキーがディクショナリに既に存在する場合は、その値が置換されます。それ以外の場合は、新しい要素が作成されます。

使用例

次のコンソール アプリケーションでは、新しい DbConnectionStringBuilder を作成し、Item プロパティを使用してキー/値ペアを接続文字列に追加しています。

Visual Basic

Module Module1

    Sub Main()
        Dim builder As New
 DbConnectionStringBuilder
        builder.Item("Data Source") = "(local)"

        ' Item is the default property, so 
        ' you need not include it in the reference.
        builder("integrated security") = True
        builder.Item("Initial Catalog") = "AdventureWorks"

        ' Overwrite the existing value for the data source value, 
        ' because it already exists within the collection.
        builder.Item("Data Source") = "."

        Console.WriteLine(builder.ConnectionString)
        Console.WriteLine()
        Console.WriteLine("Press Enter to continue.")
        Console.ReadLine()
    End Sub

C#

static void Main()
{
    DbConnectionStringBuilder builder = new
        DbConnectionStringBuilder();
    builder["Data Source"] = "(local)";

    // Note that Item is the indexer, so 
    // you do not include it in the reference.
    builder["integrated security"] = true;
    builder["Initial Catalog"] = "AdventureWorks";

    // Overwrite the existing value for the Data Source key, 
    // because it already exists within the collection.
    builder["Data Source"] = ".";

    Console.WriteLine(builder.ConnectionString);
    Console.WriteLine();
    Console.WriteLine("Press Enter to continue.");
    Console.ReadLine();
}

プラットフォーム

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

参照

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