Description
Removes an item from the list at a specified index.
Prototype
DCTLST_Remove...
D PR 10I 0
D@This * Value
D@Index 10I 0 Value
Parameters
@This
Type | Pointer (*) |
Passing Mode | Value |
Description | The address of a linked list instance. This pointer MUST be obtained through a call to CTLST_Constructor. |
@Index
Type | 10I 0 |
Passing Mode | Value |
Description | The index position of the byte buffer within the CTLST instance. The first item in the list is located at index 1 (or CTLST_TOP). If you want to insert at the end of the list, you must specify CTLST_BOTTOM. If you specify an index out of range, the item will not be inserted (copied). |
Return Values
Symbolic Constant | Value | Description |
CS_SUCCESS | 0 | The item was successfully removed from the list. |
CS_FAILURE | 1 | The item could not be removed from the list due to an invalid index (the index is either out of range or the list is empty). |