01 RMP--PARAMETERS.
This is the group-level name used to reference the entire parameter block.
03 RMP--INTERNAL-VALUES.
This area contains values that are used solely by RM/Panels.
05 RMP--VERSIONPIC 9(4) VALUE 210.
This field allows future versions of the RM/Panels runtime system to provide backward compatibility with the current version.
03 RMP--CONFIGURATION-PARAMETERS.
This area contains values that configure the behavior of the RM/Panels runtime system.
05 RMP--RUNTIMEPIC X(80) VALUE "runpan2".
This area contains the name of the RM/Panels runtime system program. The value clause contains the default value. This default can be changed by individual programs at runtime execution, or can be modified in RMPANELS.WS before programs are compiled.
05 RMP--TEMP-FILE-NAMEPIC X(12) VALUE SPACE.
If dynamic changes are made to a panel, a temporary file may be created by the RM/Panels runtime system to store these changes. RM/Panels generates a filename if this field is blank, but if you supply a filename here it is used instead. Supplying a filename does not require you to supply a directory in RMP--TEMP-FILE-DIRECTORY.
05 RMP--TEMP-FILE-DIRECTORYPIC X(80) VALUE SPACE.
If dynamic changes are made to a panel, a temporary file may be created by the RM/Panels runtime system to store these changes. RM/Panels places this file in the current working directory if this field is blank, but if you supply a directory name here it is used instead. Supplying a directory name does not require you to supply a filename in RMP--TEMP-FILE-NAME.
05 RMP--DEBUG-SWPIC X VALUE "N." 88 RMP--DEBUG VALUE "Y" WHEN FALSE "N".
This parameter can be used to enable the RM/Panels debugging mode. In this mode, extensive information is presented on the screen whenever an invalid standard runtime function request is made. The debugging mode should be used during program development. The parameter is set by the following statement:
SET RMP--DEBUG TO TRUE. 05 RMP--PROT-CHAR-SWPIC X VALUE "N". 88 RMP--PROT-ALLOW-CHAR VALUE "Y". 88 RMP--PROT-PREVENT-CHAR VALUE "N".
This parameter is used to control the type of keyboard action that returns control to the application program when a protected field/control is being entered. If RMP--PROT-ALLOW-CHAR is TRUE, a normal character key returns control to the application program in addition to exception keys. If RMP--PROT-PREVENT-CHAR is TRUE, only exception keys return control to the application program when a protected field/control is being entered. The parameter is set by the following statement:
SET RMP--PROT-ALLOW-CHAR TO TRUE. 05 RMP--FORCE-MONO-KEYPIC 9(3).
This parameter is used to indicate a field termination code that toggles between color and monochrome on the monitor, regardless of the type of video adapter or terminal being used. The parameter is set by the following statement:
MOVE 94 TO RMP--FORCE-MONO-KEY.
or by adding a value clause:
05 RMP--BACKSPACE-KEYPIC 9(3) VALUE 75. 05 RMP--USER-EDIT-KEYPIC 9(3).
This parameter is used to indicate a field termination code that starts the End-User Panel Editor. The parameter is set by the following statement:
MOVE 95 TO RMP--USER-EDIT-KEY.
or by adding a value clause:
05 RMP--BACKSPACE-KEYPIC 9(3) VALUE 75. 05 RMP--BACKSPACE-KEYPIC 9(3).
This parameter is used to indicate the field termination code that is generated by the Backspace key. The parameter is set by the following statement:
MOVE 75 TO RMP--BACKSPACE-KEY.
or by adding a value clause:
05 RMP--BACKSPACE-KEYPIC 9(3) VALUE 75. 05 RMP--GEN-HELP-SUP-SWPIC X VALUE "N". 88 RMP--GEN-HELP-SUP VALUE "Y" WHEN FALSE "N".
This parameter is used to suppress the ability to display the panel help message when a field/control-specific help message is displayed. This parameter is set by the following statement:
SET RMP--GEN-HELP-SUP TO TRUE. 05 RMP--KEY-CONFIGURATION.
This area contains values that identify specific keys to the RM/Panels runtime system. These keys control RM/Panels behavior, such as displaying help messages, or moving to the previous field/control. Default values are included, but these can be changed by individual programs at runtime execution, or modified in RMPANELS.WS before programs are compiled.
Each entry relates to a specific type of behavior and contains room for up to five keys that RM/Panels recognizes. The values assigned to the entry are three-digit RM/COBOL field termination codes.
The order of the values is not important. When modifying values, be careful to use three-digit values and do not add spaces. For example:
The help function in the default configuration is assigned to the F1 key.
The F1 key is field termination code 1, so the default configuration is:
07 RMP--HELP-KEY-VALUES PIC X(15) VALUE "001000000000000".
If you want the F3 key (field termination code 3) and the F9 key (field termination code 9) to also function as help keys, you would change the help key configuration to the following:
07 RMP--HELP-KEY-VALUES PIC X(15) VALUE "001003009000000". 07 RMP--HELP-KEY-VALUESPIC X(15) VALUE "001000000000000".
This area specifies the field termination codes that initiate the automatic help messages provided by RM/Panels.
07 RMP--RETURN-KEY-VALUESPIC X(15) VALUE "013000000000000".
This area specifies the field termination codes that should be interpreted by RM/Panels as the Enter key.
07 RMP--NEXT-FIELD-KEY-VALUES PIC X(15) VALUE "053000000000000".
This area specifies the field termination codes that should be interpreted by RM/Panels as a request to move to the next field/control on the panel.
07 RMP--PREV-FIELD-KEY-VALUES PIC X(15) VALUE "052000000000000".
This area specifies the field termination codes that should be interpreted by RM/Panels as a request to move to the previous field/control on the panel.
07 RMP--NEXT-GROUP-KEY-VALUES PIC X(15) VALUE "058000000000000".
This area specifies the field termination codes that should be interpreted by RM/Panels as a request to move to the next group on the panel.
07 RMP--PREV-GROUP-KEY-VALUES PIC X(15) VALUE "056000000000000".
This area specifies the field termination codes that should be interpreted by RM/Panels as a request to move to the previous group on the panel.
07 RMP--PULLDOWN-KEY-VALUESPIC X(15) VALUE "027000000000000".
This area specifies the field termination codes that should be interpreted by RM/Panels as a request to activate a pulldown menu.
03 RMP--GENERAL-FUNCTION-PARAMS.
This area contains parameters that are used with a number of different standard runtime functions.
05 RMP--LIBRARYPIC X(80).
This parameter identifies the panel library that contains the panels to be used. It must be set before the first panel is used, and set again whenever a new panel library is needed.
05 RMP--FIELD-NAMEPIC X(30).
This parameter is used with many standard runtime functions to identify a specific panel field/control.
05 RMP--FIELD-OCCURPIC 9(4).
This parameter is used with many standard runtime functions to identify a specific occurrence of a panel field/control.
05 RMP--FIELD-SEQPIC 9(3).
This parameter is used with many standard runtime functions to identify a panel field/control by the order in which it is entered on the panel.
05 RMP--ATTRIBUTEPIC X.
This parameter is used to specify an attribute value for the SET FIELD ATTRIBUTE standard runtime function.
05 RMP--PALETTEPIC 99.
This parameter is used to select a palette for the DISPLAY PANEL and CHANGE PANEL PALETTE standard runtime functions.
05 RMP--SUPPRESS-EVENT-RESET-SW PIC X VALUE "N". 88 RMP--SUPPRESS-EVENT-RESET VALUE "Y" WHEN FALSE "N".
This parameter is used with the ENABLE/DISABLE FIELD standard runtime function, but it is included here because it controls the EXECUTE EVENT standard runtime function. It prevents RM/Panels from resetting the values of RMP--NEXT-FIELD and RMP--NEXT-OCCUR when a field/control is enabled or disabled.
05 RMP--FORCE-MONO-SWPIC X VALUE "N". 88 RMP--FORCE-MONO VALUE "Y" WHEN FALSE "N".
This parameter is used to tell the RM/Panels runtime system to operate in monochrome mode, suppressing all colors. Because this parameter is checked by the runtime system when a library is opened, it must be set before a library is open. Setting RMP--FORCE-MONO to TRUE after opening a library has no effect until a new library is opened. This parameter is set by the following statement:
SET RMP--FORCE-MONO TO TRUE. 05 RMP--POLLING-INTERVALPIC 9(6).
This parameter is used by the utility function, START POLLING, to specify a polling interval in seconds.
03 RMP--PANEL-DISPLAY-PARAMS.
This area contains parameters for the DISPLAY PANEL standard runtime function. RMP--CLEAR-SW is also a parameter for the REMOVE PANEL standard runtime function.
05 RMP--SHOW-FIELDS-SWPIC X VALUE "N". 88 RMP--SHOW-FIELDS VALUE "Y" WHEN FALSE "N".
This parameter is used to display the values of panel fields/controls at the same time the panel is displayed. The parameter is set by the following statement:
SET RMP--SHOW-FIELDS TO TRUE. 05 RMP--CLEAR-SWPIC X VALUE "N". 88 RMP--CLEAR VALUE "Y" WHEN FALSE "N".
This parameter is used to erase the entire screen before a panel is displayed, or when a panel is erased. The parameter is set by the following statement:
SET RMP--CLEAR TO TRUE. 05 RMP--WINDOW-SWPIC X VALUE SPACE. 88 RMP--WINDOW VALUE "Y" WHEN FALSE "N".
This parameter is used to override the default windowing characteristic of a panel. To force a panel to display as a window, set the parameter by the following statement:
SET RMP--WINDOW TO TRUE.
To force a panel to display without behaving as a window, set the parameter by the following statement:
SET RMP--WINDOW TO FALSE. 05 RMP--PANEL-LINEPIC 9(3).
This parameter is used to control the screen line at which a panel is displayed. Leaving this value at 0 accepts the default. Setting this parameter to 999 centers the panel vertically. Setting any other value displays the panel at the specified line.
05 RMP--PANEL-POSPIC 9(3).
This parameter is used to control the screen column at which a panel is displayed. Leaving this value at 0 accepts the default. Setting this parameter to 999 centers the panel horizontally. Setting any other value displays the panel at the specified column.
05 RMP--BEEP-SWPIC X VALUE "N". 88 RMP--BEEP VALUE "Y" WHEN FALSE "N".
This parameter is used to generate a beep when a panel is displayed. The parameter is set by the following statement:
SET RMP--BEEP TO TRUE. 03 RMP--EXECUTE-EVENT-PARAMS.
These fields are parameters or returned values related to the EXECUTE EVENT standard runtime function.
05 RMP--EE-CONTROL-PARAMS.
These parameters are used to control the behavior of a single execution of the EXECUTE EVENT standard runtime function.
07 RMP--REPEAT-EVENT-SWPIC X VALUE "N". 88 RMP--REPEAT-EVENT VALUE "Y" WHEN FALSE "N".
This parameter is used to force the RM/Panels runtime system to repeat the last event executed on this panel. It is set by the following statement:
SET RMP--REPEAT-EVENT TO TRUE. 07 RMP--FIRST-FIELD-SWPIC X VALUE "N". 88 RMP--FIRST-FIELD VALUE "Y" WHEN FALSE "N".
This parameter is used to force the RM/Panels runtime system to begin user input with the first field/control on the panel. The parameter is set by the following statement:
SET RMP--FIRST-FIELD TO TRUE. 07 RMP--NEXT-FIELDPIC X(30).
This parameter is set by the RM/Panels runtime system to indicate the name of the field/control that will be entered next by the user. It may be modified by the application program to force input of a different field/control.
07 RMP--NEXT-OCCURPIC 9(3).
This parameter is set by the RM/Panels runtime system to indicate the occurrence of the field/control that will be entered next by the user. It may be modified by the application program to force input of a different occurrence.
07 RMP--NEXT-CURSOR-POSPIC 9(4).
This parameter is automatically set to zero by the RM/Panels runtime system and causes the cursor to move to the start of a field/control. By setting this parameter to a value other than zero, you can control the character position that the cursor initially moves to in a field/control.
07 RMP--NEXT-FIELD-SEQPIC 9(3).
This parameter is automatically set to zero by the RM/Panels runtime system and causes the cursor to move to the first enabled field/control. By setting this parameter to a value other than zero, you can control the field/control that is input next by entry order number.
07 RMP--SUPPRESS-SELECTION-SWPIC X VALUE "N". 88 RMP--SUPPRESS-SELECTIONVALUE "Y" WHEN FALSE "N".
Setting this parameter to TRUE prevents the field/control being input during the next EXECUTE EVENT standard runtime function from being displayed with the selected attribute, even though it has the keyboard focus.
05 RMP--EE-RETURNED-PARAMS.
The parameters in this area contain values returned by the RM/Panels EXECUTE EVENT standard runtime function.
07 RMP--LAST-FIELDPIC X(30).
This parameter is used by the RM/Panels runtime system to indicate the name of the field/control that was just entered by the user.
07 RMP--LAST-OCCURPIC 9(3).
This parameter is used by the RM/Panels runtime system to indicate the occurrence of the field/control that was just entered by the user.
07 RMP--LAST-CURSOR-POSPIC 9(4).
This parameter is set to the location of the keyboard cursor, relative to the start of the field/control, when input was terminated. It is set only for input type fields/controls.
07 RMP--LAST-FIELD-SEQPIC 9(3).
This parameter is set to the entry order number of the field/control that was just entered by the user.
07 RMP--EVENT-TYPEPIC X VALUE SPACE.
This parameter is set by the RM/Panels runtime system to describe the type of event that just occurred. If none of the following conditions occur, input is terminated “normally”, that is, by auto exit or by pressing a field termination key.
88 RMP--BUTTON-PRESS VALUE "B".
This condition indicates that a push button was pressed. The name of the push button is contained in RMP--NEXT-FIELD. The condition-name representing the button in panelname-WS is also set to TRUE.
88 RMP--BOX-CHANGED VALUE "C".
This condition indicates that a check box was toggled. The name of the check box is contained in RMP--NEXT-FIELD.
88 RMP--MENU-COMMAND VALUE "M".
This condition indicates that a pulldown menu command was selected. The name and text of the command are contained in RMP--COMMAND-NAME and RMP--COMMAND-TEXT, respectively.
88 RMP--RADIO-BTN-PRESSED VALUE "R".
This condition indicates that a radio button was pressed. The name of the radio button is contained in RMP--NEXT-FIELD.
88 RMP--LB-CHOICE-SELECTED VALUE "L".
This condition indicates that a list box choice was selected. The name of the list box is contained in RMP--NEXT-FIELD.
88 RMP--SB-MOVED VALUES ARE "S" "D" "d" "U" "u".
This condition indicates that a scroll bar's thumb position was changed. The name of the scroll bar is reported in RMP--SB- OPERATED because scroll bars, unlike other fields/controls, do not receive keyboard focus. The following conditions give more detail on how the scroll bar thumb was moved.
88 RMP--SB-PAGE-UP VALUE "U".
This condition indicates that a scroll bar's thumb was moved up by clicking above the thumb.
88 RMP--SB-PAGE-DOWN VALUE "D".
This condition indicates that a scroll bar's thumb was moved down by clicking below the thumb.
88 RMP--SB-STEP-UP VALUE "u".
This condition indicates that a scroll bar's thumb was moved up by clicking on the up arrow.
88 RMP--SB-STEP-DOWN VALUE "d".
This condition indicates that a scroll bar's thumb was moved down by clicking on the down arrow.
88 RMP--SB-DRAG VALUE "S".
This condition indicates that a scroll bar's thumb was moved by dragging it.
88 RMP--TIME-OUT-OCCURRED VALUE "T".
This condition indicates that a “time out” occurred.
88 RMP--POLLING-OCCURRED VALUE "P".
This condition indicates that the polling interval established with the START POLLING utility function has elapsed.
88 RMP--PANEL-MOVED VALUE "F".
This condition indicates that the user moved the panel and that RM/Panels has repainted the panel and its fields. If you used a DISPLAY statement to place information on the panel, you need to display it again.
07 RMP--DATA-CHANGED-SWPIC X VALUE "N". 88 RMP--DATA-CHANGED VALUE "Y" WHEN FALSE "N".
This condition indicates that the value of a field/control was changed by the last event. There is no indication of the field/control that was changed, because it is possible to change two fields/controls with one event. When a user types input to an input field/control and then clicks on a check box, both fields/controls change. This parameter allows you to bypass validation routines when no data has been changed on the panel.
07 RMP--PULLDOWN-PARAMETERS.
These parameters report the name and text of a pulldown menu command when it is selected.
09 RMP--COMMAND-NAMEPIC X(30).
This parameter reports the name of a pulldown menu command when it is selected. This name is an internal value that is not displayed to the user. Programs should check this value, rather than the text of the command, to maintain the logical, rather than physical, connection to the user interface.
09 RMP--COMMAND-TEXTPIC X(30).
This parameter reports the text of a pulldown menu command when it is selected. Programs are discouraged from checking this value and should instead use RMP--COMMAND-NAME.
07 RMP--MOUSE-CLICK-TYPEPIC X VALUE SPACE.
This parameter reports the type of mouse click performed on a field/control.
88 RMP--DOUBLE-CLICK VALUE "D".
This condition indicates that the mouse was double clicked on the field/control. Fields/controls must be configured to allow a double click.
88 RMP--SINGLE-CLICK VALUE "S".
This condition indicates that the mouse was single clicked on the field/control. All enabled fields/controls allow a single click.
07 RMP--LAST-PANELPIC X(20).
This parameter reports the name of the panel that was most recently accessed and is useful when implementing modeless behavior.
07 RMP--REQUESTED-PANELPIC X(20).
This parameter reports the name of an underlying panel that was selected during modeless behavior. This tells the application program the panel that should be used for the next EXECUTE EVENT standard runtime function to allow the panel to be elevated to the top level on the monitor.
07 RMP--PROT-CHARPIC X.
If a character key is pressed during protected field/control entry and RMP--PROT-ALLOW-CHAR is TRUE, this parameter contains the character that was pressed and RMP--EXCEPTION-NUMBER is 0. If an exception key is pressed, RMP--EXCEPTION-NUMBER contains the field termination code and is set to SPACE.
07 FILLERPIC X(96).
This area is reserved for future use.
03 RMP--RETURNED VALUES.
This area contains values that are returned by the RM/Panels runtime system.
05 RMP--EXCEPTION-NUMBERPIC 9(3). 88 F10-KEY VALUE 10. 88 ESCAPE-KEY VALUE 27.
This parameter is used by the RM/Panels runtime system to indicate to the application the key that was used to terminate user input. The value returned is the same value that the ON EXCEPTION clause returns for the key.
Level 88 condition-names are added after this parameter to allow the application program to easily interpret the key pressed. RETURN-KEY and ESCAPE-KEY are just samples that can be renamed, deleted, or added to. The names and values in this area are not important to the standard runtime function of RM/Panels. They are solely for the use of the application program.
05 RMP--MOUSE-PRESENT-SWPIC X VALUE SPACE. 88 RMP--MOUSE-PRESENT VALUE "Y" WHEN FALSE "N".
This parameter is set by the RM/Panels runtime system whenever a library is opened. It lets the application program know whether a mouse is present and accessible to RM/Panels.
05 RMP--VALID-INPUT-SW PIC X SPACE. 88 RMP--VALID-INPUT VALUE "Y". 88 RMP--INVALID-INPUT VALUE "N".
This parameter is used by the RM/Panels runtime system to indicate to the application program whether user input to a field/control satisfied validation rules specified for that field/control in the panel. If the input satisfied the rules, the value is set to Y. If the input failed to satisfy the rules, the value is set to N.
05 RMP--STATUS PIC 9(4) VALUE 0. 88 RMP--VALID-FUNCTION VALUE 0. 88 RMP--FIELD-INVALID VALUE 1. . . . 88 RMP--NO-ERROR-DEFINED VALUE 13. 88 RMP--IO-ERROR VALUE 14. 88 RMP--CONTROL-DISABLED VALUE 15. 88 RMP--WINDOW-ERROR VALUE 16. 88 RMP--NO-PULLDOWN VALUE 22. 88 RMP--MENU-COMMAND-INVALID VALUE 20. 88 RMP--MODELESS-DATA-OVERLOAD VALUE 21. 88 RMP--NO-PULLDOWN VALUE 22. 88 RMP--WRONG-FIELD-TYPE VALUE 23. 88 RMP--TOO-MANY-PANELS VALUE 40. 88 RMP--CANNOT-CREATE-TEMP VALUE 41. 88 RMP--CANNOT-OPEN-TEMP VALUE 42. 88 RMP--API-PARAM-MISSING VALUE 1001. 88 RMP--API-MSG-NOT-DEFINED VALUE 1002. 88 RMP--API-PD-OPTION-INVALID VALUE 1003. 88 RMP--API-UNCHECKABLE VALUE 1004.
This parameter is used by the RM/Panels runtime system to report the outcome of the function request. If the function was performed successfully, a value of 0 is returned. If the function was unsuccessful, a non-zero value is returned indicating the reason. The condition-names are provided to make it easier for the application program to detect and interpret unsuccessful function requests.
03 RMP--FUNCTION-CODES.
These parameters contain the function codes used to identify standard, utility, and extended runtime functions to the RM/Panels runtime system. They should not be modified and the application program should never depend on the value or even the type of the data items. The calls to the RM/Panels runtime system use the data names. If direct calls are used in your application programs, they must always use the data-name and not the actual value.
03 RMP--SCROLL-BAR-WS.
These parameters contain values specific to scroll bars and their standard runtime functions.
05 RMP--SB-MINPIC 9(4).
This parameter is used to set a new minimum value for a scroll bar.
05 RMP--SB-MAXPIC 9(4).
This parameter is used to set a new maximum value for a scroll bar.
05 RMP--SB-STEPPIC 9(4).
This parameter is used to set a new step value for a scroll bar.
05 RMP--SB-PAGEPIC 9(4).
This parameter is used to set a new page value for a scroll bar.
05 RMP--SB-OPERATEDPIC X(30).
This parameter is used to report the name of a scroll bar when its thumb position is altered.
03 FILLERPIC X(50).
This area reserved for future use.