9.196 SHOW_HELP
Note: Built-In Function Rules Usage Options
Causes the help text associated with a field, a component, a process or a function to be modally displayed.
Arguments
|
No
|
Type
|
Req/ Opt
|
Description
|
Min Len
|
Max Len
|
Min Dec
|
Max Dec
|
|
1
|
A
|
Req
|
Object Type. Specify this argument as:
PD – Process
PF – Function
DF – Field or Component
Any other value is invalid and will cause a run time error to be generated.
|
2
|
2
|
|
|
|
2
|
A
|
Req
|
Object Name. Blank or null object names will cause a run time error to be generated. Other invalid or non-existent object names may cause help text to be displayed indicating that no help text exists.
|
1
|
10
|
|
|
|
3
|
A
|
Opt
|
Object Name Extension. Specify this argument only for type PF (Function) or DF (Component only, NOT Field).
For a Function it is the name of the process to which the function belongs and it must be no longer than 10 characters.
For a Component it is the name of the specific Component within the owning Component.
For all other object types this argument is ignored, regardless of what value it contains.
|
1
|
65
|
|
|
|
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);
