SqlConnectionStringBuilder.Remove(String) 方法

定義

命名空間:

Microsoft.Data.SqlClient

組件:

Microsoft.Data.SqlClient.dll

套件:

Microsoft.Data.SqlClient v5.2.0

從 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)。

範例

下列範例會轉換現有的連接字串，將其從使用 Windows 驗證轉換成使用整合式安全性。 此範例運作的方式是從連接字串中移除使用者名稱和密碼，然後設定 IntegratedSecurity 物件的 SqlConnectionStringBuilder 屬性。

注意

這個範例包含了密碼，可示範 SqlConnectionStringBuilder 如何搭配連接字串使用。 我們建議在您的應用程式中使用 Windows 驗證。 如果您必須使用密碼，請勿在您的應用程式中包含硬式編碼的密碼。

using Microsoft.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  

備註

由於 Remove 方法會傳回指出其成功的值，因此在嘗試從 SqlConnectionStringBuilder 實例移除索引鍵/值組之前，不需要尋找索引鍵。 因為 SqlConnectionStringBuilder 會維護固定大小的索引鍵/值組集合，所以呼叫 Remove 方法只會將索引鍵/值組的值重設回預設值。

因為 SqlConnectionStringBuilder 支援的索引鍵集合是固定的，所以集合中的每一個項目都有已知的預設值。 下表列出索引鍵，以及當初次初始化 SqlConnectionStringBuilder 或者在呼叫 Remove 方法之後每一個索引鍵的值。

Key	預設值
應用程式名稱	在 .NET Framework 上執行時，「Framework Microsoft SqlClient Data Provider」。 否則為 「核心 Microsoft SqlClient 資料提供者」。
AttachDBFilename	空字串
連接逾時	15
內容連線 (過時)	否
目前的語言	空字串
資料來源	空字串
Encrypt	在 4.0 之前的版本中為 False，在 4.0 版和更新版本中為 True
Enlist	是
Failover Partner	空字串
初始目錄	空字串
整合式安全性	否
Load Balance Timeout	0
Max Pool Size	100
Min Pool Size	0
MultipleActiveResultSets	否
Network Library	空字串
Packet Size	8000
密碼	空字串
保存安全性資訊	否
Pooling	是
複寫	否
Transaction Binding	Implicit Unbind
使用者識別碼	空字串
User Instance	否
工作站 ID	空字串