APTD gate, READ_TRANSIENT_DATA function

The READ_TRANSIENT_DATA function of the APTD gate is used to read a single record from a named transient data queue.

Input Parameters

INTO
specifies a piece of storage into which the record is placed.
QUEUE
is the queue option specified by the routing program.
SUSPEND
specifies whether the caller wants to wait if the record to be read has not been committed to the queue yet.
Values for the parameter are:
  • NO
  • YES
DATA_KEY
Optional Parameter
if this is a READ TD SET rather than an INTO, DATA_KEY specifies whether Transient Data should obtain the required SET storage from CICS key or user key storage.
Values for the parameter are:
  • CICS
  • USER
DATA_LOC
Optional Parameter
if this is a READ TD SET rather than an INTO, DATA_LOC specifies whether Transient Data should obtain the required SET storage from above or below the 16MB line.
Values for the parameter are:
  • ANY
  • BELOW
RSL_CHECK
Optional Parameter
states whether resource-level checking is to be carried out.
Values for the parameter are:
  • NO
  • YES

Output Parameters

REASON
The values for the parameter are:
  • CSM_ERROR
  • DCT_ERROR
  • DIRECTORY_MGR_ERROR
  • INTO_OMITTED
  • INVALID_DATA_LOC
  • INVALID_INTO_N
  • INVALID_INTO_P
  • INVALID_RSL_CHECK
  • INVALID_SUSPEND
  • IO_ERROR
  • JCP_ERROR
  • LENGTH_ERROR
  • LOCKED
  • LOGIC_ERROR
  • NO_RECOVERY_TABLE
  • QUEUE_BUSY
  • QUEUE_DISABLED
  • QUEUE_EMPTY
  • QUEUE_NOT_AUTH
  • QUEUE_NOT_FOUND
  • QUEUE_NOT_INPUT
  • QUEUE_NOT_OPEN
  • QUEUE_OMITTED
  • QUEUE_REMOTE
RESPONSE
Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.


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