Clara-Doc - Method Reference

 / packages  / CTBASE  / Version 01.00.00  / CTQUE

CTQUE_SetMax
Description
Sets the maximum number of items in the queue.

Prototype 

			     DCTQUE_SetMax...
     D                 PR            10I 0
     D@This                            *   Value
     D@MaxSize                       10I 0 Value
Parameters
@This
TypePointer (*)
Passing ModeValue
DescriptionThe address of a queue instance. This pointer MUST be obtained through a call to CTQUE_Constructor.
@MaxSize
Type10I 0
Passing ModeValue
DescriptionThe maximum number of items that can be inserted in the queue. The maximum possible number of items is CTQUE_MAXSIZE (2147483646 items).
Return Values

Symbolic ConstantValueDescription
CS_SUCCESS0The queue's maximum number of items has been set successfully.
CS_FAILURE1The @MaxSize value is invalid (possibly negative).