Clara-Doc - Method Reference
CTSTK_IterStart
Description
Prepares a stack instance for an iteration loop.
Prototype
DCTSTK_IterStart...
D PR 10I 0
D@This * Value
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. |
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 stack. This means the stack has at least one item. |
| CS_FAILURE | 1 | The specified stack instance is empty. The stack cannot be read from. |