This document describes Caché-supplied (intrinsic) functions that are
supplied as arguments to the $ZF function for DSM compatibility and conversion.
This article describes the following intrinsic functions:
-
GETJPI job and process information
-
-
-
-
GETSYM returns DCL symbol value
-
DELSYM deletes DCL symbol value
-
-
TRNLNM translates logical name
-
-
GETUAI returns account authorization
parameters
-
GETMSG returns status code message
text
-
SETPRN sets name of the calling
process
-
SETPRI sets base priority for
a process
-
OPCOM sends message to the operator
-
-
-
-
-
The function names are shown here in all uppercase letters, but they are, in
fact, case-insensitive.
GETJPI
Gets job and process information.
Synopsis
SET x = $ZF("GETJPI",pid,item,procname)
This function returns job and process information.
The process ID (in decimal).
Item Codes for GETJPI: "ACCOUNT" "APTCNT" "ASTACT" "ASTCNT" "ASTEN" "ASTLM"
"AUTHPRI" "AUTHPRIV" "BIOCNT" "BIOLM" "BUFIO" "BYTCNT" "BYTLM" "CLINAME"
"CPU_ID" "CPULIM" "CPUTIM" "CREPRC_FLAGS" "CURPRIV" "DFPFC" "DFWSCNT" "DIOCNT"
"DIOLM" "DIRIO" "EFCS" "EFCU" "EFWM" "ENQCNT" "ENQLM" "EXCVEC" "FAST_VP_SWITCH"
"FILCNT" "FILLM" "FINALEXC" "FREP0VA" "FREP1VA" "FREPTECNT" "GPGCNT" "GRP"
"IMAGECOUNT" "IMAGNAME" "IMAGPRIV" "JOBPRCCNT" "JOBTYPE" "LOGINTIM" "MASTER_PID"
"MAXDETACH" "MAXJOBS" "MEM" "MODE" "MSGMASK" "NODENAME" "NODE_CSID" "NOD_VERSION"
"OWNER" "PAGEFLTS" "PAGFILCNT" "PAGFILLOC" "PGFLQUOTA" "PHDFLAGS" "PID" "PPGCNT"
"PRCCNT" "PRCLM" "PRCNAM" "PRI" "PRIB" "PROC_INDEX" "PROCPRIV" "SCHED_POLICY"
"SHRFILLM" "SITESPEC" "SLOW_VP_SWITCH" "STATE" "STS" "STS2" "SWPFILLOC" "TABLENAME"
"TERMINAL" "TMBU" "TQCNT" "TQLM" "TT_ACCPORNAM" "TT_PHYDEVNAM" "UAF_FLAGS"
"UIC" "USERNAME" "VIRTPEAK" "VOLUMES" "VP_CONSUMER" "VP_CPUTIM" "WSAUTH" "WSAUTHEXT"
"WSEXTENT" "WSPEAK" "WSQUOTA" "WSSIZE"
GETDVI
Gets device information.
Synopsis
SET x = $ZF("GETDVI",devname,item,flag)
This function returns device characteristics.
A physical device name, or a logical name that equates to a physical device
name.
Item Codes for GETDVI "ACPTYPE" "ALL" "ALLDEVNAM" "ALLOCLASS" "ALT_HOST_AVAIL"
"ALT_HOST_NAME" "ALT_HOST_TYPE" "AVL" "CCL" "CLUSTER" "CONCEALED" "CYLINDERS"
"DEVBUFSIZ" "DEVCHAR" "DEVCHAR2" "DEVCLASS" "DEVDEPEND" "DEVDEPEND2" "DEVLOCKNAM"
"DEVNAM" "DEVSTS" "DEVTYPE" "DIR" "DMT" "DUA" "ELG" "ERRCNT" "EXISTS" "FOD"
"FOR" "FREEBLOCKS" "FULLDEVNAM" "GEN" "HOST_AVAIL" "HOST_COUNT" "HOST_NAME"
"HOST_TYPE" "IDV" "LOCKID" "LOGVOLNAM" "MAXBLOCK" "MAXFILES" "MBX" "MEDIA_ID"
"MEDIA_NAME" "MEDIA_TYPE" "MNT" "MOUNTCNT" "NET" "NEXTDEVNAM" "ODV" "OPCNT"
"OPR" "OWNUIC" "PID" "RCK" "RCT" "REC" "RECSIZ" "REFCNT" "REMOTE_DEVICE"
"RND" "ROOTDEVNAM" "RTM" "SDI" "SECTORS" "SERIALNUM" "SERVED_DEVICE" "SHR"
"SPL" "SPLDEVNAM" "SQD" "STS" "SWL" "TRACKS" "TRANSCNT" "TRM" "TT_ACCPORNAM"
"TT_ALTYPEAHD" "TT_ANSICRT" "TT_APP_KEYPAD" "TT_AUTOBAUD" "TT_AVO" "TT_BLOCK"
"TT_BRDCSTMBX" "TT_CRFILL" "TT_DECCRT" "TT_DECCRT2" "TT_DIALUP" "TT_DISCONNECT"
"TT_DMA" "TT_DRCS" "TT_EDIT" "TT_EDITING" "TT_EIGHTBIT" "TT_ESCAPE" "TT_FALLBACK"
"TT_HALFDUP" "TT_HANGUP" "TT_HOSTSYNC" "TT_INSERT" "TT_LFFILL" "TT_LOCALECHO"
"TT_LOWER" "TT_MBXDSABL" "TT_MECHFORM" "TT_MECHTAB" "TT_MODEM" "TT_MODHANGUP"
"TT_NOBRDCST" "TT_NOECHO" "TT_NOTYPEAHD" "TT_OPER" "TT_PAGE" "TT_PASTHRU" "TT_PHYDEVNAM"
"TT_PRINTER" "TT_READSYNC" "TT_REGIS" "TT_REMOTE" "TT_SCOPE" "TT_SECURE" "TT_SETSPEED"
"TT_SIXEL" "TT_SYSPWD" "TT_TTSYNC" "TT_WRAP" "UNIT" "VOLCOUNT" "VOLNAM" "VOLNUMBER"
"VOLSETMEM" "VPROT" "WCK"
1 = primary characteristics. 2 = secondary characteristics. The default is 2.
GETSYI
Gets system information.
Synopsis
SET x = $ZF("GETSYI",item,csid)
This function returns system information.
Item Codes for GETSYI: "ACTIVECPU_CNT" "ARCHFLAG" "ARCH_NAME" "ARCH_TYPE"
"AVAILCPU_CNT" "BALSETCNT" "BOOTTIME" "CHARACTER_EMULATED" "CLUSTER_EVOTES"
"CLUSTER_FSYSID" "CLUSTER_FTIME" "CLUSTER_MEMBER" "CLUSTER_NODES" "CLUSTER_QUORUM"
"CPU" "CONTIG_GBLPAGES" "CPUTYPE" "DECIMAL_EMULATED" "D_FLOAT_EMULATED" "HW_MODEL"
"HW_NAME" "FREE_GBLPAGES" "FREE_GBLSECTS" "GBLPAGES" "GBLPAGFIL" "GBLSECTIONS"
"LOCKIDTBL" "LOCKIDTBL_MAX" "MAXPROCESSCNT" "MAXSYSGROUP" "NODENAME" "NODE_CSID"
"PAGEFILE_FREE" "PAGEFILE_PAGE" "PQL_DWSDEFAULT" "PQL_DWSEXTENT" "PQL_DWSQUOTA"
"PQL_MWSDEFAULT" "PQL_MWSEXTENT" "PQL_MWSQUOTA" "PQL_MASTLM" "PQL_MBYTLM" "PQL_MDIOLM"
"PQL_MFILLM" "PQL_MENQLM" "SCSNODE" "SPTREQ" "SRPCOUNTV" "SWAPFILE_FREE" "SWAPFILE_PAGE"
"VERSION" "VIRTUALPAGECNT" "WSMAX"
SETSYM
Sets DCL symbol.
Synopsis
SET x = $ZF("SETSYM",symbol,value,flag)
This function sets a DCL symbol to a value. This DCL symbol can be local or
global. SETSYM returns the null string.
GETSYM
Gets a DCL symbol value.
Synopsis
SET x = $ZF("GETSYM",symbol)
This function returns the value of a specified DCL symbol. This DCL symbol can
be local or global. DCL values are set using the SETSYM function.
DELSYM
Deletes a DCL symbol.
Synopsis
SET x = $ZF("DELSYM",symbol,flag)
This function deletes the value of a specified DCL symbol. This DCL symbol can
be local or global. DCL values are set using the SETSYM function.
CRELOG
Creates a logical name.
Synopsis
SET x = $ZF("CRELOG",logname,value,type,table)
This function creates a logical name in the specified logical name table with
the specified mode. CRELOG returns the null string.
TRNLNM
Translates a logical name.
Synopsis
SET x = $ZF("TRNLNM",logname,table,index,acmode,trans,item)
This function translates a logical name and returns the equivalence name string
or the requested attributes. TRNLNM returns the null string if no match is found.
Item codes for TRNLNM: "ACCESS_MODE" "CONCEALED" "CONFINE" "CRELOG" "LENGTH"
"MAX_INDEX" "NO_ALIAS" "TABLE" "TABLE_NAME" "TERMINAL" "VALUE"
DELLOG
Deletes logical name.
Synopsis
SET x = $ZF("DELLOG",logname,type,table)
This function deletes a logical name in the specified logical name table.
GETUAI
Get user account information.
Synopsis
SET x = $ZF("GETUAI",account,item)
This function returns values for authorization parameters of a specific VMS
account.
Item Codes for GETUAI: "ACCOUNT" "ASTLM" "BIOLM" "BYTLM" "DEFDEV" "DEFDIR"
"DEF_PRIV" "DFWSCNT" "DIOLM" "ENQLM" "FILLM" "FLAGS" "JTQUOTA" "LASTLOGIN_I"
"LASTLOGIN_N" "LGICMD" "MAXACCTJOBS" "MAXDETACH" "MAXJOBS" "OWNER" "PBYTLM"
"PGFLQUOTA" "PRCCNT" "PRI" "PRIV" "QUEPRI" "SHRFILLM" "TQCNT" "UIC" "USERNAME"
"WSEXTENT" "WSQUOTA"
The following example shows
GETUAI used as a function:
SET x = $ZF("GETUAI","FRED","USERNAME")
GETMSG
Returns error message text.
Synopsis
SET x = $ZF("GETMSG",code)
This function returns the message text that corresponds to the specified status
code.
SETPRN
Sets name of the calling process.
Synopsis
SET x = $ZF("SETPRN",pname)
This function sets the name of the calling process to the specified VMS process
name.
SETPRI
Set the base priority for the process.
Synopsis
SET x = $ZF("SETPRI",pri,pid)
This function sets the base priority of the specified process. The process must
be running CACHE image.
OPCOM
Sends a message to the operator.
Synopsis
This function sends the specified message to the operator terminal(s). It returns
a null string.
MOUNT
Mounts the specified device.
Synopsis
SET x = $ZF("MOUNT",devnam,label,options,lognam)
This function mounts a device. It calls LIB$SPAWN to issue the DCL command MOUNT.
DISMOUNT
Dismounts the specified device.
Synopsis
SET x = $ZF("DISMOUNT",devnam,options)
This function dismounts a device. It calls LIB$SPAWN to issue the DCL command
DISMOUNT.
DIRECTORY
Returns the default directory.
Synopsis
SET x = $ZF("DIRECTORY",dir)
This function returns the current VMS default directory, and optionally sets
the VMS default directory to the specified directory.
PARSE
Parses a file name.
Synopsis
SET x = $ZF("PARSE",filename,defname,relname,keyword,flag)
This function parses the specified file name and returns a parsed file name.
PARSE calls the RMS $PARSE service.
GETFILE
Gets file information.
Synopsis
SET x = $ZF("GETFILE",filename,keyword)
This function returns information about the specified file. It emulates the
F$FILE_ATTRIBUTES lexical function, using the same keywords. GETFILE returns the UIC
in standard OpenVMS format, and returns TRUE or FALSE as 1 or 0.
Keywords for GETFILE: "ALQ", "BDT", "BKS", "BLS", "CBT", "CDT", "CTG", "DBS",
"DEQ", "DID", "DVI", "EDT", "EOF", "FID", "FSZ", "GRP", "GBC", "IBS", "LRL", "LVL",
"MBM", "MRN", "MRS", "NOA", "NOK", "ORG", "PRO", "PVN", "RAT", "RCK", "RDT", "RFM",
"RVN", "SIZ", "UIC", "WCK"