OdbcConnectionStringBuilder.Remove メソッド

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

OdbcConnectionStringBuilder.Remove メソッド

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

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

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

Visual Basic (宣言)

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

Visual Basic (使用法)

Dim instance As OdbcConnectionStringBuilder
Dim keyword As String
Dim returnValue As Boolean

returnValue = instance.Remove(keyword)

C#

public override bool Remove (
    string keyword
)

C++

public:
virtual bool Remove (
    String^ keyword
) override

J#

public boolean Remove (
    String keyword
)

JScript

public override function Remove (
    keyword : String
) : boolean

パラメータ

keyword

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

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

例外

例外の種類	条件
ArgumentNullException	keyword が null (Visual Basic の場合は Nothing) です。

解説

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

使用例

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

Visual Basic

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

C#

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

プラットフォーム

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

参照

関連項目
OdbcConnectionStringBuilder クラス
OdbcConnectionStringBuilder メンバ
System.Data.Odbc 名前空間
その他の技術情報
Building Connection Strings
接続文字列の使用