Clara-Doc - Method Reference
CTMAPX_BIterNext
Description
Retrieves the next available map item in keyed order within an iteration loop.
Prototype
DCTMAPX_BIterNext...
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 will receive a copy of the key value associated with the returned map item. |
@KeySize
| Type | 10I 0 |
| Passing Mode | Reference |
| Description | This is just an OUT parameter. On return, this parameter will hold the item's key size. This happens to be the nmber of bytes copied into the @Key parameter. |
@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 next map item has been returned successfully in the CTBUFF instance. |
| CS_FAILURE | 1 | We are at the end of the list. Another possibility is that the key size is smaller than the actual item key size. The @KeySize parameter will hold the actual key size on return. |