SYSTEM()

SYSTEM()

Top  Previous  Next

 

The SYSTEM() function returns information regarding the status of various aspects of the system.

 

 

Format

 

SYSTEM(key)

 

where

 

keyidentifies the information to be returned.

 

 

The SYSTEM() function is provided for compatibility with other data management products. Many of the key values correspond to those found in other multivalue database products though some values are implemented inconsistently across products. Values 1000 and above are usually specific to QM.

 

The following key values are implemented. All other key values return a zero value. There are tokens defined for these key values in the SYSCOM KEYS.H include record.

 

Key        Function

1Returns 1 if a PRINTER ON statement is in effect
2Current page width of the default print unit
3Current page length of the default print unit
4Lines remaining on current page of the default print unit
5Current page number of the default print unit
6Current line number of the default print unit
7Terminal type (same as @TERM.TYPE)
9Cumulative processor time used (mS) by this QM session
10Input waiting in the DATA queue?  (1 if so, 0 if not)
11Select list 0 active? (1 if so, 0 if not)
12Time in seconds since midnight (same as TIME())
13Relinquish timeslice. Always returns 1.
14Returns the number of characters in the type-ahead buffer. This is unreliable for piped input.
16Returns the command processor level (same as @LEVEL)
19Returns a unique value formed from the internal form date and time in the user's time zone as two five digit numbers. If the function is used more than once system wide in the same second, an alphabetic suffix is added to create a unique value. This function is unreliable in applications where users span multiple time zones.
20Returns the system wide reference number for last print job passed to the operating system spooler (Linux only). See also the PU$SEQNO key to GETPU().
21Returns a unique value formed from the internal form date and a sequential number that resets each day.
22User number (same as @USERNO)
23Break key enabled? (1 if so, 0 if not)
24Input echo enabled? (1 if so, 0 if not)
25Is this a phantom process?
26Returns the current input prompt character
27Returns the operating system uid for the user's process. (Not Windows)
28Returns the operating system effective uid for the user's process. (Not Windows)
29Returns the operating system gid for the user's process. (Not Windows)
30Returns the operating system effective gid for the user's process. (Not Windows)
31Licence number
32Returns the system (QMSYS) directory pathname
33Returns the name of the program that called this subroutine
38Returns temporary directory pathname
42Returns telnet connection IP address, null for a console user
45Returns the program catalogue name or pathname if not catalogued.
91Returns 1 on Windows, 0 on other platforms
1000Returns 1 if EXECUTE CAPTURING is in effect, 0 otherwise
1001Returns 1 if case inversion is enabled, 0 otherwise
1002Returns the program call history. This is a dynamic array in which each program is represented by a field, the current program being in field 1. The first value in each field contains the program name. Subsequent values are divided into two subvalues containing the program address and line number (where available) for each internal subroutine call (GOSUB) in the program. The first value in each field has an additional third subvalue containing the compile time of the program as an epoch value.
1003Returns a dynamic array containing a list of open files. Each field has two values; the first holds the internal file number, the second holds the file's pathname.
1004Returns the peak number of files that have been open at one time since QM was started.
1005Returns the combined date and time value as DATE() * 86400 + TIME() based on the user's time zone.
1006Returns 1 if running on a Windows NT style system (XP and later). This will always be true on Windows as earlier releases are no longer supported.
1007Returns the current transaction number, zero if not in a transaction.
1008Returns the current transaction nesting level, zero if not in a transaction.
1009Returns the system byte ordering, 1 for high byte first, 0 for low byte first.
1010Returns the platform name; Windows, Linux, FreeBSD, AIX, Mac, PDA, Solaris, Rpi.
1011Returns the pathname of the QM configuration file
1012Returns the QM version number.
1013Returns user limit, excluding users reserved for phantom processes.
1014Returns user limit, including users reserved for phantom processes.
1015Returns the name of the host computer system.
1016Returns the remaining number of licensed non-phantom users.
1017Returns the tcp/ip port number for a socket connection.
1018Returns the device licensing connection limit.
1019Returns the offset in seconds of the user's local time zone from UTC. This will be negative for zones to the west of longitude zero.
1020Returns the time of day in milliseconds since midnight UTC.
1021Returns the currently selected ECS base map name. On a non-ECS system, this returns the current map name, null if using the default map.
1022Returns the unique qmid value for a user mode installation of QM, zero for a standard installation.
1023Returns True on 64 bit systems, False on 32 bit systems.
1024Returns the current working directory pathname when QM was entered.
1025Returns a dynamic array where field 1 is a multivalued list of environment variable names and field 2 is a corresponding list of their values.
1026Returns xxx when QM is entered using "qm xxx".
1027Returns the name of the serial port when logged in on a serial connection.
1028Returns the system id of the active QM licence, zero if the licence is not system specific.
1029Returns the current internal subroutine depth.
1030Returns login time as date * 86400 + time in the user's local time zone using Pick date numbering.
1031Returns operating system process id.
1032Returns and clears the break pending flag, set if the break key is pressed with breaks disabled.
1033Returns True if a COMO file is active.
1034Returns True if COMO output is active but suspended.
1035Returns the time as seconds since 00:00:00 on January 1 1970, Universal Coordinated Time (UTC) independent of the user's time zone. Same as the EPOCH() function.
1036Returns the period in tenths of a second for which login was delayed waiting for a spare user. See the LGNWAIT configuration parameter.
1037Returns a dynamic array with one field for each open QM file. In each field, value 1 holds the internal file number, value 2 holds the file pathname and value 3 is a subvalue mark delimited list of QM user numbers for which the file is open.
1038Returns login time as an epoch value.
1040Returns True if operating system filenames are case insensitive.
1041Used on a replication publisher system, returns a field mark delimited list of replication subscribers actively transferring data.
1042Returns the system id of the server. This will differ from SYSTEM(1028) for a USB installation or a licence that is not system specific.
1043Returns the current CSV mode that determines quoting rules as set by CSV.MODE.
1044Returns True if the system is running in ECS mode.
1045Returns time at which QM was started as an epoch value.
1046Returns the current CSV delimiter character set by CSV.MODE.
1047Returns a globally unique identifier (GUID) string. Platforms that do not support this operation return a null string.
1048Returns a rolling sequence number that is unique across all sessions until QM is restarted when it is reset to 1.
1049Returns True if HUSH is in effect, otherwise returns False.
1050Returns True if the current user is a QM system administrator, otherwise returns False. This will be True if any of...

