MPE/iX Commands Reference Manual > Appendix A Predefined Variables in MPE/iX

Appendix A Predefined Variables in MPE/iX

	MPE documents
	Complete PDF
	Table of Contents
	Index

Many variables have been predefined for use by the command interpreter. They may be used anywhere you would use your own variables. Table A-1 "Predefined Variables" lists all valid predefined variables.

Table A-1 Predefined Variables

Variable	Type^[1]	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 caps
`HPACCTCAPF`	R S	current account formatted capability mask, for example, "AM, AL, GL, ND, SF, BA, IA"	logon account caps
`HPAUTOCONT`	W B PL	enables (TRUE); disables (FALSE) the automatic `CONTINUE` feature	FALSE
`HPCIDEPTH`	R I PL	number of nested CIs	1(=Root CI)
`HPCIERR`	W I	last CI error/warning in current session	zero
`HPCIERRCOL`	W I	error column number for last CI error/warning	zero
`HPCIERRMSG`	R S	textual message for the most recent `CIERROR` (length of message is 0 for nonexistent `CIERROR` values)	(null)
`HPCMDNUM`	R I PL	current command sequence number	1
`HPCMDTRACE`	W B PL	enables (TRUE); disables (FALSE) the User Command Tracing facility	FALSE
`HPCMEVENTLOG`	W I	when set to `n`, `$STDLIST` displays the following `n` occurrences of tos/reg trap	zero
`HPCONNMINS`	R I	current session connect-time in minutes	zero
`HPCONNSECS`	R I	current session connect-time in seconds	zero
`HPCONSOLE`	R I	LDEV of the console	console LDEV at logon
`HPCONTINUE`	R B PL	CI's continue state: FALSE=inactive, TRUE=active	FALSE
`HPCPUNAME`	R S	name of computer model, for example, "SERIES 930"	name of your logon computer model
`HPCPUMSECS`	R I	from root CI = current session CPU-time in milliseconds; from other CI or process = current process CPU-time in milliseconds	zero
`HPCPUSECS`	R I	from root CI = current session CPU-time in seconds; from other CI or process = current process CPU-time in seconds	zero
`HPCWD`	R S	current working directory	logon group and account
`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 PL	indicates whether or not input operations are echoed to a correspondind device; TRUE (duplicative)= echoing occurs; FALSE (nonduplicative)= no echoing occurs	as appropriate
`HPERRDUMP`	W I PL	number of errors to be dumped from process error stack	zero
`HPERRTOSLIST`	W B PL	controls destination of CI error messages: TRUE=errors written to $STDLIST, FALSE=errors written to $STDERR	TRUE
`HPEXECJOBS`	R I	number of jobs and sessions currently in EXEC (executing) state	number of jobs and sessions in EXEC state
`HPFILE`	R S	currently executing UDC or command file	null string
`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 mask, for example, "IA,BA,PH"	logon group caps
`HPHGROUP`	R S	home group name	home group
`HPHOUR`	R I	current hour number (24-hour clock)	logon hour
`HPINBREAK`	R B PL	FALSE=not in BREAK; TRUE=in BREAK mode (includes process BREAK and rit BREAK)	FALSE
`HPINPRI`	R I	input priority	logon input priority
`HPINTERACTIVE`	R B PL	interactive (TRUE); noninteractive (FALSE)	as appropriate
`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, 12	your job/session number
`HPJOBTYPE`	R S	"S"=session, "J"=job	your job type
`HPLASTJOB`	W S	job ID of the job you most recently streamed in the form `#Jnnnn`	null string
`HPLASTSPID`	R S	spoolfile ID for the job identified in the `HPLASTJOB` variable	spoolfile ID of last job
`HPLDEVIN`	R I	LDEV number for `$STDIN`	logon input LDEV
`HPLDEVLIST`	R I	LDEV number for `$STDLIST`	logon output LDEV
`HPLOCIPADDR`	R S	IP address of a remote client	null string
`HPLOCPORT`	R I	TCP port number for network service provided to the client	0 if local client; otherwise standard port used by service
`HPMINUTE`	R I	current minute number	logon minute
`HPMONTH`	R I	current month number	logon month
`HPMSGFENCE`	W I PL	fence for the level of error messages printed by the CI: See `HELP HPMSGFENCE` for values and expression evaluation diagnostics	0
`HPNCOPIES`	R I	number of `$STDLIST` copies for jobs	`copies` subparm of the `outclass=` parm of the `JOB` command
`HPOSVERSION`	R S	operating system version ID (identical to the middle version string in the `SHOWME` banner	current full version ID of the operating system
`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 implied RUN	`"!HPGROUP,PUB,PUB.SYS, ARPA.SYS"`
`HPPIN`	R I	Process Identification Number for the executing process	PIN for the root CI
`HPPROMPT`	W S	CI's prompt string	"`:`" (colon)
`HPQUIET`	R B	indicates if session is accepting messages: FALSE= accepting messages; TRUE= not accepting messages ("quiet")	FALSE
`HPREDOSIZE`	W I PL	number of entries in the CI's redo stack	20
`HPRELVERSION`	R S	operating system release version ID (identical to the left version string in the `SHOWME` banner	current full version ID of the operating system
`HPREMIPADDR`	R S	IP address of the remote user	null string
`HPREMPORT`	R I	TCP port number, assigned by the client, used on an incoming connection	0 if local client; otherwise the assigned TCP port number
`HPRESULT`	W S I or B	value of the most recent `CALC` command evaluated (for example, "abc", 12, TRUE)	zero
`HPSCHEDJOBS`	R I	number of jobs currently in SCHED state (scheduled state)	number of jobs in SCHED state
`HPSESCOUNT`	R I	number of sessions executing	logon number of sessions executing
`HPSESLIMIT`	R I	current session limit	session limit at logon
`HPSPOOLID`	R S	spoolfile ID of the current job	job spoolfile ID
`HPSTDIN`	R S	file name for job or session input	$STDIN
`HPSTDLIST`	R S	file name for job or session output listing	$STDLIST
`HPSTREAMEDBY`	R S	user and account name of the person who streamed a job or invoked `STARTSESS`; if "the person" is the initial OPERATOR.SYS logon or a job streamed from the SYSSTART.PUB.SYS file, the job or session ID is replaced by the string `SYSTEM PROCESS`	logon ID of the person who streamed the job
`HPSUSAN`	R I	unique serial number assigned at the factory to each system for use by software	unique serial number assigned to your system at manufacture
`HPSUSPJOBS`	R I	current number of jobs in SUSP state (suspended)	numbers of jobs in SUSP state at logon
`HPSYSNAME`	W S	name of computer system (user-definable)	null string (`" "`)
`HPTIMEF`	R S	current formatted time	logon time
`HPTIMEOUT`	W I PL	number of minutes for CI reads (<=0 means no timeout). When this expires on a CI read, session is logged off.	zero
`HPTYPEAHEAD`	W B	indicates whether or not typeahead is turned on; the `BYE` or `SETVAR` commands reset this variable to FALSE.	FALSE.
`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 capability mask, for example, "IA,BA,PH"	logon user caps
`HPUSERCMDEPTH`	R I PL	number of nested UDCs and/or command files	zero
`HPUSERCOUNT`	R I	number of current online users	0 if user-based pricing is `not` installed; otherwise the number of current users
`HPUSERLIMIT`	R I	limit of number of online users	-1 if user-based pricing is `not` installed; otherwise the user limit number
`HPVERSION`	R S	MPE/iX version id (`v.uu.ff`)	current MPE/iX 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 year	logon year number
`JCW`	W JCW	job control word (variable)	zero
R [1] READ ONLY variable (cannot be modified). W READ/WRITE variable (can be modified). JCW A standard MPE/iX JCW. I Integer format. B Boolean format (TRUE/FALSE). S String (ASCII) format. PL Process Local. Modifications exist only for the locality of the process.

If a PL variable is changed by a process it returns to its original value when the process terminates. For example, if you logon and set HPREDOSIZE (the number of entries in the CI's redo stack) to 25 and then run a program which sets it to 30 (using the COMMAND or HPCICOMMAND intrinsics) the variable will have the value 30 for that process only. When the process terminates the value of this variable for your session remains at the value it was before the program was run (in this case 25).

PL (process local) variables are not programmatically accessible with the HPCIGETVAR, HPCIPUTVAR, and HPCIDELETEVAR intrinsics. They may be programmatically accessed only with the COMMAND or HPCICOMMAND intrinsics.

Note that HPTYPEAHEAD cannot be set inside a job. All user-created variables may be modified and deleted. However, Hewlett-Packard predefined variables may not be deleted.

JCWs 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) and with bits 0 through 15 reserved.

Commands STREAM thru XEQ

Appendix B Expression Evaluator Functions

Appendix A Predefined Variables in MPE/iX

MPE documents