Clara-Doc - Method Reference

 / packages  / CTBASE  / Version 01.00.00  / CTQUE

CTQUE_Clear
Description
Removes all items from the queue.

Prototype 

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

Symbolic ConstantValueDescription
CS_SUCCESS0The queue was emptied successfully.
CS_FAILURE1The queue could not be emptied.