Clara-Doc - Method Reference
CTSTK_Pop
Description
Removes an item from a stack instance and copied it in a caller-supplied buffer.
Prototype
DCTSTK_Pop...
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 stack instance. This pointer MUST be obtained through a call to CTSTK_Constructor. |
@Value
| Type | Pointer (*) |
| Passing Mode | Value |
| Description | The address of a buffer where the stack item is to be copied. |
@Bytes
| Type | 10I 0 |
| Passing Mode | Reference |
| Description | The size in bytes of the buffer where the stack value is to be copied. |
Return Values
| Symbolic Constant | Value | Description |
| CS_SUCCESS | 0 | The stack item has been copied successfully. Also, the item is no longer in the stack. |
| CS_FAILURE | 1 | The item could not be copied in the buffer and the item was not removed from the stack. |