This documentation is archived and is not being maintained.

DbConnectionStringBuilder.Remove Method

Note: This method is new in the .NET Framework version 2.0.

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

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

public:
virtual bool Remove (
	String^ keyword
)
public boolean Remove (
	String keyword
)
public function Remove (
	keyword : String
) : boolean

Parameters

keyword

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

Return Value

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

Exception typeCondition

ArgumentNullException

keyword is null (Nothing in Visual Basic)

NotSupportedException

The DbConnectionStringBuilder is read-only, or the DbConnectionStringBuilder has a fixed size.

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.

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

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0
Show: