Clara-Doc - Method Reference
CTMAPX_BInsert
Description
Inserts a value from a CTBUFF instance.
Prototype
DCTMAPX_BInsert...
D PR 10I 0
D@This * Value
D@Key * Value
D@Buffer * 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 string. |
@Buffer
| Type | Pointer (*) |
| Passing Mode | Value |
| Description | The address of a caller-supplied CTBUFF instance. This instance MUST be allocated with a call to CTBUFF_Constructor. |
Return Values
| Symbolic Constant | Value | Description |
| CS_SUCCESS | 0 | The item has been inserted successfully. |
| CS_FAILURE | 1 | The item could not be inserted. Either the @Key parameter is *null or the key size is zero. |