SYSTEM SUBROUTINES - APPENDIX A
Published By | Date | Version | Knowledge Level | Keywords |
---|---|---|---|---|
Revelation Technologies | 14 NOV 1989 | 2.X | EXPERT | Appendix |
Appendix 1
System Variables
@BROWSE.MODE
@BROWSE.MODE is a boolean flag having a value of true if a browse list is active, and false otherwise.
@ENVIRON.SET
@ENVIRON.SET is an array of system-wide environment settings. The fields are initialized at login. All field settings are accessible at the Environment window. The structure of @ENVIRON.SET appears in the ENVIRON.CONSTANTS record of the INCLUDE file. See that record for more information.
Field | Mnemonic | Description |
---|---|---|
1 | E.INSERT.MODE | Put editor in insert mode if true. |
2 | E.BACK.CHAR | Print this as the background char. |
3 | E.TCL.DEPTH | # of TCL items saved in memory. |
4 | E.TCL.SAVE | TCL stack save file. |
5 | E.PORT | Com. port information: baud, etc. |
6 | E.LOGON | Logon: `M', `T', or `S'. |
7 | E.BG.BACK.COLOR | Only needed for color sequences. |
8 | E.ROLLOUT | DOS filename SUSPEND. |
9 | E.DEFAULT.STOPS | MV list of stop words. |
10 | DATA.TYPE.VERIFICATION | Flag: prompting of data types. |
11 | E.TAB.STOPS | System tab stops variables. |
12 | E.STATUS.ON | If true, status lines are printed. |
13 | E.STATUS.FORE.COLOR | Color literal of status line. |
14 | E.CRTHIGH | Height of CRT. |
15 | E.CRTWIDE | Width of CRT. |
16 | E.LPTRHIGH | Height of PRINTER. |
17 | E.LPTRWIDE | Width of PRINTER. |
18 | E.EDIT.CASE | Flag: case-insensitive edit searches. |
20 | E.DRAG.ATR | No longer used. |
21 | E.EDIT.ATR | PAINT edit attribute color. |
22 | E.ROW.LIMIT | Max. # of rows in a PAINT window. |
23 | E.VIRTUAL.LIMIT | Virtual space limitation. |
24 | E.PAINT.BACKDROP | Paint use a backdrop?; not used. |
25 | E.BACK.ATR.PTR | Backdrop attribute literal; not used. |
26 | E.BACK.ATR | Backdrop attribute esc sequence. |
27 | E.TYPEAHEAD | Type ahead flag. |
28 | E.QUERY.DEPTH | Number of queries to store. |
29 | E.INDEX.TIME | Seconds before bckgrnd indexing. |
30 | E.BACKGRND.TIME | Secs between checks for indexing. |
31 | E.PLAYDELAY | 1/100's sec. for CAPTURE playb. |
32 | E.BG.FORE.COLOR | Color to use with <2>. |
33 | E.DFLT.DICT | Reserved. |
34 | E.BEEPS | Beeping messages if non-NULL. |
35 | E.DFLT.BIND | Default dictionary binding mode. |
3 | 6E.MESSAGE.TIME | Default message time for `T' type. |
37 | E.MENU | Default system menu for windows. |
38 | E.TCL.ON | Flag: TCL on from INPUT.CHAR. |
39 | E.ENABLE.MACRO.EXEC | Flag: macros playback. |
40 | E.CAPTURE.ON | Flag: KEY CAPTURE process. |
41 | E.ENABLE.MACRO.BUILD | Flag: MACRO building enabled. |
42 | E.SELECT.FLUSH.ON | Flag: flush ind. trans. before select. |
43 | E.DOS.SORT.VOL | DOS volume for temp. sort files. |
44 | E.EDIT.SNAPSHOTS | Flag: EDIT snapshots while exiting. |
45 | E.LINE.WRAP | If true, EDIT will auto wrap lines. |
46 | E.LINE.INDENT | If true, EDIT will auto indent lines. |
47 | E.LINE.INSERT | If true, EDIT will auto insert lines. |
48 | E.DEFAULT.MACRO | Macro to be loaded at logon. |
49 | E.SYS.MENU.POPUP | Flag: sys. menus on menu. |
50 | E.STATUS.BACK.COLOR | status line background color. |
51 | E.DEFAULT.DATA.VOL | Default data volume. |
52 | E.XX | Reserved. |
53 | E.SUPPRESS.NONNUMERIC | Suppress nonnumeric messages. |
54 | E.SUPPRESS.SYSTEM.MSGS | Suppress system error messages. |
55 | E.QUERY.BOTTOM | Flag: prompt for QUERY in border. |
56 | E.QUERY.CHAR | Flag: print this as QUERY mask. |
57 | E.QUERY.SEL.CODE | Catalyst code for Query Select. |
58 | E.QUERY.SEL.CMD | Command used for Query Select. |
59 | E.VIEW.MODE | Flag: R/LIST in View window. |
60 | E.VIEW.RLIST.CODE | Catalyst code, default View. |
61 | E.VIEW.RLIST.CMD | The command assoc. with <60>. |
62 | E.HELP.LEVEL | Help Level @HELP.LEVEL. |
63 | E.DESTRUCT.EDIT | Flag: editor erases line. |
64 | E.FKEY.FGROUND | Help 1/2 status line fkey foregrnd. |
65 | E.FKEY.BGROUND | Help 1/2 status line fkey backgrnd. |
66 | E.TRANS.VOL | Transaction volume name. |
67 | E.UNLOCK.ALL.COMMIT | Flag: UNLOCK ALL at commit. |
68 | E.DEADLOCK.CHECK | Seconds between deadlock checks. |
69 | E.LOCK.TIMEOUT | Seconds to transaction time-out. |
70 | E.CONSISTENCY.LEVEL | Locking consistency number. |
72 | E.LOCKING.GOV | # of locks allowed from this station. |
73 | E.AUTOTRANS | Flag: Auto transaction start mode. |
74 | E.DISABLE.LOCK.INT | "Y/N": disable [Esc] key lock int. |
75 | E.DEADLOCK.POSTING | Seconds before deadlock checking. |
76 | E.SHADOWS.ON | Flag: borders displayed w/shadows. |
77 | E.INDEX.CODE | Catalyst code: alter. bckgrnd. |
78 | E.INDEX.CMD | Catalyst command for <77>. |
79 | E.POST.CHECK.CODE | Catalyst code for post index check. |
80 | E.POST.CHECK.CMD | Catalyst command for <79>. |
81 | E.NETCACHE.OPTION | For network cache option. |
82 | E.MSTYLE | menu style for WINUS. |
83 | E.PULLDOWN.NUMBERS | Boolean, number pulldown options. |
84 | E.NULL.DISPLAY.STRING | String to represent SQL NULL val. |
85 | E.MOUSE.ON | Boolean, mouse enable. |
86 | E.MOUSE.DEF | Key to record in SYSTEM file containing mouse definition record. |
87 | E.VIDTYPE | Video card type. |
88 | E.LND.DEFAULT | Active language set name. |
89 | E.LND.LOAD | List of language sets to load into memory. |
90 | E.QUERY.CASE | Query case sensitivity.(true = case insensitive). |
91 | E.TIMEDATE.FMT | TIMEDATE() override format. |
92 | E.PRN.DRVS | List of selected printer drivers. |
93 | E.PRN.LPTNO | Associated list of devices for redirection. |
94 | E.DET | Name of display equivalence table. |
95 | E.SYS.DELIM.SUPPRESS | Boolean, suppress input of system delimiters. |
@DEFAULT.STOPS
@DEFAULT.STOPS is a dynamic array specifying the data to disregard when indexing. The default values are specified at the Environment window.
@INSERT
@INSERT is an @FM-delimited array of information used by the editor. Each field contains a true or false flag, indicating whether a specific mode is active or inactive in the editor. The fields in this array are:
Field | Function |
---|---|
1 | Word wrap. |
2 | Wrap line. |
3 | Insert line. |
4 | Indent line. |
5 | Ignore case. |
@LAST.SELECT.PROCESS
@LAST.SELECT.PROCESS contains the name of the last process executed as a filter.
@MESSAGES
@MESSAGES is a buffer for message records. Frequently used message records may be stored here for rapid retrieval. They are @RM-delimited, and any message may be stored in @MESSAGES by specifying "B"-type as part of its record structure.
@PRIORITY.INT
@PRIORITY.INT is an array of the key or function key sequences defined as priority interrupts. These are:
Field | Description |
---|---|
<1> | General Help [Ctrl-F1]. |
<2> | TCL [F5]. |
<3> | Capture keystrokes toggle [Alt-0]. |
<4> | Edit captured keystrokes [Alt-8]. |
<5> | Play back (execute) the captured keystrokes [Alt-9]. |
<6> | Pause during playback operation [Ctrl-\]. |
<7> | Keystroke conversion toggle [Ctrl -]. |
<8> | Edit the macro key set [Alt-M]. |
<9> | Start of defined macro keys [Alt -1] to [Alt-5]. |
Video Window Attributes
There are eight system variables that define the video attributes for a specific window environment:
Field | Description |
---|---|
@PW | Popup windows. |
@MW | Menu windows. |
@EW | Message windows. |
@HW | Help windows. |
@AW | Application windows. |
@XW | Edit and Zoom windows. |
@VW | Multivalue windows. |
@SW | Subvalue windows. |
These variables are identically structured arrays. The fields are described below:
Field | Description |
---|---|
<1> | Border. |
<2> | Title. |
<3> | Background. |
<4> | Comment text for @HW; Highlight bar for @PW; Prompt label for @AW. |
<5> | Multiple selections for @PW; Index verification for @AW. |
<6> | Non-selected values for @PW and @MW; Message text for @EW. |
<7> | Labels for @AW; Quoted description for @MW. |
<8> | Text in @HW; Prompt entries for @AW. |
<9> | Border type (one of five types). |
<10> | Reverse video setting for current background video attribute in <3>. |
@STATLIST
@STATLIST is a buffer for status list templates defined in the STATUS.LIST record of the SYSTEM file. These templates are loaded into @STATLIST at login.
The @STATLIST variable is composed of two or more records. The first record is as follows:
Field | Description |
---|---|
<1> | A value mark delimited list of status lines in memory. |
<2> | A pointer to the record containing the status line information. |
The remaining records contain information about each status line. The structure of each record is as follows:
Field | Description |
---|---|
<1> | A unique name for a status line template. |
<2> | Information to display in each cell. Data is @VM-delimited and padded with spaces to the full length of each cell. Extra spaces will be truncated. |
<3> | Format information. This field contains values and subvalues. |
Each status line record is delimited by a record mark (@RM).