Clara-Doc - Method Reference
CTSTK_SetMax
Description
Sets the maximum limit on the number of items a stack instance may hold.
Prototype
DCTSTK_SetMax...
D PR 10I 0
D@This * Value
D@Size 10I 0 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. |
@Size
| Type | 10I 0 |
| Passing Mode | Value |
| Description | The maximum number of items that can be inserted in the specified stack instance. The maximum possible number of items is CTSTK_MAXSIZE (2147483646 items). |
Return Values
| Symbolic Constant | Value | Description |
| CS_SUCCESS | 0 | The stack's maximum number of items has been set successfully. |
| CS_FAILURE | 1 | The @Size value is invalid (possibly negative). |