HP 3000 Manuals HP 3000 Manuals
Appendix A Predefined Variables
Various abbreviations are used in the type column of the following table
to distinguish a variable's type and characteristics. The data types are
identified as follows:
I - Integer format.
B - Boolean format (TRUE/FALSE).
S - String (ASCII) format.
No predefined variables can be deleted. The following abbreviations
specify whether a variable can be modified or not:
R - Read only variable (cannot be modified).
W - Read/write variable (can be modified).
Any variables that cannot be altered or retrieved programmatically
through the HPCIGETVAR or HPCIPUTVAR intrinsics are identified by the
notation (NP). (Note that these variables can be accessed through the
HPCICOMMAND and COMMAND intrinsics.)
Job control words are identified in the following table by the
abbreviation JCW. They may be considered integer variables with legal
values ranging from 0 to 65,535 and with bits 16 and 17 (bit 0 being the
leftmost bit of 32 bits) having special interpretations. (For example,
if bit 16 is set, the JCW setting is FATAL.)
Table A-1. Predefined Variables
-------------------------------------------------------------------------------------------------
| | | | |
| Variable | Type | Definition | Initial Value |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| CIERROR | W JCW | last CI error number | zero |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPACCOUNT | R S | user's account name | logon account |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPACCTCAP | R I | current account capability mask | logon account |
| | | | capabilities |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPACCTCAPF | R S | current account capability | formatted logon |
| | | formatted, for example, "AM, AL, | account |
| | | GL, ND, SF, BA, IA" | |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPAUTOCONT | W B (NP) | enables (TRUE) / disables (FALSE) | FALSE |
| | | the automatic CONTINUE feature | |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPCIDEPTH | R I | number of nested CIs | 1(=Root CI) |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPCIERR | W I | contains the most recent CI | zero |
| | | related error; similar to CIERROR | |
| | | except warnings are negative | |
| | | numbers and errors are posistive | |
| | | numbers | |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPCIERRCOL | W I | contains the column number of the | zero |
| | | offending parameter for the most | |
| | | recent CI command error | |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPCIERRMSG | R S | textual message for the most | (null) |
| | | recent CIERROR (length of message | |
| | | is 0 for nonexistent CIERROR | |
| | | values) | |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPCMDNUM | R I (NP) | current command sequence number | 1 |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPCMDTRACE (subject | W B (NP) | enables (TRUE) /disables (FALSE) | FALSE |
| to change in future | | the User Command Tracing facility | |
| releases) | | | |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPCMEVENTLOG | W I | when set to n $STDLIST displays | zero |
| | | the following n occurrences of | |
| | | tos/reg trap | |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPCONNMINS | R I | current session connect time in | zero |
| | | minutes | |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPCONNSECS | R I | current session connect time in | zero |
| | | seconds | |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPCONSOLE | R I | LDEV of the console | console ldev at logon |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPCONTINUE | R B (NP) | CI's continue state: | FALSE |
| | | FALSE=inactive, TRUE=active | |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPCPUNAME | R S | name of computer model, for | name of your logon |
| | | example, "SERIES 960" | computer model |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPCPUMSECS | R I | from root CI = current session CPU | zero |
| | | time in milliseconds; from other | |
| | | CI or process = current process | |
| | | CPU time in milliseconds | |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPCPUSECS | R I | from root CI = current session CPU | zero |
| | | time in seconds; from other CI or | |
| | | process = current process CPU time | |
| | | in seconds | |
| | | | |
-------------------------------------------------------------------------------------------------
Table A-1. Predefined Variables (cont.)
-------------------------------------------------------------------------------------------------
| | | | |
| Variable | Type | Definition | Initial Value |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPCWD | R S | The HPCWD variable displays your | HFS syntax of logon |
| | | current working directory name in | group |
| | | the HFS (Hierarchical File System) | |
| | | convention. Because your current | |
| | | working directory is not shown by | |
| | | the SHOWME command, you may want | |
| | | to display it in your prompt by | |
| | | executing this command: | |
| | | | |
| | | SETVAR hpprompt "!!hpcwd:" | |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPDATE | R I | current day of month | logon day of the |
| | | | month |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPDATEF | R S | current formatted date | logon date |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPDAY | R I | current day of the week (1=SUNDAY) | logon day of the week |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPDTCPORTID | R S | port id of data terminal | null string |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPDUPLICATIVE | R B | duplicative (TRUE)/ nonduplicative | as appropriate |
| | | (FALSE) | |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPERRDUMP | W I (NP) | number of errors to be dumped from | zero |
| | | process error stack | |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPERRSTOLIST | W B | destination to which errors are to | TRUE |
| | | be written: TRUE=$STDLIST; | |
| | | FALSE=$STDERR | |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPEXECJOBS | R I | number of jobs and sessions | number of jobs and |
| | | currently in EXEC (executing) | sessions in EXEC |
| | | state | state |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPFILE | R S | contains the fully qualified file | empty string |
| | | name of the currently executing | |
| | | command file or UDC file. If you | |
| | | are not in a UDC or command file, | |
| | | HPFILE returns an empty string. | |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPFSERR | W I | file system error number for last | zero |
| | | CI command to generate file system | |
| | | error or warning | |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPGROUP | R S | current group name | logon group name |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPGROUPCAP | R I | current group capability mask | logon group caps |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPGROUPCAPF | R S | current group formatted capability | logon group caps |
| | | mask, for example, "IA,BA,PH" | |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPHGROUP | R S | home group name | home group |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPHOUR | R I | current hour number (24-hour | logon hour |
| | | clock) | |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPINBREAK | R B (NP) | FALSE=not in BREAK, TRUE=in BREAK | FALSE |
| | | mode (includes process BREAK and | |
| | | rit BREAK) | |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPINPRI | R I | input priority | logon input priority |
| | | | |
-------------------------------------------------------------------------------------------------
Table A-1. Predefined Variables (cont.)
-------------------------------------------------------------------------------------------------
| | | | |
| Variable | Type | Definition | Initial Value |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPINTERACTIVE | R B | interactive (TRUE)/ noninteractive | as appropriate |
| | | (FALSE) | |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPINTRODATE | R S | formatted job/session logon date | date of logon |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPINTROTIME | R S | formatted job/session logon time | time of logon |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPJOBCOUNT | R I | number of jobs executing | logon number of |
| | | | executing jobs |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPJOBFENCE | R I | fence value for waiting jobs | logon jobfence |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPJOBLIMIT | R I | current job limit | job limit at logon |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPJOBNAME | R S | name of current job/session | logon job name |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPJOBNUM | R I | job/session number, for example, | your job/session |
| | | 12 | number |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPJOBTYPE | R S | "S"=session, "J"=job | your job type |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPLDEVIN | R I | LDEV number for $STDIN | logon input LDEV |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPLDEVLIST | R I | LDEV number for $STDLIST | logon output LDEV |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPMINUTE | R I | current minute number | logon minute |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPMONTH | R I | current month number | logon month |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPMSGFENCE | W I (NP) | fence for the level of error | 0=all errors and |
| | | messages printed by the CI: | warnings are printed |
| | | 0=errors/warnings, 1=errors only, | |
| | | 2=no error/warning messages | |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPNCOPIES | R I | number of $STDLIST copies for jobs | copies subparm of the |
| | | | outclass= parm of the |
| | | | JOB command |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPOUTCLASS | R S | output device class | logon output device |
| | | | class |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPOUTFENCE | R I | output fence value | logon output fence |
| | | | value |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPPATH | W S | search path for command files and | "!hpgroup,pub, |
| | | implied RUN | pub.sys" |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPPIN | R I | returns the process identification | empty string |
| | | number of the currently executing | |
| | | process. | |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPPROMPT | W S | CI's prompt string | ":" (colon) |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPQUIET | R B | boolean indicating if session is | TRUE |
| | | accepting messages: FALSE = | |
| | | accepting messages; TRUE = not | |
| | | accepting messages | |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPREDOSIZE | W I | number of entries in the CI's redo | 20 |
| | | stack | |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPRESULT | W S, W | value of the most recent CALC | zero |
| | I, or W | command evaluated (for example, | |
| | B | "abc", 12, TRUE) | |
| | | | |
-------------------------------------------------------------------------------------------------
Table A-1. Predefined Variables (cont.)
-------------------------------------------------------------------------------------------------
| | | | |
| Variable | Type | Definition | Initial Value |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPSCHEDJOBS | R I | number of jobs currently in SCHED | number of jobs in |
| | | state (scheduled state) | SCHED state |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPSESCOUNT | R I | number of sessions executing | logon number of |
| | | | sessions executing |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPSESLIMIT | R I | current session limit | session limit at |
| | | | logon |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPSTDIN | R S | file name or formal file | $STDIN |
| | | designator to which input has been | |
| | | redirected, names for $STDIN | |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPSTDLIST | R S | file name or formal file | $STDLIST |
| | | designator to which output has | |
| | | been redirected, names for | |
| | | $STDLIST | |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPSUSAN | R S | unique serial number assigned at | unique serial number |
| | | the factory to each system for use | assigned to your |
| | | by software | system at manufacture |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPSUSPJOBS | R I | current number of jobs in SUSP | numbers of jobs in |
| | | state (suspended) | SUSP state at logon |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPSYSNAME | W S | name of computer system | null string (" ") |
| | | (user-definable) | |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPSYSTIMEOUT | R I | reads from the sysgen | zero, means unlimited |
| | | configuration file what the | time. |
| | | minimum timeout is on the system. | |
| | | Works with HPTIMEOUT which | |
| | | controls the CI timed reads. | |
| | | HPSYSTIMEOUT is a minimum cap on | |
| | | HPTIMEOUT. HPTIMEOUT cannot be | |
| | | less than HPSYSTIMEOUT. | |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPTIMEF | R S | current formatted time | logon time |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPTIMEOUT | W I | number of minutes for CI reads | zero |
| | | (HPTIMEOUT=0 means no timeout) | |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPTYPEAHEAD | W B | boolean indicating if typeahead is | FALSE |
| | | turned on | |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPUSER | R S | current user name | logon user |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPUSERCAP | R I | current user's capability mask | logon user caps |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPUSERCAPF | R S | current user's formatted | logon user caps |
| | | capability mask, for example, | |
| | | "IA,BA,PH" | |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPUSERCMDEPTH | R I (NP) | number of nested UDCs and/or | zero |
| | | command files | |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPUSERCOUNT | R I | current number of licensed users | licensed users |
| | | accessing the system | |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPUSERLIMIT | R I | legal (licensed) limit of | legal user limit |
| | | concurrent users allowed access to | |
| | | the system, can be accessed | |
| | | programmatically | |
| | | | |
-------------------------------------------------------------------------------------------------
Table A-1. Predefined Variables (cont.)
-------------------------------------------------------------------------------------------------
| | | | |
| Variable | Type | Definition | Initial Value |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPVERSION | R S | MPE XL version ID (v.uu.ff) | current MPE XL |
| | | | version |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPWAITJOBS | R I | current number of jobs waiting | number of jobs |
| | | | waiting at logon time |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| HPYEAR | R I | last two digits of the current | logon year number |
| | | year | |
| | | | |
-------------------------------------------------------------------------------------------------
| | | | |
| JCW | W JCW | job control word (variable) | zero |
| | | | |
-------------------------------------------------------------------------------------------------