OleDbConnectionStringBuilder.Remove(String) メソッド

定義

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

public:
 override bool Remove(System::String ^ keyword);
public override bool Remove (string keyword);
override this.Remove : string -> bool
Public Overrides Function Remove (keyword As String) As Boolean

パラメーター

keyword
String

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

戻り値

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

例外

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

次の例では、 を OleDbConnectionStringBuilder 作成し、 メソッドの動作を Remove 示します。

using System.Data.OleDb;

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

        Console.WriteLine(builder.ConnectionString);

        // 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.WriteLine("Press Enter to continue.");
        Console.ReadLine();
    }

    static void TryRemove(OleDbConnectionStringBuilder builder,
        string itemToRemove)
    {

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

Module Module1

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

    Console.WriteLine(builder.ConnectionString)
    ' 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 is not 
    ' case sensitive.
    TryRemove(builder, "DATA SOURCE")

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

  Sub TryRemove(ByVal builder As OleDbConnectionStringBuilder, _
      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

End Module

注釈

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

適用対象

こちらもご覧ください