Clara-Doc - Method Reference
CTMAPX_IterNextSize
Description
Returns the size in bytes of the next available item within an iteration loop.
Prototype
DCTMAPX_IterNextSize...
D PR 10I 0
D@This * Value
D@KeySize 10I 0
D@ValueSize 10I 0
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. |
@KeySize
| Type | 10I 0 |
| Passing Mode | Value |
| Description | This is just an OUT parameter. On return, this parameter will hold the item's key size. |
@ValueSize
| Type | 10I 0 |
| Passing Mode | Value |
| Description | This is only an OUT parameter. On return, this paramter will hold the actual size in bytes of the next available item. |
Return Values
| Symbolic Constant | Value | Description |
| CS_SUCCESS | 0 | There is a next available item and its key size and value size have been returned in the supplied parameters.in the @ |
| CS_FAILURE | 1 | We are at the end of the list and there is no next item. Don't rely on the returned parameter values being set to zero in order to determine that there is no next item. The map allows for zero size items. |