DbConnectionStringBuilder.Remove メソッド

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

DbConnectionStringBuilder.Remove メソッド

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

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

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

Visual Basic (宣言)

Public Overridable Function
 Remove ( _
    keyword As String _
) As Boolean

Visual Basic (使用法)

Dim instance As DbConnectionStringBuilder
Dim keyword As String
Dim returnValue As Boolean

returnValue = instance.Remove(keyword)

C#

public virtual bool Remove (
    string keyword
)

C++

public:
virtual bool Remove (
    String^ keyword
)

J#

public boolean Remove (
    String keyword
)

JScript

public function Remove (
    keyword : String
) : boolean

パラメータ

keyword

この DbConnectionStringBuilder の接続文字列から取り除く、キー/値ペアに対するキー。

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

例外

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

解説

Remove メソッドでは、処理が成功したかどうかを示す値が返されます。したがって、キー/値ペアを DbConnectionStringBuilder のインスタンスから削除する前にキーを検索する必要はありません。

使用例

Visual Basic

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

C#

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

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

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

プラットフォーム

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