TSQR 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
- 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.
- STORAGE_TYPE
- indicates whether the queue is to be created in main or auxiliary storage. Note that this option is ignored if the queue already exists.
- Values for the parameter are:
- AUXILIARY
- MAIN
- 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
- BMS
- Optional Parameter
- indicates whether or not BMS owns this queue.
- 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
- LOCKED
- QUEUE_DELETED
- QUEUE_FULL
- 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.