9.219 SHOW_HELP
Þ Note: Built-In Function Rules.
Causes the help text associated with a field, a component, a process or a function to be modally displayed. .
For use with
|
Arguments
|
Return Values
There are no return values
Comments
- The help text associated with a component should only be displayed in a component context (i.e. from an RDMLX program).
- Field, Process and Function help text can be displayed in any context (i.e. from RDMLX programs or RDML functions).
- In this version of this Built-In Function the display of help text is modal. The application halts until the user completes the display of the help text and closes the help text window.
- In future versions of this Built-In Function the display of help text may not be modal. You should avoid designing applications that architecturally rely on the modal nature of the current version.
- This Built-In Function should never be executed in environments in which no user interface capability exists (e.g. in a trigger or in a remote procedure).
Examples
Display the help text associated with field EMPNO:
USE BUILTIN(SHOW_HELP) WITH_ARGS(DF EMPNO);
Display the help text associated with process MYPROC:
USE BUILTIN(SHOW_HELP) WITH_ARGS(PD MYPROC);
Display the help text associated with the TREEVIEW component in the component VL_DEM20:
USE BUILTIN(SHOW_HELP) WITH_ARGS(DF VL_DEM20 TREEVIEW);