Clara-Doc - Method Reference
CTQUE_IterStart
Description
Starts an iteration loop over all queue items.
Prototype
DCTQUE_IterStart...
D PR 10I 0
D@This * Value
Parameters
@This
| Type | Pointer (*) |
| Passing Mode | Value |
| Description | The address of a queue instance. This pointer MUST be obtained through a call to CTQUE_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 queue. This means the queue has at least one item. |
| CS_FAILURE | 1 | The queue is empty. The queue cannot be read from. |