Clara-Doc - Method Reference
CTQUE_Get
Description
Returns the next available queue item (in FIFO order). This effectively removes the item from the queue; it can no longer be retrieved.
Prototype
DCTQUE_Get...
D PR 10I 0
D@This * Value
D@Value * Value
D@Bytes 10I 0 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. |
@Value
| Type | Pointer (*) |
| Passing Mode | Value |
| Description | The address of a buffer where the queue item is to be copied. |
@Bytes
| Type | 10I 0 |
| Passing Mode | Value |
| Description | The size in bytes of the buffer where the queue value is to be copied. |
Return Values
| Symbolic Constant | Value | Description |
| CS_SUCCESS | 0 | The queue item has been copied successfully. Also, the item is no longer in the queue. |
| CS_FAILURE | 1 | The item could not be copied in the buffer and the item was not removed from the queue. |