OracleConnectionStringBuilder.Remove(String) Method

Definition

Namespace:

System.Data.OracleClient

Assembly:

System.Data.OracleClient.dll

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

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

Parameters

keyword

String

The key of the key/value pair to be removed from the connection string in this OracleConnectionStringBuilder.

Returns

Boolean

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

Exceptions

ArgumentNullException

keyword is null (Nothing in Visual Basic).

Remarks

The Remove method returns a value that indicates its success, so it's not necessary to look for the existence of a key before trying to remove the key/value pair from the OracleConnectionStringBuilder instance. Calling the Remove method just resets the value of the key/value pair back to its default value. That's because the OracleConnectionStringBuilder maintains a fixed-size collection of key/value pairs

The collection of keys supported by the OracleConnectionStringBuilder is fixed, so every item within the collection has a known default value.

The following table lists the keys, and the value for each when the OracleConnectionStringBuilder is first initialized, or after the Remove method has been called.

Key	Default value
Data Source	Empty string
Persist Security Info	False
Integrated Security	False
User ID	Empty string
Password	Empty string
Enlist	True
Pooling	True
Min Pool Size	0
Max Pool Size	100
Unicode	False
Load Balance Timeout	0
Omit Oracle Connection Name	False

See also

• Building Connection Strings