HPlogo Command Interpreter Access and Variables Programmer's Guide: Series HP 3000 Computer Systems

Appendix A Predefined Variables

» 

Technical documentation

Complete book in PDF
» Feedback

 » Table of Contents

 » Index

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

VariableTypeDefinitionInitial Value
CIERRORW JCWlast CI error numberzero
HPACCOUNTR Suser's account namelogon account
HPACCTCAPR Icurrent account capability masklogon account capabilities
HPACCTCAPFR Scurrent account capability formatted, for example, "AM, AL, GL, ND, SF, BA, IA"formatted logon account
HPAUTOCONTW B (NP)enables (TRUE) / disables (FALSE) the automatic CONTINUE featureFALSE
HPCIDEPTHR Inumber of nested CIs1(=Root CI)
HPCIERRW Icontains the most recent CI related error; similar to CIERROR except warnings are negative numbers and errors are posistive numberszero
HPCIERRCOLW Icontains the column number of the offending parameter for the most recent CI command errorzero
HPCIERRMSGR Stextual message for the most recent CIERROR (length of message is 0 for nonexistent CIERROR values)(null)
HPCMDNUMR I (NP)current command sequence number1
HPCMDTRACE (subject to change in future releases) W B (NP)enables (TRUE) /disables (FALSE) the User Command Tracing facilityFALSE
HPCMEVENTLOGW Iwhen set to n$STDLIST displays the following n occurrences of tos/reg trapzero
HPCONNMINSR Icurrent session connect time in minuteszero
HPCONNSECSR Icurrent session connect time in secondszero
HPCONSOLER ILDEV of the consoleconsole ldev at logon
HPCONTINUER B (NP)CI's continue state: FALSE=inactive, TRUE=activeFALSE
HPCPUNAMER Sname of computer model, for example, "SERIES 960"name of your logon computer model
HPCPUMSECSR Ifrom root CI = current session CPU time in milliseconds; from other CI or process = current process CPU time in millisecondszero
HPCPUSECSR Ifrom root CI = current session CPU time in seconds; from other CI or process = current session CPU time in secondszero
HPCWDR S

The HPCWD variable displays your current working directory name in 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:"
HFS syntax of logon group
HPDATER Icurrent day of monthlogon day of the month
HPDATEFR Scurrent formatted datelogon date
HPDAYR Icurrent day of the week (1=SUNDAY)logon day of the week
HPDTCPORTIDR Sport id of data terminalnull string
HPDUPLICATIVER Bduplicative (TRUE)/ nonduplicative (FALSE) as appropriate
HPERRDUMPW I (NP)number of errors to be dumped from process error stackzero
HPERRSTOLISTW Bdestination to which errors are to be written: TRUE=$STDLIST; FALSE=$STDERRTRUE
HPEXECJOBSR Inumber of jobs and sessions currently in EXEC (executing) statenumber of jobs and sessions in EXEC state
HPFILER Scontains the fully qualified file 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. empty string
HPFSERRW Ifile system error number for last CI command to generate file system error or warningzero
HPGROUPR Scurrent group namelogon group name
HPGROUPCAPR Icurrent group capability masklogon group caps
HPGROUPCAPFR Scurrent group formatted capability mask, for example, "IA,BA,PH"logon group caps
HPHGROUPR Shome group namehome group
HPHOURR Icurrent hour number (24-hour clock)logon hour
HPINBREAKR B (NP)FALSE=not in BREAK, TRUE=in BREAK mode (includes process BREAK and rit BREAK)FALSE
HPINPRIR Iinput prioritylogon input priority
HPINTERACTIVER Binteractive (TRUE)/ noninteractive (FALSE)as appropriate
HPINTRODATER Sformatted job/session logon datedate of logon
HPINTROTIMER Sformatted job/session logon timetime of logon
HPJOBCOUNTR Inumber of jobs executing logon number of executing jobs
HPJOBFENCER Ifence value for waiting jobslogon jobfence
HPJOBLIMITR Icurrent job limitjob limit at logon
HPJOBNAMER Sname of current job/sessionlogon job name
HPJOBNUMR Ijob/session number, for example, 12your job/session number
HPJOBTYPER S"S"=session, "J"=jobyour job type
HPLDEVINR ILDEV number for $STDINlogon input LDEV
HPLDEVLISTR ILDEV number for $STDLISTlogon output LDEV
HPMINUTER Icurrent minute numberlogon minute
HPMONTHR Icurrent month numberlogon month
HPMSGFENCEW I (NP)fence for the level of error messages printed by the CI: 0=errors/warnings, 1=errors only, 2=no error/warning messages0=all errors and warnings are printed
HPNCOPIESR Inumber of $STDLIST copies for jobscopies subparm of the outclass= parm of the JOB command
HPOUTCLASSR Soutput device classlogon output device class
HPOUTFENCER Ioutput fence valuelogon output fence value
HPPATHW Ssearch path for command files and implied RUN"!hpgroup,pub, pub.sys"
HPPINR Ireturns the process identification number of the currently executing process.empty string
HPPROMPTW SCI's prompt string":" (colon)
HPQUIETR Bboolean indicating if session is accepting messages: FALSE = accepting messages; TRUE = not accepting messagesTRUE
HPREDOSIZEW Inumber of entries in the CI's redo stack 20
HPRESULTW S, W I, or W Bvalue of the most recent CALC command evaluated (for example, "abc", 12, TRUE) zero
HPSCHEDJOBSR Inumber of jobs currently in SCHED state (scheduled state) number of jobs in SCHED state
HPSESCOUNTR Inumber of sessions executing logon number of sessions executing
HPSESLIMITR Icurrent session limitsession limit at logon
HPSTDINR Sfile name or formal file designator to which input has been redirected, names for $STDIN$STDIN
HPSTDLISTR Sfile name or formal file designator to which output has been redirected, names for $STDLIST$STDLIST
HPSUSANR Sunique serial number assigned at the factory to each system for use by softwareunique serial number assigned to your system at manufacture
HPSUSPJOBSR Icurrent number of jobs in SUSP state (suspended)numbers of jobs in SUSP state at logon
HPSYSNAMEW Sname of computer system (user-definable)null string (" ")
HPSYSTIMEOUTR Ireads from the sysgen configuration file what the 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.zero, means unlimited time.
HPTIMEFR Scurrent formatted timelogon time
HPTIMEOUTW Inumber of minutes for CI reads (HPTIMEOUT=0 means no timeout)zero
HPTYPEAHEADW Bboolean indicating if typeahead is turned onFALSE
HPUSERR Scurrent user namelogon user
HPUSERCAPR Icurrent user's capability masklogon user caps
HPUSERCAPFR Scurrent user's formatted capability mask, for example, "IA,BA,PH"logon user caps
HPUSERCMDEPTHR I (NP)number of nested UDCs and/or command fileszero
HPUSERCOUNTR Icurrent number of licensed users accessing the systemlicensed users
HPUSERLIMITR Ilegal (licensed) limit of concurrent users allowed access to the system, can be accessed programmaticallylegal user limit
HPVERSIONR SMPE XL version ID (v.uu.ff)current MPE XL version
HPWAITJOBSR Icurrent number of jobs waitingnumber of jobs waiting at logon time
HPYEARR Ilast two digits of the current yearlogon year number
JCWW JCWjob control word (variable)zero

 

Feedback to webmaster