Clara-Doc - Method Reference
CTQUE_IterNext
Description
Returns the value of the next available item in the queue within an iteration loop; the item is not removed from the queue.
Prototype
DCTQUE_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 queue instance. This pointer MUST be obtained through a call to CTQUE_Constructor. |
@Value
| Type | Pointer (*) |
| Passing Mode | Value |
| Description | The address of a buffer where the next queue item will be copied. |
@Bytes
| Type | 10I 0 |
| Passing Mode | Reference |
| Description | The size in bytes of the caller-supplied buffer. On return, this parameter will hold the actual size of the queue item. The method will not copy more than @Bytes in the @Value parameter even if the queue item is larger. |
Return Values
| Symbolic Constant | Value | Description |
| CS_SUCCESS | 0 | The next available queue item has been copied in the caller-supplied buffer. The item itself remains in the queue. |
| CS_FAILURE | 1 | We are at the end of the iteration loop; there was no item left to retrieve from the queue. |