Clara-Doc - Method Reference
CTLST_Insert
Description
Prototype
DCTLST_Insert...
D PR 10I 0
D@This * Value
D@Value * Value
D@Bytes 10I 0 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. |
@Value
| Type | Pointer (*) |
| Passing Mode | Value |
| Description | The address of a user-supplied buffer. The user-supplied buffer can be a local variable of any type or a buffer resulting from a call to %Alloc. |
@Bytes
| Type | 10I 0 |
| Passing Mode | Reference |
| Description | The size in bytes of the buffer pointed to by the @Value parameter. |
@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 inserted successfully. |
| CS_FAILURE | 1 | The item could not be inserted. This could be due to an index out of range. |