Clara-Doc - Method Reference
CTMAPX_Remove
Description
Removes a map item besed on its key value.
Prototype
DCTMAPX_Remove...
D PR 10I 0
D@This * Value
D@Key * Value
Parameters
@This
| Type | Pointer (*) |
| Passing Mode | Value |
| Description | The address of a CTMAPX instance. This pointer MUST be obtained through a call to CMAPX_Constructor. |
@Key
| Type | Pointer (*) |
| Passing Mode | Value |
| Description | The address of a the caller-supplied buffer that contains the key value associated with the map item. The key value must be a NULL-terminated character string. |
Return Values
| Symbolic Constant | Value | Description |
| CS_SUCCESS | 0 | The item has been removed successfully. If the item was not found, the method still returns CT_SUCCESS. |