This topic has not yet been rated - Rate this topic

DbConnectionStringBuilder.Remove Method

.NET Framework 4.5

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

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

abstract Remove : 
        keyword:string -> bool  
override Remove : 
        keyword:string -> bool

Parameters

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

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)
NotSupportedException	The DbConnectionStringBuilder is read-only, or the DbConnectionStringBuilder has a fixed size.

Remarks

Because the Remove method returns a value that indicates its success, it is not required to look for the key before trying to remove the key/value pair from the DbConnectionStringBuilder instance.

Examples

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

This sample displays the following output:

Removed 'Provider'
data source=C:\Demo.mdb;jet oledb:system database=system.mdw
Unable to remove 'User ID'
data source=C:\Demo.mdb;jet oledb:system database=system.mdw
Removed 'DATA SOURCE'
jet oledb:system database=system.mdw

Version Information

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Platforms

Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Reference

DbConnectionStringBuilder Class

System.Data.Common Namespace

Other Resources

Connection Strings (ADO.NET)

ADO.NET Managed Providers and DataSet Developer Center

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)