Clara-Doc - Method Reference

 / packages  / CTBASE  / Version 01.00.00  / CTLST

CTLST_Clear
Description
Removes all items from a linked list instance. The item count will become zero.

Prototype 

			
       DCTLST_Clear...                                               
       D                 PR            10I 0                              
       D
       D@This                            *     Value
Parameters
@This
TypePointer (*)
Passing ModeValue
DescriptionThe address of a linked list instance. This pointer MUST be obtained through a call to CTLST_Constructor.
Return Values

Symbolic ConstantValueDescription
CS_SUCCESS0The linked list was cleared successfully.
CS_FAILURE1The linked list was not cleared.