SqlConnectionStringBuilder.Remove Method (String)
Removes the entry with the specified key from the SqlConnectionStringBuilder instance.
Assembly: System.Data (in System.Data.dll)
Return ValueType: System.Boolean
true if the key existed within the connection string and was removed; false if the key did not exist.
Because the Remove method returns a value that indicates its success, it is not required to look for a key before trying to remove the key/value pair from the SqlConnectionStringBuilder instance. Because the SqlConnectionStringBuilder maintains a fixed-size collection of key/value pairs, calling the method simply resets the value of the key/value pair back to its default value.
Because the collection of keys supported by the SqlConnectionStringBuilder is fixed, every item within the collection has a known default value. The following table lists the keys, and the value for each when the SqlConnectionStringBuilder is first initialized, or after the method has been called.
".Net SqlClient Data Provider"
Load Balance Timeout
Max Pool Size
Min Pool Size
Persist Security Info
The following example converts an existing connection string from using Windows Authentication to using integrated security. The example works by removing the user name and password from the connection string, and then setting the IntegratedSecurity property of the SqlConnectionStringBuilder object.
This example includes a password to demonstrate how SqlConnectionStringBuilder works with connection strings. In your applications, we recommend that you use Windows Authentication. If you must use a password, do not include a hard-coded password in your application.
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
The example displays the following text in the console window:
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
Available since 10
Available since 2.0