Clara-Doc - Method Reference
CTLST_Get
Description
Prototype
DCTLST_Get...
D PR 10I 0
D@This * Value
D@Value * Value
D@Bytes 10I 0
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. On return, this parameter will hold the actual size of the requested list item. This way, the caller can know if the supplied buffer wasn't large enough or how many bytes in the supplied buffer are those from the CTLST instance if the supplied buffer is too large. |
@Index
| Type | 10I 0 |
| Passing Mode | Value |
| Description | The index of the requested list item within the CTLST instance. The first item is located at index 1. |
Return Values
| Symbolic Constant | Value | Description |
| CS_SUCCESS | 0 | The list item was copied successfully. |
| CS_FAILURE | 1 | The list item could not be copied into the caller-supplied buffer. This could be due to an index out of range or a *null caller-supplied buffer. |