The following types of parameters are used with RM/Panels standard, utility, and extended runtime functions:
Required parameters are those that must be set to valid values in order for a standard, utility, or extended runtime function to execute correctly.
Optional parameters are those that can be set to override the default behavior specified for the panel. Optional parameters are always reset to their default values by the RM/Panels runtime system after the function is executed. This prevents later executions of the standard runtime function from inheriting the overridden behavior.
Extended runtime functions also use additional arguments on the CALL statement.
The following table lists the required and optional parameters for RM/Panels standard runtime functions.
| Standard Runtime Function Name | Abbr. | Required Parameters | Optional Parameters |
|---|---|---|---|
|
ACCEPT FIELD |
AF |
RMP--FIELD-NAME RMP--FIELD-OCCUR |
NONE |
|
CHANGE PANEL PALETTE |
CPP |
RMP--PALETTE |
NONE |
|
CHECK MENU OPTION |
CMO |
RMP--COMMAND-NAME |
NONE |
|
CLEAR ALL FIELDS |
CAF |
NONE |
NONE |
|
DISABLE ALL FIELDS |
DA |
NONE |
NONE |
|
DISABLE FIELD FOR INPUT |
DFI |
RMP--FIELD-NAME |
RMP--SUPPRESS- EVENT-RESET |
|
DISABLE MENU OPTION |
DMO |
RMP--COMMAND-NAME |
NONE |
|
DISPLAY ALL FIELDS |
DAF |
NONE |
NONE |
|
DISPLAY FIELD |
DF |
RMP--FIELD-NAME RMP--FIELD-OCCUR |
NONE |
|
DISPLAY PANEL |
DP |
RMP--LIBRARY |
RMP--BEEP RMP--CLEAR RMP--PALETTE RMP--PANEL-LINE RMP--PANEL-POS RMP--SHOW-FIELDS RMP--WINDOW |
|
ENABLE ALL FIELDS |
EA |
NONE |
NONE |
|
ENABLE FIELD FOR INPUT |
EFI |
RMP--FIELD-NAME |
RMP--SUPPRESS- EVENT-RESET |
|
ENABLE MENU OPTION |
EMO |
RMP--COMMAND-NAME |
NONE |
|
EXECUTE EVENT |
EE |
RMP--FIRST-FIELD1 RMP--NEXT-FIELD1 RMP--NEXT-OCCUR1 RMP--REPEAT-EVENT1 You may select one of these parameters to execute the standard runtime function. |
NONE |
|
INITIALIZE ALL FIELDS |
IAF |
NONE |
NONE |
|
INITIALIZE FIELD |
IF |
RMP--FIELD-NAME RMP--FIELD-OCCUR |
NONE |
|
POPUP MENU |
PUM |
RMP--COMMAND-NAME |
RMP--PANEL-LINE RMP--PANEL-POS |
|
REMOVE PANEL |
RP |
NONE |
RMP--CLEAR |
|
SET FIELD ATTRIBUTE |
SFA |
RMP--ATTRIBUTE RMP--FIELD-NAME RMP--FIELD-OCCUR |
NONE |
|
SET SCROLL BAR RANGE |
SSR |
RMP--FIELD-NAME RMP--SB-MAX RMP--SB-MIN |
RMP--SB-PAGE RMP--SB-STEP |
|
SHOW FIELD ERROR |
SFE |
RMP--FIELD-NAME |
NONE |
|
SHOW FIELD HELP |
SFH |
RMP--FIELD-NAME |
NONE |
|
SHOW PANEL ERROR |
SPE |
NONE |
NONE |
|
SHOW PANEL HELP |
SPH |
NONE |
NONE |
|
UNCHECK MENU OPTION |
UMO |
RMP--COMMAND-NAME |
NONE |
|
VALIDATE ALL FIELDS |
VAF |
NONE |
NONE |
|
VALIDATE FIELD |
VF |
RMP--FIELD-NAME RMP--FIELD-OCCUR |
NONE |
The following table lists the required and optional parameters for RM/Panels utility functions.
| Utility Function Name | Abbr. | Required Parameters | Optional Parameters |
|---|---|---|---|
|
DELETE TEMPORARY FILE |
DTF |
NONE |
NONE |
|
END MODELESS OPERATION |
EMD |
NONE |
NONE |
|
END POLLING |
EP |
NONE |
NONE |
|
HIDE MOUSE CURSOR |
HMC |
NONE |
NONE |
|
SET COLOR |
SCO |
NONE |
NONE |
|
SET MONOCHROME |
SMO |
NONE |
NONE |
|
SHOW MOUSE CURSOR |
SMC |
NONE |
NONE |
|
START MODELESS OPERATION |
SMD |
NONE |
NONE |
|
START POLLING |
SP |
RMP--POLLING-INTERNAL |
NONE |
The following table lists the required parameters and additional arguments for RM/Panels extended runtime functions.
| Extended Runtime Function Name | Abbr. | Required Parameters | Additional Arguments |
|---|---|---|---|
|
ACTIVATE A LIBRARY |
E-AL |
NONE |
libraryname |
|
ACTIVATE A PANEL |
E-AP |
NONE |
panelname |
|
ADD FIELD DESCRIPTION |
E-AFD |
NONE |
FIELD-DESCRIPTION |
|
CHANGE FIELD DESCRIPTION |
E-CFD |
RMP--FIELD-NAME |
FIELD-DESCRIPTION |
|
CREATE A LIBRARY |
E-CL |
NONE |
libraryname |
|
CREATE A PANEL |
E-CP |
NONE |
panelname |
|
DELETE FIELD DESCRIPTION |
E-DFD |
RMP--FIELD-NAME |
NONE |
|
DISCARD CHANGES |
E-DC |
NONE |
NONE |
|
GET FIELD DESCRIPTION |
E-GFD |
RMP--FIELD-NAME |
FIELD-DESCRIPTION |
|
BY NAME |
|
|
|
|
GET FIELD DESCRIPTION BY NUMBER |
E-GFN |
RMP--FIELD-SEQ |
FIELD-DESCRIPTION |
|
GET FIELD VALUE |
E-GFV |
RMP--FIELD-NAME |
FIELD-VALUE-DESC |
|
GET LIBRARY CONFIGURATION |
E-GLC |
NONE |
LIBRARY-CONFIG-DESC |
|
GET MESSAGE |
E-GMS |
NONE |
MSG-DESC |
|
GET PALETTE DESCRIPTION |
E-GPLT |
RMP--PALETTE |
PALETTE-DESC |
|
GET PANEL CONFIGURATION |
E-GPC |
NONE |
PANEL-CONFIG-DESC |
|
GET PANEL LINE |
E-GPL |
NONE |
PANEL-LINE-DESC |
|
GET PULLDOWN MENU PULLDOWN OPTIONS |
E-GPD |
NONE |
PULLDOWN-PD-DESC |
|
GET PULLDOWN MENU TOP LEVEL OPTIONS |
E-GPT |
NONE |
PULLDOWN-TITLE-AREA |
|
HIDE PANEL |
E-HDP |
NONE |
NONE |
|
REMOVE MENU OPTION |
E-RMO |
RMP--COMMAND-NAME |
NONE |
|
SAVE A PANEL |
E-SP |
NONE |
NONE |
|
SET FIELD VALUE |
E-SFV |
RMP--FIELD-NAME |
FIELD-VALUE-DESC |
|
SET LIBRARY CONFIGURATION |
E-SLC |
NONE |
LIBRARY-CONFIG-DESC |
|
SET MESSAGE |
E-SMS |
NONE |
MSG-DESC |
|
SET PALETTE DESCRIPTION |
E-SPLT |
RMP--PALETTE |
PALETTE-DESC |
|
SET PANEL CONFIGURATION |
E-SPC |
NONE |
PANEL-CONFIG-DESC |
|
SET PANEL LINE |
E-SPL |
NONE |
PANEL-LINE-DESC |
|
SET PULLDOWN MENU PULLDOWN OPTIONS |
E-SPD |
NONE |
PULLDOWN-PD-DESC |
|
SET PULLDOWN MENU TOP LEVEL OPTIONS |
E-SPT |
NONE |
PULLDOWN-TITLE-AREA |
|
SHOW MESSAGE |
E-SHM |
NONE |
MSG-DESC |
|
UPDATE PANEL |
E-UDP |