Page History

...

It is recommended that the RDML commands of an RDML Built-In Function be in the following sequence:

    FUNCTION OPTIONS( *DIRECT … *BUILTIN …)

...

     FUNCTION OPTIONS( *DIRECT … *BUILTIN …)

        followed optionally by the override BIF name and description:

...

     DEFINE FIELD(#BIF_NAME)

...

 TYPE(*CHAR)

...

 LENGTH(20)

...

 DESC(<BIF description>) DEFAULT(<BIF name>)

        followed

...

optionally by the required and then optional arguments:

...

     DEFINE/DEF_

...

LIST #BIF_ARGnn 

...

        followed optionally by the required and then optional return values:

...

     DEFINE/DEF_

...

LIST #BIF_RETnn 

...

        Note that a working list argument or return value is always required.

It is also recommended that the naming convention for working list argument counters be BIF_ALCnn and for working list return value counters be BIF_RLCnn.

Note that these recommendations are followed in the function skeleton generated from the application template BBRDMLBIF supplied by LANSA.

Return Value Working Lists

Return value working lists are not cleared automatically as a result of either specifying them in a USE of an RDML Built-In Function or on entry to an RDML Built-In Function.

...

This behavior allows the RDML Built-In Function to be more flexible with regard to return value working lists.

Interactive Commands

It would be extremely unusual to code DISPLAY, POP_UP or REQUEST commands in an RDML BIF function, unless it was documented that the RDML BIF is to run only in an interactive environment and appropriate checking for such an environment were coded on entry to the RDML BIF. This would affect the portability of the RDML BIF.

...