SqlConnectionStringBuilder.Remove(String) 方法

定義

命名空間:

System.Data.SqlClient

組件:

System.Data.SqlClient.dll

套件:

System.Data.SqlClient v4.9.0

來源:

System.Data.SqlClient.notsupported.cs

從 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 屬性。

警告

Microsoft不建議直接提供您的使用者名稱和密碼，因為這是不安全的模式。 可能的話，請使用更安全的驗證流程，例如 azure 資源的 受控識別，或 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
密碼	空字串
保存安全性資訊	假
池	真
複製	假
交易系結	隱含解除系結
用戶標識碼	空字串
用戶實例	假
工作站標識碼	空字串

另請參閱

• ADO.NET中的 連接字串
• ADO.NET 概觀