Clara-Doc - Method Reference
CTMAPX_Insert
Description
Inserts an item in the map.
Prototype
DCTMAPX_Insert...
D PR 10I 0
D@This * Value
D@Key * Value
D@Value * Value
D@ValueSize 10I 0 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 kiey value has to be a NULL-terminated character string. If using a VarChar for the key, care must be taken to insure that the address actually points to the data portion. |
@Value
| Type | Pointer (*) |
| Passing Mode | Value |
| Description | The address of a caller-supplied buffer. Don't use a CTBUFF instance. This buffer can be a local variable or a buffer allocated with a call to %Alloc. |
@ValueSize
| Type | 10I 0 |
| Passing Mode | Value |
| Description | The size in bytes of the @Value parameter. |
Return Values
| Symbolic Constant | Value | Description |
| CS_SUCCESS | 0 | The item has been inserted in the map successfully. |
| CS_FAILURE | 1 | The item could not be inserted. This could be because the key is *null or the key size is zero. |