DeleteConnectionId - cConnection
Removes a registered connection for a passed Connection ID
Type: Procedure
Parameters
| Parameter | Type | Description |
|---|---|---|
| sId | String | Connection ID |
Syntax
Procedure DeleteConnectionId String sId
Call Example
Send DeleteConnectionId sId
Description
This removes a registered connection for a passed Connection ID parameter.
If this Connection Id is not currently logged in, this will log out the connection and close any tables opened under the connection.
If this Connection Id is currently logged in, an error will be raised instead. Precede this call by calling LogoutConnectionId. This is not done automatically, so it is clear to the developer that they are logging out of existing connections, which closes open tables.
The UnRegisterAllConnections procedure can be used to do this for all connections.