Previous Topic: $RBA FunctionNext Topic: $RECLENGTH Function


$RECEIVED Function

This function evaluates to a Boolean value of True or False, depending on whether a value was received for the specified field. You can issue the $RECEIVED function for panel fields or rows or for parameters passed from a RUN command or a CALL statement.

This function has the following format:

           {pnl‑grp(pnl‑row) }
$RECEIVED ({fieldidentifier })
           {pnlgrp(pnlrow) }
pnl‑grp

The identifier of a repeating group field defined for a panel.

pnl‑row

The identifier of a field or a literal used to index the repeating group. If a value was received for any field on the specified row, the $RECEIVED function returns a value of True.

field‑identifier

The identifier of an elementary panel field or level‑1 parameter field being tested. This field must be defined for the panel or in the parameters.

For parameters, you can only test level‑1 fields or groups. It is not possible to omit parameters at other levels.

$RECEIVED for fields passed from a RUN command or a CALL statement is set to True when the level‑1 parameter was provided. If a level‑1 parameter value was not received, all level‑1 parameters defined on subsequent lines of the parameter section are also missing. See the Creating Programs Guide.

$RECEIVED for panel fields evaluates to the value True in three cases:

The value of $RECEIVED is not reset as long as panel errors remain.