TSQR gate, READ_INTO function
This function reads the specified queue item into a buffer provided by the caller. The read cursor for the queue is set to the item number provided. The caller provides the address (item_buffer_p) and buffer length (item_buffer_m). The actual length of the record is returned in item_buffer_n. If item_buffer_n is greater than item_buffer_m, the data is truncated (but an OK response is returned).
Input Parameters
- ITEM_BUFFER
- specifies the address (item_buffer_p) and maximum length (item_buffer_m) of the data area into which the data will be read. The actual data length is returned in item_buffer_n.
- ITEM_NUMBER
- is the number of the item to be updated.
- 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
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
- 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
- TOTAL_ITEMS
- Optional Parameter
- is the total number of items in the queue on completion of the operation.