Gets the details of the next message from the program queue of the RDML function.
Normally the returned message details are then processed or printed by the RDML function in some non-standard way.
Messages on the program queue of an RDML function normally displayed on line 22/24 of the next screen presented to the user and then automatically cleared / removed.
Messages may have been placed on the program message queue by operating system commands, Built-In Functions, invalid I/O requests and/or RDML commands such as MESSAGE, VALUECHECK, etc.

Arguments:

Number	Type	Required or Optional	Description	Minimum Length	Maximum Length	Minimum Decimals	Maximum Decimals
1	Alpha	Optional	Remove message from queue Y - message is removed N - message is not removed Default value is Y.	1	1

Return Values:

Number	Type	Required or Optional	Description	Minimum Length	Maximum Length	Minimum Decimals	Maximum Decimals
1	Alpha	Required	Message return code OK = message returned NO = no message found	2	2
2	Alpha	Optional	Message text	1	132
3	Alpha	Optional	Message number	1	7
4	Alpha	Optional	Message file name	1	10
5	Alpha	Optional	Message file library	1	10
6	Alpha	Optional	Message substitution variable	1	132

RDML Example:
Insert a new name and address into file NAMES in a batch program. If an error is detected, print details of the name and address an exception report with all associated error messages.
DEFINE FIELD(#ERRTXT)TYPE(*CHAR)LENGTH(100) LABEL('Error:')
DEF_LINE NAME(#NAME)FIELDS(#CUSTNO#ADDRESS1 #ADDRESS2#ZIPCODE)
DEF_LINE NAME(#ERROR)FIELDS(#ERRTXT)IDENTIFY(*LABEL)

INSERT FIELDS(#NAME)TO_FILE(NAMES)VAL_ERROR(*NEXT)
IF_STATUS IS_NOT(*OKAY)

PRINT LINE(#NAME)
USE BUILTIN(GET_MESSAGE)TO_GET(#RETCODE#ERRTXT)
DOWHILE COND('#RETCODE=OK')

PRINT LINE(#ERROR)
USE BUILTIN(GET_MESSAGE) TO_GET(#RETCODE#ERRTXT)

ENDWHILE

ENDIF
Note: Running the same program under System i and in LANSA SuperServer mode will produce different messages.

A retrieved message using this BIF on the System i will display:

Messagetext:Recordtobeupdatedhasbeenchangedbyanotherjob/user
Messagenumber:IOM0017
Messagefilename:DC@M01

Running in LANSA SuperServer mode (against the System i) will display:

Messagetext:Recordtobeupdatedhasbeenchangedbyanotherjob/user
Messagenumber:*STCMSG
Messagefilename:2

This is a design consideration that, due to technical complexities, will not be changed in the short term.