DbConnectionStringBuilder.Add メソッド

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

DbConnectionStringBuilder.Add メソッド

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

指定したキーおよび値を持つエントリを DbConnectionStringBuilder に追加します。

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

Visual Basic (宣言)

Public Sub Add ( _
    keyword As String, _
    value As Object _
)

Visual Basic (使用法)

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

instance.Add(keyword, value)

C#

public void Add (
    string keyword,
    Object value
)

C++

public:
void Add (
    String^ keyword, 
    Object^ value
)

J#

public void Add (
    String keyword, 
    Object value
)

JScript

public function Add (
    keyword : String, 
    value : Object
)

パラメータ

keyword

DbConnectionStringBuilder に追加するキー。

value

指定したキーの値。

例外

例外の種類	条件
ArgumentNullException	keyword が null 参照 (Visual Basic の場合は Nothing) です。
NotSupportedException	DbConnectionStringBuilder は読み取り専用です。 または DbConnectionStringBuilder が固定サイズです。

解説

Item プロパティを使用すると、ディクショナリに存在しないキーに対応する値を設定することで、新しい要素を追加することもできます。たとえば、myCollection["myNonexistentKey"] = myValue のように使用します。

null (Visual Basic では Nothing) キーを渡して Add メソッドを呼び出すと、ArgumentNullException がスローされます。一方、null 値を渡して Add メソッドを呼び出すと、キー/値ペアが削除されます。

使用例

新しい DbConnectionStringBuilder を作成してアイテムを追加する例を次に示します。このコードでは Add メソッドを使用して既存のアイテムを上書きします。また、ArgumentNullException をスローするブロックがコメント付きで含まれています。

メモ
この例には、DbConnectionStringBuilder と接続文字列がどのように連携するかを示すパスワードが含まれています。アプリケーションでは、Windows 認証の使用をお勧めします。パスワードを使用する必要がある場合は、ハードコーディングされたパスワードをアプリケーションに組み込まないでください。

Visual Basic

Sub Main()
    Try
        Dim builder As New
 DbConnectionStringBuilder
        builder.Add("Data Source", "ServerName")
        builder.Add("Initial Catalog", "TheDatabase")
        builder.Add("User ID", "UserName")
        builder.Add("Password", "*******")
        builder.Add("Command Logging", False)

        ' Overwrite the existing "User ID" value.
        builder.Add("User ID", "NewUserName")

        ' The following code would trigger 
        ' an ArgumentNullException.
        ' builder.Add(Nothing, "Some Value")

        Console.WriteLine(builder.ConnectionString)

    Catch ex As ArgumentNullException
        Console.WriteLine("Null key values are not allowed.")
    End Try

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

C#

static void Main()
{
    try
    {
        DbConnectionStringBuilder builder =
            new DbConnectionStringBuilder();
        builder.Add("Data Source", "ServerName");
        builder.Add("Initial Catalog", "TheDatabase");
        builder.Add("User ID", "UserName");
        builder.Add("Password", "*******");
        builder.Add("Command Logging", false);

        // Overwrite the existing "User ID" value.
        builder.Add("User ID", "NewUserName");

        // The following code would trigger 
        // an ArgumentNullException:
        // builder.Add(null, "Some Value");

        Console.WriteLine(builder.ConnectionString);
    }
    catch (ArgumentNullException)
    {
        Console.WriteLine("Null key values are not allowed.");
    }

    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 名前空間
その他の技術情報
接続文字列の使用