MEBM gate, RETRIEVE_MESSAGE function

The RETRIEVE_MESSAGE function of the MEBM gate is used to retrieve the message text and build the message into a buffer.

Input Parameters

MESSAGE_BUFFER
is the buffer to receive the message text.
MESSAGE_NUMBER
is the numeric message identifier.
MESSAGE_TABLE
is a table containing all the message definitions for the message domain.
COMPONENT_ID
Optional Parameter
is the component identifier for the message.
INSERTn
Optional Parameter
A user-supplied insert, if required by the message definition.
MODULE_NAME
Optional Parameter
is the name of the module in error, supplied as data for the symptom string.
MODULE_PTF
Optional Parameter
is the PTF level of the module in error, supplied as data for the symptom string.
SUPPRESS_SRBUILD
Optional Parameter
indicates whether or not a symptom record build is suppressed.
Values for the parameter are:
  • NO
  • YES
SYMPTOM_BUFFER
Optional Parameter
is the buffer to receive a symptom string for the message.
UPPERCASE
Optional Parameter
determines whether or not messages should be converted to uppercase.
Values for the parameter are:
  • NO
  • YES

Output Parameters

REASON
The values for the parameter are:
  • MESSAGE_CANNOT_BE_PRODUCED
RESPONSE
Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.


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