SqlConnectionStringBuilder.Item[String] プロパティ

定義

名前空間:

System.Data.SqlClient

アセンブリ:

System.Data.dll

パッケージ:

System.Data.SqlClient v4.8.6

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

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

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

member this.Item(string) : obj with get, set

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

パラメーター

keyword

String

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

プロパティ値

Object

指定されたキーに関連付けられている値。

例外

ArgumentNullException

keyword が null 参照 (Visual Basic の場合は Nothing) です。

KeyNotFoundException

利用可能なキーの一覧に存在しないキーを追加しようとしました。

FormatException

接続文字列内に無効な値が含まれています (具体的には、ブール値または数値が要求されているにもかかわらず適切な値が提供されませんでした)。

例

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

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();
    }
}

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

注釈

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

こちらもご覧ください

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