The $ZGETJPI function returns an item of job or process information about a specified process. The $ZGETJPI function is analogous to the DCL F$GETJPI lexical function.
The format for the $ZGETJPI function is:
$ZGETJPI(expr1,expr2)
The first expression identifies the PID of the target job, if this argument is a null string (""), $ZGETJPI() returns information about the current process.
The second expression specifies the item keyword identifying the type of information returned; keywords may be upper-, lower-, or mixed-case.
$ZGETJPI() provides a tool for examining the characteristics of a VMS process and the job in which it operates. Accessing information about processes belonging to other users requires certain VMS privileges. Consult your system manager if you feel you require additional privileges.
The function $ZGETJPI($J,"TERMINAL") returns the output device only when the process is the first (master) process with a job. Within a spawned process, the VMS system service used by $ZGETJPI returns a null string for the item TERMINAL. However, the following alternative acquires the PID of the primary process and uses that to in turn get the terminal.
$ZGETJPI($ZGETJPI($J,"MASTER_PID"),"TERMINAL")
$ZGETJPI() Item Keywords |
|
ITEM KEYWORD |
$ZGETJPI() DATA RETURNED |
ACCOUNT APTCNT ASTACT ASTCNT ASTEN |
Account name string (8 characters filled with trailing blanks) Active page table count Access mode with active ASTs Remaining AST quota Access modes with ASTs enabled |
ASTLM AUTHPRI BLOCNT BIOLM BUFIO |
AST limited quota Maximum priority available without the ALTPRI privilege Privileges a process can enable Remaining buffered I/O quote Count of buffered I/O operations |
BYTCNT BYTLM CLINAME CPULIM CPUTIM |
Remaining buffered I/O byte-count quota Buffered I/O byte-count limit quota Current command language interpreter Limit on process CPU time CPU time used in hundredths of a second |
CREPRCFLAGS CURPRIV DFPFC DFWSCNT DIOCNT |
Create process flags Current process privileges Default page fault cluster size Default working set size Remaining direct I/O quota |
DIOLM DIRIO EFCS EFCU EFWM |
Direct I/O limit quota Count of direct I/O operations Local event flags 0 through 31 Local event flags 32 through 63 Event flag wait mask |
ENQCNT ENQLM EXCVEC FILCNT FILLM |
Lock request quota remaining Lock request quota limit Address of a list of exception vectors Remaining open file quota Open file quota |
FINALEXC FREPOVA FREP1VA FREPTECNT GPGCNT |
Address of final exception vectors list First free page at end of program region First free page at end of control region Number of pages available for virtual memory expansion Global page count in working set |
GRP IMAGECOUNT IMAGNAME IMAGPRIV |
Group number in UIC Number of images from which the process has exited (without regard to reason) File name of the current image Privileges with which the current image was installed |
JOBPRCCNT JOBTYPE LOGINTIM MASTER_PID MAXDETACH |
Number of subprocesses in the process Job type (0=detach, 1=network, 2=batch, 3=interactive) Process creation time PID of the process at the top of the current job’s process tree Maximum number of detach jobs allowed |
MAXJOBS MEM MSGMASK OWNER PAGEFLTS |
Maximum number of jobs allowed Member number of UIC Default message mask PID of process owner Count of page faults |
PAGFILCNT PAGFILLOC PGFLQUOTA PHDFLAGS PID |
Remaining paging file quota Location of the paging file Paging file quota (maximum virtual page count) Flags word Process identification number |
PPBCNT PRCCNT PRCLM PRCNAM PRI |
Process page count Count of the subprocesses Subprocess quota Process name Current process priority |
PRIB PROCINDEX PORCPRIV SHRFILLM SITESPEC |
Base process priority System table index for the process Current process privileges Shared file limit Per-process site-specified longword |
STATE STS SWPFILLOC TABLENAME TERMINAL |
Process state Process status flags Location fo the swap file CLI table name Login terminal name, if interactive |
TMBU TQCNT TQLM UAFLAGS UIC |
Termination mailbox unit number, if detached Remaining timer queue entry quota Timer queue entry quota UAF flags for the account UIC of the process |
USERNAME VIRTPEAK VOLUMES WSAUTH WAUTHEXT |
User name string Peak virtual address size Count of currently mounted volumes Maximum authorized working set size Maximum authorized working set extent |
WSEXTENT WSPEAK WSQUOTA WSSIZE |
Current working set extent Working set peak Working set size quota Current working set size |