OdbcConnectionStringBuilder.Remove(String) メソッド

定義

名前空間:

System.Data.Odbc

アセンブリ:

System.Data.Odbc.dll

パッケージ:

System.Data.Odbc v8.0.0

ソース:

OdbcConnectionStringbuilder.cs

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

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

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

戻り値

Boolean

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

例外

ArgumentNullException

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

Imports System.Data.Odbc  
  
Module Module1
  Sub Main()
    Dim builder As 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()
  End Sub

  Sub TryRemove(ByVal builder As OdbcConnectionStringBuilder, _
      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 成功を示す値を返すので、キーと値のペアをインスタンスから削除する前にキーの存在を OdbcConnectionStringBuilder 検索する必要はありません。

こちらもご覧ください

• 接続文字列ビルダー
• ADO.NET での接続文字列