SqlConnectionStringBuilder::Remove Method (String^)

.NET Framework (current version)

Removes the entry with the specified key from the SqlConnectionStringBuilder instance.

Namespace: System.Data.SqlClient
Assembly: System.Data (in System.Data.dll)

Syntax

public:
virtual bool Remove(
	String^ keyword
) override

Parameters

keyword: Type: System::String^
The key of the key/value pair to be removed from the connection string in this SqlConnectionStringBuilder.

Return Value

Type: System::Boolean

true if the key existed within the connection string and was removed; false if the key did not exist.

Exceptions

Exception	Condition
ArgumentNullException	keyword is null (Nothing in Visual Basic)

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 Remove 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 Remove method has been called.

Key	Default value
Application Name	".Net SqlClient Data Provider"
Asynchronous Processing	False
AttachDBFilename	Empty string
Connection Timeout	15
Context Connection	False
Current Language	Empty string
Data Source	Empty string
Encrypt	False
Enlist	True
Failover Partner	Empty string
Initial Catalog	Empty string
Integrated Security	False
Load Balance Timeout	0
Max Pool Size	100
Min Pool Size	0
MultipleActiveResultSets	False
Network Library	Empty string
Packet Size	8000
Password	Empty string
Persist Security Info	False
Pooling	True
Replication	False
Transaction Binding	Implicit Unbind
User ID	Empty string
User Instance	False
Workstation ID	Empty string

Examples

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.

Note
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.

C++

No code example is currently available or this language may not be supported.

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

Version Information

.NET Framework
Available since 2.0