DbConnectionStringBuilder.Remove(String) メソッド

定義

名前空間:

System.Data.Common

アセンブリ:

System.Data.Common.dll

ソース:

DbConnectionStringBuilder.cs

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

public:
 virtual bool Remove(System::String ^ keyword);

public virtual bool Remove (string keyword);

abstract member Remove : string -> bool
override this.Remove : string -> bool

Public Overridable Function Remove (keyword As String) As Boolean

パラメーター

keyword

String

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

戻り値

Boolean

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

例外

ArgumentNullException

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

NotSupportedException

DbConnectionStringBuilder が読み取り専用であるか、DbConnectionStringBuilder が固定サイズです。

例

static void Main()
{
    DbConnectionStringBuilder builder = new
        DbConnectionStringBuilder();
    builder.ConnectionString =
        @"Provider=Microsoft.Jet.OLEDB.4.0;Data
            Source=C:\Demo.mdb;" +
        "Jet OLEDB:System Database=system.mdw;";

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

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

    // Try to remove an existing item,
    // demonstrating that the search isn't
    // case sensitive.
    TryRemove(builder, "DATA SOURCE");
    Console.ReadLine();
}

static void TryRemove(DbConnectionStringBuilder builder, string itemToRemove)
{
    if (builder.Remove(itemToRemove))
    {
        Console.WriteLine(@"Removed '{0}'", itemToRemove);
    }
    else
    {
        Console.WriteLine(@"Unable to remove '{0}'", itemToRemove);
    }
    Console.WriteLine(builder.ConnectionString);
}

Sub Main()
    Dim builder As New DbConnectionStringBuilder
    builder.ConnectionString = _
        "Provider=Microsoft.Jet.OLEDB.4.0;Data Source=C:\Demo.mdb;" & _
        "Jet OLEDB:System Database=system.mdw;"

    ' Try to remove an existing item.
    TryRemove(builder, "Provider")

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

    ' Try to remove an existing item, 
    ' demonstrating that the search isn't 
    ' case sensitive.
    TryRemove(builder, "DATA SOURCE")
    Console.ReadLine()
End Sub

Sub TryRemove(ByVal builder As DbConnectionStringBuilder, _
    ByVal itemToRemove As String)

    If builder.Remove(itemToRemove) Then
        Console.WriteLine("Removed '{0}'", itemToRemove)
    Else
        Console.WriteLine("Unable to remove '{0}'", itemToRemove)
    End If
    Console.WriteLine(builder.ConnectionString)
End Sub

このサンプルでは、次の出力が表示されます。

Removed 'Provider'
data source=C:\Demo.mdb;jet oledb:system database=system.mdw
Unable to remove 'User ID'
data source=C:\Demo.mdb;jet oledb:system database=system.mdw
Removed 'DATA SOURCE'
jet oledb:system database=system.mdw

注釈

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

こちらもご覧ください

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