OdbcConnectionStringBuilder.Remove(String) メソッド

定義

指定されたキーを持つエントリを OdbcConnectionStringBuilder インスタンスから削除します。

public override bool Remove (string keyword);

パラメーター

keyword
String

この OdbcConnectionStringBuilder 内の接続文字列から削除するキー/値ペアのキー。

戻り値

キーが接続文字列内に存在していて削除された場合は true、キーが存在しなかった場合は false

例外

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

次の例では、 インスタンスを OdbcConnectionStringBuilder 作成し、 メソッドの動作を Remove 示します。

using System.Data.Odbc;

class Program
{
    static void Main()
    {
        OdbcConnectionStringBuilder builder =
            new OdbcConnectionStringBuilder();
        builder.ConnectionString =
            "Driver={SQL Server};Server=(local);" +
            "Database=AdventureWorks;Trusted_Connection=yes;";

        Console.WriteLine(builder.ConnectionString);

        // Try to remove an existing item.
        TryRemove(builder, "Server");

        // Try to remove a nonexistent item.
        TryRemove(builder, "User ID");

        // Try to remove an existing item,
        // demonstrating that the search is not
        // case sensitive.
        TryRemove(builder, "DATABASE");

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

    static void TryRemove(OdbcConnectionStringBuilder builder,
        string itemToRemove)
    {

        if (builder.Remove(itemToRemove))
        {
            Console.WriteLine("Removed '{0}'", itemToRemove);
        }
        else
        {
            Console.WriteLine("Unable to remove '{0}'", itemToRemove);
        }
        Console.WriteLine(builder.ConnectionString);
    }
}

注釈

メソッドは Remove 成功を示す値を返すので、キーと値のペアをインスタンスから削除する前にキーの存在を OdbcConnectionStringBuilder 検索する必要はありません。

適用対象

製品 バージョン
.NET 8 (package-provided), 9 (package-provided)
.NET Framework 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7 (package-provided), 4.7, 4.7.1 (package-provided), 4.7.1, 4.7.2 (package-provided), 4.7.2, 4.8 (package-provided), 4.8, 4.8.1
.NET Standard 2.0 (package-provided)

こちらもご覧ください