Clara-Doc - Method Reference
CTLST_IterStart
Description
Starts an iteration loop over all items in the list. Calling CTLST_IterNext after calling this method will return the first item in the list.
Prototype
DCTLST_IterStart...
D PR 10I 0
D@This * Value
Parameters
@This
| Type | Pointer (*) |
| Passing Mode | Value |
| Description | The address of a linked list instance. This pointer MUST be obtained through a call to CTLST_Constructor. |
Return Values
| Symbolic Constant | Value | Description |
| CS_SUCCESS | 0 | The next item to be read in an iteration loop will be the first item in the list. This means the list has at least one item. |
| CS_FAILURE | 1 | The list is empty. The list cannot be read from. |