SqlConnectionStringBuilder.Item プロパティ

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

SqlConnectionStringBuilder.Item プロパティ

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

指定したキーに関連付けられている値を取得または設定します。C# では、このプロパティはインデクサです。

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

Visual Basic (宣言)

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

Visual Basic (使用法)

Dim instance As SqlConnectionStringBuilder
Dim keyword As String
Dim value As Object

value = instance(keyword)

instance(keyword) = value

C#

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

C++

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

J#

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

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

JScript

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

パラメータ

keyword

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

プロパティ値
指定したキーに関連付けられている値。

例外

例外の種類	条件
ArgumentNullException	keyword が null 参照 (Visual Basic の場合は Nothing) です。
KeyNotFoundException	利用できるキー内に存在しないキーを追加しようとしました。
FormatException	接続文字列中に無効な値が含まれています (特に、ブール値または数値を指定する必要がある箇所で、それらが指定されていない場合)。

解説

SqlConnectionStringBuilder は固定サイズのディクショナリを保持するため、このディクショナリに存在しないキーを追加しようとすると KeyNotFoundException がスローされます。

使用例

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

Visual Basic

Module Module1
    Sub Main()
        Dim builder As New
 SqlConnectionStringBuilder
        builder.Item("Data Source") = "(local)"
        ' Item is the default property, so 
        ' you needn't include it in the reference.
        builder("Integrated Security") = True
        builder.Item("Initial Catalog") = "AdventureWorks"

        ' Overwrite the existing value for the Data Source value.
        builder.Item("Data Source") = "."

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

C#

class Program
{
    static void Main()
    {
        SqlConnectionStringBuilder builder = 
            new SqlConnectionStringBuilder();
        builder["Data Source"] = "(local)";
        builder["Integrated Security"] = true;
        builder["Initial Catalog"] = "AdventureWorks";

        // Overwrite the existing value for the Data Source value.
        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

参照

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