Sphinx QLConnection String BuilderRemove Method
Removes the entry with the specified key from the SphinxQLConnectionStringBuilder instance.
Definition
Namespace: SphinxConnector.SphinxQL
Assembly: SphinxConnector (in SphinxConnector.dll) Version: 6.1.0
true if the key existed within the connection string and was removed; false if the key did not exist.
Assembly: SphinxConnector (in SphinxConnector.dll) Version: 6.1.0
C#
public override bool Remove(
string keyword
)VB
Public Overrides Function Remove (
keyword As String
) As BooleanParameters
- keyword String
- The key of the key/value pair to be removed from the connection string in this SphinxQLConnectionStringBuilder.
Return Value
Booleantrue 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) |
| NotSupportedException | The SphinxQLConnectionStringBuilder is read-only, or the SphinxQLConnectionStringBuilder has a fixed size. |