DbConnectionStringBuilder.Add(String, Object) メソッド

  • リファレンス

定義

名前空間:
System.Data.Common
アセンブリ:
System.Data.Common.dll
アセンブリ:
System.Data.dll
アセンブリ:
netstandard.dll
ソース:
DbConnectionStringBuilder.cs
ソース:
DbConnectionStringBuilder.cs
ソース:
DbConnectionStringBuilder.cs

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

public:
 void Add(System::String ^ keyword, System::Object ^ value);
public void Add (string keyword, object value);
member this.Add : string * obj -> unit
Public Sub Add (keyword As String, value As Object)

パラメーター

keyword
String

DbConnectionStringBuilder に追加するキー。

value
Object

指定したキーの値。

例外

ArgumentNullException

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

NotSupportedException

DbConnectionStringBuilder は読み取り専用です。

- または -

DbConnectionStringBuilder は固定サイズです。

例

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

注意

この例には、DbConnectionStringBuilder による接続文字列の操作方法を示すために、パスワードが含まれています。 実際のアプリケーションでは、Windows 認証を使用することをお勧めします。 パスワードを使用する必要がある場合も、ハードコードされたパスワードをアプリケーションに含めないでください。

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

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

注釈

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

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

適用対象

こちらもご覧ください