| Previous | Contents | Index |
Returns information about the specified process.Requires GROUP privilege to obtain information on other processes in the same group. Requires WORLD privilege to obtain information on any other processes in the system.
F$GETJPI (pid,item)
pid
Specifies the process identification (PID) number of the process for which information is being reported. Specify the pid argument as a character string expression. You can omit the leading zeros.If you specify a null string (""), the current PID number is used.
You cannot use an asterisk (*) or percent sign (%) wildcard character to specify the pid argument in the F$GETJPI function, as you can with the $GETJPI system service. To get a list of process identification numbers, use the F$PID function.
item
Indicates the type of process information to be returned. Specify the item argument as a character string expression. You can specify any one of the items listed in Table DCLI-7.
The F$GETJPI lexical function invokes the $GETJPI system service to return information about the specified process. The function returns information on all items that can be specified with the $GETJPI system service. For more information on the $GETJPI system service, see the HP OpenVMS System Services Reference Manual.The F$GETJPI lexical function returns a zero or a null string if the target process is in a suspended or MWAIT (resource wait) state and the item requested is stored in the virtual address space of the process.
You can use the F$GETJPI lexical function to find out whether a process automatically unshelves files.
When you specify the STS2 item code, F$GETJPI returns a 32--bit numeric value. When you convert this numeric value to binary format, the digit at symbolic bit position PCB$V_NOUNSHELVE shows you the process unshelving default. If the bit is 1, automatic unshelving is turned off; if 0, automatic unshelving is turned on.
Table DCLI-7 lists the items you can specify with the F$GETJPI function, the information returned, and the data type of this information.
Table DCLI-7 F$GETJPI Items Item Return Type Information Returned ACCOUNT String Account name string (8 characters filled with trailing blanks). APTCNT Integer Active page table count. ASTACT Integer Access modes with active asynchronous system traps (ASTs). ASTCNT Integer Remaining AST quota. ASTEN Integer Access modes with ASTs enabled. ASTLM Integer AST limit quota. AUTHPRI Integer Maximum priority that a process without the ALTPRI (alter priority) privilege can achieve with the $SETPRI system service. AUTHPRIV String Privileges that a process is authorized to enable. BIOCNT Integer Remaining buffered I/O quota. BIOLM Integer Buffered I/O limit quota. BUFIO Integer Count of process buffered I/O operations. BYTCNT Integer Remaining buffered I/O byte count quota. BYTLM Integer Buffered I/O byte count quota. CASE_LOOKUP_IMAGE (Alpha/I64 only) String Returns information about the file name lookup case sensitivity of a specified process. This value is set only for the life of the image. Values are BLIND or SENSITIVE. See the Guide to OpenVMS File Applications for additional information.
CASE_LOOKUP_PERM (Alpha/I64 only) String Returns information about the file name lookup case sensitivity of a specified process. This value is set for the life of the process unless the style is set again. Values are BLIND or SENSITIVE. See the Guide to OpenVMS File Applications for additional information.
CLASSIFICATION (Alpha/I64 only) String Current MAC classification, as a 20-byte padded string, stored in the PSB. CLINAME String Current command language interpreter; always returns DCL. CPULIM Integer Limit on process CPU time. CPUTIM Integer CPU time used in hundredths of a second. CREPRC_FLAGS Integer Flags specified by the stsflg argument in the $CREPRC call that created the process. CURPRIV String Current process privileges. CURRENT_CAP_MASK (Alpha/I64 only) Integer Current capabilities mask for the specified kernel thread. See the SET PROCESS/CAPABILITIES command for additional information. DFPFC Integer Default page fault cluster size. DFWSCNT Integer Default working set size. DIOCNT Integer Remaining direct I/O quota. DIOLM Integer Direct I/O limit quota. DIRIO Integer Count of direct I/O operations for the process. EFCS Integer Local event flags 0--31. EFCU Integer Local event flags 32--63. EFWM Integer Event flag wait mask. ENQCNT Integer Lock request quota remaining. ENQLM Integer Lock request quota limit. EXCVEC Integer Address of a list of exception vectors. FAST_VP_SWITCH Integer Number of times this process has issued a vector instruction that enabled an inactive vector processor without the expense of a vector context switch. FILCNT Integer Remaining open file quota. FILLM Integer Open file quota. FINALEXC Integer Address of a list of final exception vectors. FREP0VA Integer First free page at end of program region (P0 space) (irrelevant if no image is running). FREP1VA Integer First free page at end of control region (P1 space). FREPTECNT Integer Number of pages available for virtual memory expansion. GPGCNT Integer Global page count in working set. GRP Integer Group number of the user identification code (UIC). HOME_RAD (Alpha/I64 Only) Integer Home resource affinity domain (RAD). Supported only on AlphaServer GS series systems. IMAGECOUNT Integer Number of images that have been run down for the process. IMAGE_AUTHPRIV (Alpha/I64 only) String Authorized privilege mask of the installed image. IMAGE_PERMPRIV (Alpha/I64 only) String Permanent (default) privilege mask of the installed image. IMAGE_WORKPRIV (Alpha/I64 only) String Working (active) privilege mask of the installed image. IMAGNAME String File name of the current image. IMAGPRIV String Privileges with which the current image was installed. INSTALL_RIGHTS (Alpha/I64 only) Integer Binary content of the install rights list. This item code returns a list of install rights separated by commas. INSTALL_RIGHTS_SIZE (Alpha/I64 only) Integer Number of bytes needed to store the install rights. JOBPRCCNT Integer Number of subprocesses owned by the job. JOBTYPE Integer Execution mode of the process at the root of the job tree. LAST_LOGIN_I String Time of your last interactive login (the value that was reported when you logged in). LAST_LOGIN_N String Time of your last noninteractive login (the value that was reported when you logged in). LOGIN_FAILURES Integer Number of login failures that occurred prior to the start of the current session (the value that was reported when you logged in). LOGIN_FLAGS Integer A longword bitmask that contains additional information relating to the login sequence. LOGINTIM String Process creation time. MASTER_PID String Process identification (PID) number of the process at the top of the current job's process tree. MAXDETACH Integer Maximum number of detached processes allowed the user who owns the process. MAXJOBS Integer Maximum number of active processes allowed for the user who owns the process. MEM Integer Member number of the UIC. MODE String Current process mode (BATCH, INTERACTIVE, NETWORK, or OTHER). MSGMASK Integer Current message mask as established by the SET MESSAGE command. If no mask is specified, the default system message mask is described in the $GETMSG system service. For additional information, see the $PUTMSG system service (for message mask bits), and the F$ENVIRONMENT lexical MESSAGE item. MULTITHREAD Integer Current setting for the process (limited by the system setting). NODENAME String The name of the OpenVMS Cluster node on which the process is running. NODE_CSID Integer Cluster ID of the OpenVMS Cluster node on which the process is running. NODE_VERSION String Operating system version number of the OpenVMS Cluster node on which the process is running. OWNER String Process identification number of process owner. PAGEFLTS Integer Count of page faults. PAGFILCNT Integer Remaining paging file quota. PAGFILLOC Integer Location of the paging file. PARSE_STYLE_PERM (Alpha/I64 only) String Values that were set by $SET_PROCESS_PROPERTIESW. PARSE_STYLE_IMAGE (Alpha/I64 only) String Values that were set by $SET_PROCESS_PROPERTIESW. PERMANENT_CAP_MASK (Alpha/I64 only) Integer Permanent capabilities mask for the specified kernel thread. See the SET PROCESS/CAPABILITIES command for additional information. PERSONA_AUTHPRIV (Alpha/I64 only) String Authorized privilege mask of the persona. PERSONA_ID (Alpha/I64 only) Integer The ID of the persona as a longword integer. PERSONA_PERMPRIV (Alpha/I64 only) String Permanent (default) privilege mask of the persona. PERSONA_RIGHTS (Alpha/I64 only) Integer Binary content of the persona rights list. This item code returns a list of persona rights separated by commas. PERSONA_RIGHTS_SIZE (Alpha/I64 only) Integer Number of bytes needed to store the persona rights. PERSONA_WORKPRIV (Alpha/I64 only) String Privilege mask of the working (active) persona. PGFLQUOTA Integer Paging file quota (maximum virtual page count). PHDFLAGS Integer Flags word. PID String Process identification number. PPGCNT Integer Process page count. PRCCNT Integer Number of subprocesses owned by the process. PRCLM Integer Subprocess quota. PRCNAM String Process name. PRI Integer Process's current priority. PRIB Integer Process's base priority. PROC_INDEX Integer Process's index number. PROCESS_RIGHTS String Contents of the process's local rights list, including your UIC. This item code returns a list of identifier names separated by commas. PROCPRIV String Process's default privileges. RIGHTSLIST String Contents of all of the process rights lists; the equivalent of PROCESS_RIGHTS plus SYSTEM_RIGHTS. This item code returns a list of identifier names separated by commas. RIGHTS_SIZE Integer Number of bytes required to buffer the rights list. The rights list includes both the system rights list and the process rights list. SCHED_CLASS_NAME (Alpha/I64 only) String Returns the name of the scheduling class if the process is class scheduled, null string if not. SHRFILLM Integer Maximum number of open shared files allowed for the job to which the process belongs. SITESPEC Integer Per-process site-specific longword. SLOW_VP_SWITCH Integer Number of times this process has issued a vector instruction that enabled an inactive vector processor with a full vector context switch. STATE String Process state. STS Integer First longword of process status flags. STS2 Integer Second longword of process status flags. SUBSYSTEM_RIGHTS (Alpha/I64 only) Integer Binary content of the subsystem rights list. This item code returns a list of subsystem rights separated by commas. SUBSYSTEM_RIGHTS_SIZE (Alpha/I64 only) Integer Number of bytes needed to store the subsystem rights. SWPFILLOC Integer Location of the swap file. SYSTEM_RIGHTS String Contents of the system rights list for the process. This item code returns a list of identifier names separated by commas. SYSTEM_RIGHTS_SIZE (Alpha/I64 only) Integer Number of bytes needed to store the system rights. TABLENAME String File specification of the process's current command language interpreter (CLI) table. TERMINAL String Login terminal name for interactive users (1--7 characters). TMBU Integer Termination mailbox unit number. TOKEN String Token size, specified as TRADITIONAL (255 bytes) or EXPANDED (4000 bytes). TQCNT Integer Remaining timer queue entry quota. TQLM Integer Timer queue entry quota. TT_ACCPORNAM String Access port name for the terminal associated with the process. TT_PHYDEVNAM String Physical device name of the terminal associated with the process. UAF_FLAGS Integer User authorization file (UAF) flags from the UAF record of the user who owns the process. UIC String Process's user identification code (UIC). USERNAME String User name string (12 characters filled with trailing blanks). VIRTPEAK Integer Peak virtual address size. VOLUMES Integer Count of currently mounted volumes. VP_CONSUMER Boolean Flag indicating whether the process is a vector consumer. VP_CPUTIM Integer Total amount of time the process has accumulated as a vector customer. WSAUTH Integer Maximum authorized working set size. WSAUTHEXT Integer Maximum authorized working set extent. WSEXTENT Integer Current working set extent. WSPEAK Integer Working set peak. WSQUOTA Integer Working set size quota. WSSIZE Integer Process's current working set limit. If you use the $GETJPI function to request information on the null process or the swapper process, you can specify any of the items in Table DCLI-7 except the following:
ACCOUNT BYTLM ENQCNT ENQLM EXCVEC FILCNT FILM FINALEXC IMAGNAME LOGINTIM MSGMASK PAGFILCNT PGFLQUOTA PRCCNT PRCLM PROCPRIV SITESPEC TQCNT TQLM USERNAME VIRTPEAK VOLUMES WSPEAK
| #1 |
|---|
$ NAME = F$GETJPI("3B0018","USERNAME")
$ SHOW SYMBOL NAME
NAME = "JANE "
|
This example shows how to use the F$GETJPI function to return the user name for the process number 3B0018. The user name is assigned to the symbol NAME.
| #2 |
|---|
$ X=F$ENVIRONMENT("MESSAGE")
$ SHOW SYMBOL X
X = "/FACILITY/SEVERITY/IDENTIFICATION/TEXT"
$ X=F$GETJPI("0","MSGMASK")
$ SHOW SYMBOL X
X = 15 Hex = 0000000F Octal = 00000000017
$ SET MESSAGE /NOFACILITY
$ X=F$ENVIRONMENT("MESSAGE")
$ SHOW SYMBOL X
X = "/NOFACILITY/SEVERITY/IDENTIFICATION/TEXT"
$ X=F$GETJPI("0","MSGMASK")
$ SHOW SYMBOL X
X = 7 Hex = 00000007 Octal = 00000000007
$ SET MESSAGE /FACILITY
$ X=F$ENVIRONMENT("MESSAGE")
$ SHOW SYMBOL X
X = "/FACILITY/SEVERITY/IDENTIFICATION/TEXT"
$ X=F$GETJPI("0","MSGMASK")
$ SHOW SYMBOL X
X = 15 Hex = 0000000F Octal = 00000000017
$
|
This example shows the use of the F$GETJPI MSGMASK item.
| Previous | Next | Contents | Index |