TSSH gate, WRITE function
If the queue does not exist, this function creates a queue with the single item provided, and the queue's "read cursor" is set to zero.
Input Parameters
- FMH
- indicates whether the data contains an FMH.
- Values for the parameter are:
- NO
- YES
- ITEM_DATA
- is the address and length of the item being written.
- 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
- EXPIRYINTMIN
- Optional Parameter
- is the expiry interval in minutes.
- POOL_TOKEN
- Optional Parameter
- is a token for the shared TS pool.
- TRANSACTION_NUMBER
- Optional Parameter
- is the 4-byte transaction number (in packed-decimal format).
- TRANSID
- Optional Parameter
- is the id of the transaction which issued this request.
Output Parameters
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- INSUFFICIENT_STORAGE
- INVALID_LENGTH
- INVALID_QUEUE_NAME
- IO_ERROR
- MAXIMUM_QUEUES_REACHED
- QUEUE_FULL
- SERVER_ERROR
- RESPONSE
- Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.
- TOTAL_ITEMS
- is the total number of items in the queue on completion of the operation.