System.Data.SqlClient.SqlConnectionStringBuilder.Remove Method

Removes the entry with the specified key from the System.Data.SqlClient.SqlConnectionStringBuilder instance.

Syntax

public override bool Remove (string keyword)

Parameters

keyword
The key of the key/value pair to be removed from the connection string in this System.Data.SqlClient.SqlConnectionStringBuilder.

Returns

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

Remarks

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 System.Data.SqlClient.SqlConnectionStringBuilder instance. Because the System.Data.SqlClient.SqlConnectionStringBuilder maintains a fixed-size collection of key/value pairs, calling the SqlConnectionStringBuilder.Remove(string) method simply resets the value of the key/value pair back to its default value.

Because the collection of keys supported by the System.Data.SqlClient.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 System.Data.SqlClient.SqlConnectionStringBuilder is first initialized, or after the SqlConnectionStringBuilder.Remove(string) method has been called.

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

Requirements

Namespace: System.Data.SqlClient
Assembly: System.Data (in System.Data.dll)
Assembly Versions: 2.0.0.0
Since: .NET 2.0