MEM4 gate, RETRIEVE_MESSAGE function
The RETRIEVE_MESSAGE function of the MEM4 gate is used to retrieve the text of a message that uses data in 64-bit storage.
Input Parameters
- MESSAGE_BUFFER
- The buffer to receive the message text.
- MESSAGE_NUMBER
- The numeric message identifier.
- APPLID
- Optional Parameter
- The application identifier of the system that originated the message.
- COMPONENT_ID
- Optional Parameter
- The component identifier for the message.
- DATE
- Optional Parameter
- The date of the message.
- DESTINATIONS
- Optional Parameter
- One or more transient data (TD) queues that are the destination of the message.
- INSERTn
- Optional Parameter
- A user-supplied 64-bit insert, if required by the message definition.
- LANGUAGE
- Optional Parameter
- An optional language code.
- MSGTABLE
- Optional Parameter
- Indicates that the feature message table is to be used.
- NETNAME
- Optional Parameter
- A new network name that overrides the network name that the message domain obtains.
- PRODUCT
- Optional Parameter
- An optional product identifier.
- SUPPRESS_DUMP
- Optional Parameter
- Indicates whether dumps were suppressed. The parameter can take
the following values:
- NO
- YES
- TERMID
- Optional Parameter
- A new terminal identifier that overrides the terminal identifier that the message domain obtains.
- TIME
- Optional Parameter
- The time of the message.
- TRANID
- Optional Parameter
- A new transaction identifier that overrides the transaction identifier that the message domain obtains.
Output Parameters
- REASON
- The following values are returned when RESPONSE is DISASTER:
- ABEND
- EYU_TABLE_MISSING
- INSUFFICIENT_STORAGE
- INVALID_MODULE_PTR
- INVALID_TEMPLATE
- The following values are returned when RESPONSE is EXCEPTION:
- MSG_BUFFER_TOO_SMALL
- REPLY_BUFFER_TOO_SMALL
- The following values are returned when RESPONSE is INVALID:
- INVALID_COMPONENT_TYPE
- INVALID_FUNCTION
- INVALID_INSERT
- INVALID_MESSAGE_BUFFER
- MESSAGE_NOT_FOUND
- MESSAGE_SET_NOT_FOUND
- MISSING_INSERT
- OPT_INSERT_NOT_FOUND
- RETRY_MSG_LOCATE
- RESPONSE
- Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.