TSQR gate, READ_NEXT_SET function
This function increments the queue's read cursor by one and reads that item number into a storage area obtained by TS.
Input Parameters
- QUEUE_NAME
- is the name of the queue being created or appended to.
- CALLER
- Optional Parameter
- indicates whether this request originated from an EXEC or macro call. The default is MACRO.
- Values for the parameter are:
- EXEC
- MACRO
- SET_STORAGE_CLASS
- Optional Parameter
- specifies the class of storage into which the item will be read. This may be either TASK (the default) or TERMINAL. If TERMINAL is specified, the item is read into a TIOA.
- Values for the parameter are:
- TASK
- TERMINAL
- TCTTE_ADDRESS
- Optional Parameter
- is the address of the TCTTE - required if SET_STORAGE_CLASS(TERMINAL) is specified.
Output Parameters
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- INVALID_QUEUE_NAME
- INVALID_QUEUE_TYPE
- IO_ERROR
- ITEM_NOT_FOUND
- QUEUE_NOT_FOUND
- ITEM_DATA
- returns the address and length of the item data.
- RESPONSE
- Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.
- FMH
- Optional Parameter
- indicates whether the data contains an FMH.
- Values for the parameter are:
- NO
- YES
- ITEM_NUMBER
- Optional Parameter
- returns the number of the item just read.
- TOTAL_ITEMS
- Optional Parameter
- is the total number of items in the queue on completion of the operation.