SqlConnectionStringBuilder.Remove(String) メソッド

定義

名前空間:

System.Data.SqlClient

アセンブリ:

System.Data.dll

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

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

この SqlConnectionStringBuilderの接続文字列から削除するキーと値のペアのキー。

戻り値

Boolean

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

例外

ArgumentNullException

keyword が null (Visual Basic のNothing) です

例

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

警告

セキュリティで保護されていないパターンであるため、ユーザー名とパスワードを直接指定することはお勧めしません。 可能な場合は、Azure リソースのマネージド ID の 、SQL Server の Windows 認証 など、より安全な認証フローを使用します。

using System.Data.SqlClient;

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

            SqlConnectionStringBuilder builder = new(connectString);
            Console.WriteLine($"Original: {builder.ConnectionString}");

            // Remove the User ID and Password.
            builder.Remove("User ID");
            builder.Remove("Password");

            // Enable integrated security.
            builder.IntegratedSecurity = true;

            Console.WriteLine($"Modified: {builder.ConnectionString}");
        }
        catch (Exception ex)
        {
            Console.WriteLine(ex.Message);
        }
    }
}
/* This code example produces the following output:
 * Original: Data Source=(local);Initial Catalog=AdventureWorks;User ID=ab;Password=myPassw0rd
 * Modified: Data Source=(local);Initial Catalog=AdventureWorks;Integrated Security=True
 */

    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)

    ' Remove the user ID and password.
    builder.Remove("User ID")
    builder.Remove("Password")

    ' Turn on integrated security:
    builder.IntegratedSecurity = True

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

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

' This code produces the following output:
' Original: Data Source=(local);Initial Catalog=AdventureWorks;User ID=ab;Password=a1Pass@@11
' Modified: Data Source = (local);Initial Catalog=AdventureWorks;Integrated Security=True

注釈

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

SqlConnectionStringBuilder でサポートされるキーのコレクションは固定されているため、コレクション内のすべての項目に既知の既定値があります。 次の表に、SqlConnectionStringBuilder が最初に初期化されたとき、または Remove メソッドが呼び出された後の各キーと値を示します。

鍵	既定値
アプリケーション名	".Net SqlClient データ プロバイダー"
非同期処理	偽
AttachDBFilename	空の文字列
接続タイムアウト	15
コンテキスト接続	偽
現在の言語	空の文字列
データ ソース	空の文字列
暗号化する	偽
参加	真
フェールオーバー パートナー	空の文字列
初期カタログ	空の文字列
統合セキュリティ	偽
負荷分散のタイムアウト	0
最大プール サイズ	100
最小プール サイズ	0
MultipleActiveResultSets	偽
ネットワーク ライブラリ	空の文字列
パケット サイズ	8000
パスワード	空の文字列
セキュリティ情報を保持する	偽
プーリング	真
複製	偽
トランザクション バインド	暗黙的なバインド解除
ユーザー ID	空の文字列
ユーザー インスタンス	偽
ワークステーション ID	空の文字列

こちらもご覧ください

• ADO.NETで接続文字列を する
• ADO.NET の概要