Clara-Doc - Method Reference

CTBUFFLST_Remove
Description
Removes a byte buffer from the list

Prototype 

			
     DCTBUFFLST_Remove...
     D                 PR            10I 0
     D@This                            *   Value
     D@Index                         10I 0 Value
Parameters
@This
TypePointer (*)
Passing ModeValue
DescriptionThe address of an CTBUFFLST instance. This pointer MUST be obtained through a call to CTBUFFLST_Constructor.
@Index
Type10I 0
Passing ModeValue
DescriptionThe index position of the byte buffer within the CTBUFFLST 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 ConstantValueDescription
CS_SUCCESS0The item was successfully removed from the list.
CS_FAILURE1The 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).