TSQR gate, REWRITE function

This function updates the specified item in an existing queue. The read cursor is unchanged.

Input Parameters

ITEM_DATA
is the address and length of the item being written.
ITEM_NUMBER
is the number of the item to be updated.
QUEUE_NAME
is the name of the queue being created or appended to.
SUSPEND
indicates whether or not the request will be suspended if there is insufficient auxiliary storage to satisfy the request. This option is ignored if the queue is in main storage.
Values for the parameter are:
  • NO
  • YES
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
FMH
Optional Parameter
indicates whether the data contains an FMH.
Values for the parameter are:
  • NO
  • YES

Output Parameters

REASON
The following values are returned when RESPONSE is EXCEPTION:
  • INSUFFICIENT_STORAGE
  • INVALID_LENGTH
  • INVALID_QUEUE_NAME
  • INVALID_QUEUE_TYPE
  • IO_ERROR
  • ITEM_NOT_FOUND
  • LOCKED
  • QUEUE_DELETED
  • QUEUE_NOT_FOUND
  • QUEUE_REMOTE
RESPONSE
Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.
TOTAL_ITEMS
Optional Parameter
is the total number of items in the queue on completion of the operation.


dfhs3_TSQRrewrite.html | Timestamp icon Last updated: Monday, 5 June 2017