Remove Method (VistaDBConnectionStringBuilder)

In This Topic

Removes the entry with the specified key from the System.Data.Common.DbConnectionStringBuilder instance. Removes the entry with the specified key from the VistaDBConnectionStringBuilder instance.

Syntax

Visual Basic
C#

'Declaration
 
Public Overrides NotOverridable Function Remove( _
   ByVal keyword As System.String _
) As System.Boolean

'Usage
 
Dim instance As VistaDBConnectionStringBuilder
Dim keyword As System.String
Dim value As System.Boolean
 
value = instance.Remove(keyword)

public override System.bool Remove( 
   System.string keyword
)

Parameters

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

Return Value

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

Exceptions

Exception	Description
System.ArgumentNullException	keyword is null (Nothing in Visual Basic)
System.NotSupportedException	The System.Data.Common.DbConnectionStringBuilder is read-only, or the System.Data.Common.DbConnectionStringBuilder has a fixed size.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

VistaDBConnectionStringBuilder Class
VistaDBConnectionStringBuilder Members

Send Feedback