Clara-Doc - Method Reference
CTQUE_Put
Description
Inserts an item in the queue.
Prototype
DCTQUE_Put...
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 that holds the item to be inserted in the queue. |
@Bytes
| Type | Pointer (*) |
| Passing Mode | Value |
| Description | The size in bytes of the item to be inserted in the queue instance. |
Return Values
| Symbolic Constant | Value | Description |
| CS_SUCCESS | 0 | The item has been inserted successfully. |
| CS_FAILURE | 1 | The item could not be inserted. The maximum number of items allowed in the queue has already been reached. |