a) The user is an administrator at the operating system level.

b) The user logs in via a Windows QMConsole session.

c) The user is defined as an administrator using the ADMIN.USER command.

d) QM security is disabled (see the SECURITY command).

1051Returns True if QM is running as a USB installation.
1052Returns count of direct descendant child (phantom) processes.
1053Returns the highest user number that can be assigned on this system.
1054Returns field mark delimited list of active packages.
1055Returns a field mark delimited dynamic array containing statistical information related to the LGNWAIT configuration parameter:
1The number of times login has been delayed.
2The number of successful logins.
3The number of processes currently delayed waiting for login.
4The peak number of processes waiting for login.
5The number of login attempts that failed after waiting.
1056Returns a field mark delimited dynamic array containing user count information:
1The number of interactive users.
2The number of QMClient users.
3The number of interactive phantom users.
4The number of non-interactive phantom users.
5The peak number of concurrent licensed users.
1057Returns the parent process user number, zero if the current process is not a phantom or the parent has terminated.
1058Returns a field mark delimited list of child phantom process user numbers.
1059Returns the system licence site text.
1060Returns the pool name for a QMClient connection pooling session.
1061Returns QMSYS drive letter on Windows, null elsewhere. Same as @DRIVE
1062Returns and clears cross-process application signal state.
1065Returns diagnostic data from the transaction cache as a dynamic array. Each field represents a cached action and is formed from four value mark separated items; the transaction number, file number, id and mode (D = delete, W = write). Use SYSTEM(1003) to translate file numbers to pathnames.
1066Returns last form queue number assigned with SP.ASSIGN.
1067Returns default group size in bytes.
1068Returns Proc output buffer status. True if secondary buffer is active.
1069Returns Proc input buffer status. True if secondary buffer is active.
1070Returns the current PRECISION setting.
1071Returns a dynamic array of file information after OSREAD.
1072Returns the IP address on which QM listens for incoming telnet, QMClient, QMNet and replication connections. Null if listening on all configured IP addresses. See the IPADDR configuration parameter.
1073Returns a field mark delimited list of grouped child phantom process user numbers.
1075Returns a dynamic array of connection pooling configuration information, one field per pool with values for name, connection limit, timeout and current idle process count.
1076Returns the current CALL depth.
1077Returns a field mark delimited list of group names to which the user belongs (not Windows).
1078Returns a field mark delimited list of group numbers to which the user belongs (not Windows).
1079Is this a QMClient process?
1080Returns True if program was started directly or indirectly from a Proc, else returns False.

 

QM allows users to add definitions for their own SYSTEM() function key values by writing a QMBasic subroutine that performs whatever processing is required. This subroutine takes two arguments. The first is used to return the result and the second is the key value passed in. This subroutine must be catalogued as $SYSTEM.