SqlConnectionStringBuilder.Remove メソッド

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

SqlConnectionStringBuilder.Remove メソッド

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

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

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

Visual Basic (宣言)

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

Visual Basic (使用法)

Dim instance As SqlConnectionStringBuilder
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

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

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

例外

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

解説

Remove メソッドでは、処理が成功したかどうかを示す値が返されます。したがって、キー/値ペアを SqlConnectionStringBuilder のインスタンスから削除する前にキーを検索する必要はありません。SqlConnectionStringBuilder にはキー/値ペアから成る固定サイズのコレクションが保持されるため、Remove メソッドを呼び出しても、キー/値ペアのうち、対象となる値が既定値にリセットされるだけです。

SqlConnectionStringBuilder でサポートされるキーのコレクションは固定的です。そのため、コレクション内のすべての項目には既定値が割り当てられています。これらのキーおよび対応する値 (最初に SqlConnectionStringBuilder を初期化したときの値または Remove メソッドを呼び出した後の値) の一覧を次の表に示します。

キー	既定値
Application Name	".Net SqlClient Data Provider"
Asynchronous Processing	False
AttachDBFilename	空の文字列
Connection Reset	True
Connection Timeout	15
Context Connection	False
Current Language	空の文字列
Data Source	空の文字列
Encrypt	False
Enlist	True
Failover Partner	空の文字列
Initial Catalog	空の文字列
Integrated Security	False
Load Balance Timeout	0
Max Pool Size	100
Min Pool Size	0
MultipleActiveResultSets	False
Network Library	空の文字列
Packet Size	8000
Password	空の文字列
Persist Security Info	False
Pooling	True
Replication	False
User ID	空の文字列
User Instance	False
Workstation ID	空の文字列

使用例

次の例では、Windows 認証を使用した既存の接続文字列を統合セキュリティ用に変換しています。この例では、ユーザー名とパスワードを接続文字列から削除し、SqlConnectionStringBuilder オブジェクトの IntegratedSecurity プロパティを設定することによってこれを実現しています。

メモ
この例には、SqlConnectionStringBuilder と接続文字列がどのように連携するかを示すパスワードが含まれています。アプリケーションでは、Windows 認証の使用をお勧めします。パスワードを使用する必要がある場合は、ハードコーディングされたパスワードをアプリケーションに組み込まないでください。

Visual Basic

Imports System.Data.SqlClient
    
Module Module1
  Sub Main()
    Try
      Dim connectString As String
 = _
       "Data Source=(local);User ID=ab;Password=a1Pass@@11;"
 & _
       "Initial Catalog=AdventureWorks"

      Dim builder As New
 SqlConnectionStringBuilder(connectString)
      Console.WriteLine("Original: " & builder.ConnectionString)

      ' Use the Remove method
      ' in order to reset the user ID and password back to their
      ' default (empty string) values.
      builder.Remove("User ID")
      builder.Remove("Password")

      ' Turn on integrated security:
      builder.IntegratedSecurity = True

      Console.WriteLine("Modified: " & builder.ConnectionString)

      Using connection As New SqlConnection(builder.ConnectionString)
        connection.Open()
        ' Now use the open connection.
        Console.WriteLine("Database = " & connection.Database)
      End Using

    Catch ex As Exception
      Console.WriteLine(ex.Message)
    End Try

    Console.WriteLine("Press any key to finish.")
    Console.ReadLine()
  End Sub
End Module

C#

using System.Data.SqlClient;

class Program
{
    static void Main()
    {
        try
        {
            string connectString =
                "Data Source=(local);User ID=ab;Password= a1Pass@@11;"
 +
                "Initial Catalog=AdventureWorks";

            SqlConnectionStringBuilder builder = new SqlConnectionStringBuilder(connectString);
            Console.WriteLine("Original: " + builder.ConnectionString);

            // Use the Remove method
            // in order to reset the user ID and password back to their
            // default (empty string) values. 
            builder.Remove("User ID");
            builder.Remove("Password");

            // Turn on integrated security:
            builder.IntegratedSecurity = true;

            Console.WriteLine("Modified: " + builder.ConnectionString);

            using (SqlConnection
                       connection = new SqlConnection(builder.ConnectionString))
            {
                connection.Open();
                // Now use the open connection.
                Console.WriteLine("Database = " + connection.Database);
            }
        }
        catch (Exception ex)
        {
            Console.WriteLine(ex.Message);
        }

        Console.WriteLine("Press any key to finish.");
        Console.ReadLine();
    }
}

この例では、コンソール ウィンドウに次のテキストが表示されます。

Original: Data Source=(local);Initial Catalog=AdventureWorks;User ID=ab;Password=
 a1Pass@@11
Modified: Data Source=(local);Initial Catalog=AdventureWorks;Integrated Security=True
Database = AdventureWorks

プラットフォーム

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

参照

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