Clara-Doc - Method Reference
CTLST_IterNext
Description
Returns the next available lsit item in an iteration loop.
Prototype
DCTLST_IterNext...
D PR 10I 0
D@This * Value
D@Value * Value
D@Bytes 10I 0
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. |
@Value
| Type | Pointer (*) |
| Passing Mode | Value |
| Description | The address of a user-supplied buffer. The user-supplied buffer can be a local variable of any type or a buffer resulting from a call to %Alloc. |
@Bytes
| Type | 10I 0 |
| Passing Mode | Reference |
| Description | The size in bytes of the buffer pointed to by the @Value parameter. On return, this parameter will hold the actual size of the requested list item. This way, the caller can know if the supplied buffer wasn't large enough or how many bytes in the supplied buffer are those from the CTLST instance if the supplied buffer is too large. |
Return Values
| Symbolic Constant | Value | Description |
| CS_SUCCESS | 0 | The next available item has been returned from the list. |
| CS_FAILURE | 1 | No item has been returned from the list; this means we have reached the end of the list. |