Using GETCONFIGURE (Functions/Subroutines/Programs)
Created at 14 NOV 1996 02:17PM
GETCONFIGURE
error = GETCONFIGURE( configureRecord )
Using GETCONFIGURE
A function that loads an array with information about the current configuration of the system. This includes much of the information displayed by the TCL WHO command.
configureRecord
This parameter returns an array (@FM-delimited) of information about the current system. The entry CONFIGURE.RECORD.EQUS in the SYSINCLUDE table provides text constants for the positions of this array. The layout is this:
| Pos | Description | Values |
| 1 | System level | Current release level (for example, 3.1). |
| 2 | Updated from | Multivalued field (associated with <2> and <3>) listing the source release level when an update (Maintenance Release) was applied. |
| 3 | Updated to | Associated multivalued field (with <2> and <3> listing the release level after the update. |
| 4 | Update date | Associated multivalued field (with <2> and <3>) listing the dates of updates. |
| 5 | Conversion list | Multivalued list of conversion modules (such as PC-MOS) that have been applied to this system (associated with <6>). |
| 6 | Conversion dates | Multivalued list of dates (associated with <5>) on which conversion modules were applied to this system. |
| 7 | Optional module list | Multivalued list of add-on modules (such as Environmental Bonds) that have been applied to this system. |
| (continued) |
| Pos | Description | Values |
| 8 | Optional module install dates | Multivalued list of dates (associated with <7> and <8>) of when add-on modules were added to the system. |
| 9 | Optional module level | Multivalued list of release levels associated with <7> and <8>) for add-on modules were added to the |
| 10 | System type | 0 = Full development 1 = Runtime 2 = Demo 3 = Single-disk Runtime |
| 11 | Monitor type | 7 = monochrome, any other value = color. |
| 12 | Video adapter type. | 0 = MDA 1 = CGA 2 = EGA 3 = PGA 4 = VGA 5 = MCGA 6 = Unknown |
| 13 | Video mode | 0 = Text (default) 1 = EGA25 2 = EGA43 3 = VGA25 4 = VGA43 5 = VGA50 |
| 14 | Mouse active | True if a mouse has been detected, false otherwise. |
| 15 | Mouse button count. | Number of mouse buttons detected (2 or 3). |
| 16 | Mouse driver version. | As returned by the mouse driver. |
| 17 | Mouse type | 1 = Bus 2 = Serial 3 = InPort 4 = PS/2 5 = HP |
| 18 | Expanded memory in use | True if an EMM driver has been detected, false otherwise. |
| (continued) |
| Pos | Description | Values |
| 19 | EMM window address | Hex address of 16K EMM window (buffer). |
| 20 | EMM overflow buffer 1 address | Hex address of first expanded memory page frame (overflow buffer). |
| 21 | EMM overflow buffer 2 address | Hex address of second expanded memory page frame (overflow buffer). |
| 22 | Expanded memory in use | Bytes of expanded memory currently in use. |
| 23 | Expanded memory allocated | Amount of expanded memory that Advanced Revelation has allocated. |
| 24 | Network type | Name of the network driver currently loaded. |
| 25 | Maximum network users | Number of maximum concurrent users for this copy of Advanced Revelation. (The number to which this copy has been bumped.) |
| 26 | Active language set | Name of the language set currently active (for example, LND_ENGLISH_INT). |
| 27 | Loaded language set | Multivalued list of additional language sets currently loaded. The first value in this list matches the active language set. |
| 28 | Active printer | Name of currently-active printer. (Name of the printer configuration record currently loaded.) |
| 29 | Available printers | Multivalued list of printers available in Advanced Revelation. (Lists the names of the configuration records.) |
| (continued) |
| Pos | Description | Values |
| 30 | Communications port setup | Multivalued list of settings for the default communication port, in this layout: <30,1> baud rate <30,2> data bits <30,3> stop bits <30,4> parity <30,5> Xon/Xoff (0/1) <30,6> strip flag (0/1) <30,7> break count |
| 31 | Rollout file | Name of DOS file for storing the current memory configuration when Advanced Revelation is temporarily suspended. (This is also the value of @ROLLOUT.FILE.) |
| 32 | Screen height | Height (in rows) of the display device. (This is also the value of @CRTHIGH.) |
| 33 | Screen width | Width (in columns) of the display device. (This is also the value of @CRTWIDE.) |
| 34 | Printer page height | Height (in rows) of the logical printer page. (This is also the value of @LPTRHIGH.) |
| 35 | Printer page width | Width (in columns) of the logical printer page. (This is also the value of @LPTRWIDE.) |
| 36 | Index timeout | Number of seconds of idle time that the current workstation waits before launching the background indexing process. A value of 0 means that the current workstation will not begin background indexing. (This is also the value of @INDEX.TIME.) |
| 37 | Background index delay. | Number of seconds that this workstation waits between index updates before checking for further index transactions. (This is also the value of @BACKGROUND.DELAY.) |
| (continued) |
| Pos | Description | Values |
| 38 | Temporary files volume. | Volume or DOS path where this workstation should store temporary work files for sorting, creating View reports in R/LIST, and printing to PostScript printers. |
| 39 | Lock limit | Maximum number of locks (table or row) allowed for this workstation on a network. Zero means there is no limit. |
| 40 | Network cache size | Size in bytes of the network cache for this workstation. Zero means there is no caching. |
| 41 | Printer ports | Multivalued list (associated with <29>) of printer ports for available printers. |
| 42 | Display equivalence table | Name of entry in the SYSPRINTERS table that provides screen output equivalences for printer attribute codes (font attribute table). |
| 43 | Mouse sensitivity | Value between 1 and 100, with 100 the most sensitive (fastest). |
| 44 | Not currently used | |
| 45 | System initialiazation file | Name of INI file (for example, AREVC.INI) that was used when this session started. |
Values returned
The return value for GETCONFIGURE is a single number indicating the success of the operation:
| Value | Meaning |
| 0 | GETCONFIGURE returned OK. |
| 2 | Configuration information cannot be found. |
| 3 | Error in parsing the configuration information. |
| 4 | The INI file for the current workstation is not available. |
Correct use of GETCONFIGURE
declare function getconfigure
error = getconfigure( configureRecord )
if error else
systemLevel = configureRecord< 1 >
if systemLevel < 3.0 then
text = "You must be using version 3.0 or higher for this process!"
call msg( text )
stop
end
end else
text = "Unable to determine the current system configuration!"
call msg( text )
stop
end