Descriptions of the Intrinsics Available in MPE/iX
MPE documents | |
 Complete PDF | |
| Table of Contents | |
| Index |
ABORTSESS
NM and CM callable. Enables a program to abort a specified job or session from the system.
I16V I32V I16A
ABORTSESS (jsid, jsnum, jsstatus);
ACTIVATE
NM and CM callable. Activates a newly created process, or a process suspended with the SUSPEND intrinsic. Requires process handling (PH) capability.
I16V U16V
ACTIVATE (pin, allow);
ADJUSTUSLF
NM and CM callable. Adjusts directory space in a USL file by moving the start of the information block forward (or backward) on a user subprogram library (USL) file, thereby increasing (or decreasing) the space available for the file directory block. The overall length of the file does not change. This intrinsic is intended for programmers writing compilers. A USL contains CM object code and is meaningful only in the CM program development process.
I16 I16V I16V uslferror := ADJUSTUSLF (uslfnum, adjustment);
ALMANAC
NM and CM callable. Returns the numeric date information for a date returned by the CALENDAR intrinsic. The returned information is year of century, month of year, day of month, and day of week.
U16V U16A I16 I16 I16 I16
ALMANAC (date, daterror, yearnum, monthnum, daynum, weekdaynum);
ALTDSEG
NM and CM callable.
Reduces the storage required by the extra data segment when moved into main memory and expands storage as required, allowing for a more efficient use of memory. Data segment management (DS) capability is required. Data segment management (DS) intrinsics are not recommended for use in the MPE/iX native mode programming environment; use of DS intrinsics degrade program performance.
U16V I16V I16
ALTDSEG (index, increment, size);
ARITRAP
NM and CM callable. Collectively enables all arithmetic traps (except the IEEE inexact result trap) or disables all arithmetic traps.
I*V
ARITRAP (trapstate);
ASCII
NM and CM callable. Converts a 16-bit binary number to a specified base and represents it as a numeric ASCII string.
I16 * I16V CA numchar := ASCII (binvalue, base, asciieqv);
BEGINLOG
NM and CM callable. Posts a special record to the user logging file to mark the beginning of a logical transaction. When BEGINLOG is called, the logging memory buffer is flushed to ensure that the record gets to the logging file. User logging (LG) or system supervisor (OP) capability is required.
I32 U16A I16 I16 I16
BEGINLOG (index, data, length, mode, logstatus);
BINARY
NM and CM callable. Converts a numeric (octal or decimal) ASCII string to a 16-bit twos complement binary value.
I16 CA I16V bineqv := BINARY (asciieqv, length);
CALENDAR
NM and CM callable. Returns the calendar date, including the day of year and the year since 1900.
U16 date := CALENDAR;
CATCLOSE
NM and CM callable. Closes an application message catalog that was opened with CATOPEN.
I32V U16A
CATCLOSE (catindex, catstatus);
CATOPEN
NM and CM callable. Opens an application message catalog that was formatted with the GENCAT utility. CATOPEN returns a value that identifies the catalog and is used by CATREAD and CATCLOSE.
I32 CA U16A catindex := CATOPEN (formaldesig, catstatus);
CATREAD
NM and CM callable. Provides access to messages in an application message facility formatted by the GENCAT utility. The CATOPEN intrinsic opens the message catalog.
I16 I32V I16V I16V U16A
msglength := CATREAD (catindex, setnum, msgnum, catstatus,
CA I16V CA CA CA CA CA I16V
buffer, buffersize, parm1, parm2, parm3, parm4, parm5, msgdest);
CAUSEBREAK
NM and CM callable. Interrupts the program (the entire process structure). The CAUSEBREAK intrinsic is the programmatic equivalent to pressing Break in a session. It is not applicable in jobs. The program is suspended while in break mode. Execution of the program resumes where the interruption occurred if you enter the RESUME command, or aborts if you enter the ABORT command.
CAUSEBREAK;
CLEANUSL
NM and CM callable. Deletes all inactive entries from currently managed USL files and returns the file number of the new USL file. Therefore, you must test the condition code immediately upon return from the intrinsic. Unpredictable results occur if an error number is used as a file number. A USL contains CM object code and is meaningful in the CM program development process only.
I16 I16V CA filenum := CLEANUSL (uslfnum, formaldesig);
CLOCK
NM and CM callable. Returns the time (hours, minutes, seconds, and tenths of seconds) according to the system timer.
I32 time := CLOCK;
CLOSELOG
NM and CM callable. Closes access to the user logging facility. User logging (LG) or system supervisor (OP) capabilities are required.
I32 I16 I16
CLOSELOG (index, mode, logstatus);
COMMAND
NM and CM callable. Executes an MPE/iX command programmatically.
CA I16 I16
COMMAND (cmdimage, cmderror, parmnum);
CREATE
NM and CM callable. Creates a process as a child of the calling process. Process handling (PH) capability is required.
CA CA I16 I16V U16V
CREATE (formaldesig, entryname, pin, parm, loadflag,
I16V I16V I16V U16V I16V
stacksize, dlsize, maxdata, priorityclass, rank);
CREATEPROCESS
NM and CM callable. Creates a process and allows you to assign $STDIN and $STDLIST to any file. Process handling (PH) capability is required.
I* I16 CA I32A I32A
CREATEPROCESS (createstatus, pin, formaldesig, itemnum, item);
createstatus is a 32-bit signed integer by reference in Native
Mode (NM), and a 16-bit signed integer by reference for Compatibility
Mode (CM).
CTRANSLATE
NM and CM callable. Converts a string of characters between EBCDIC and ASCII, or between EBCDIK (HP-specific version of EBCDIC) and KANA8 (8-bit, Japanese International Standard (JIS) version of USASCII code).
I16V CA CA I16V
CTRANSLATE (transcode, inbuffer, outbuffer, bufferlength,
CA
transtable);
DASCII
NM and CM callable. Converts a 32-bit binary number to a specified base and represents it as a numeric ASCII string.
I16 I32V I16V CA numchar := DASCII (binvalue, base, asciieqv);
DATELINE
NM and CM callable. Returns the current date and time, including the day of week, month, day, year, hours, and minutes.
CA
DATELINE (datebuffer);
DBINARY
NM and CM callable. Converts a numeric ASCII string to a 32-bit binary value. The numeric ASCII string can be octal, hexadecimal, or decimal.
I32 CA I16V dbineqv := DBINARY (dasciieqv, length);
DEBUG
NM and CM callable. Invokes the debug facility from an interactive program and allows object code to be analyzed. Consult the MPE/iX System Debug Reference Manual (32650-90013) before attempting to use the debug facility.
DEBUG;
DLSIZE
NM and CM callable. Causes the area between DL and DB in the compatibility mode (CM) stack to be expanded or contracted within the CM stack segment.
I16 I16V dldbsize := DLSIZE (size);
DMOVIN
NM and CM callable. Copies data from an extra data segment into a data area. Data segment management (DS) capability is required. Data segment management (DS) intrinsics are not recommended for use in the NM programming environment; use of DS intrinsics in NM degrades an NM program's performance.
U16V I16V I16V U16A
DMOVIN (index, displacement, number, location);
DMOVOUT
NM and CM callable. Copies data from the data area to an extra data segment. Data segment management (DS) capability is required. Data segment management (DS) intrinsics are not recommended for use in the NM programming environment; use of DS intrinsics in NM degrades the NM program's performance.
U16V I16V I16V U16A
DMOVOUT (index, displacement, number, location);
ENDLOG
NM and CM callable. Posts a record to the logging file marking the end of a logical transaction. When the record is posted, ENDLOG flushes the user logging memory buffer to ensure that the record gets to the logging file. User logging (LG) or system supervisor (OP) capability is required.
I32 U16A I16 I16 I16
ENDLOG (index, data, length, mode, logstatus);
EXPANDUSLF
NM and CM callable. Changes length of a USL file by creating a USL file with the increment length longer or shorter than the USL file specified by uslfnum. The old USL file is copied to the new file with the same file name; the old USL file is then deleted. A USL contains CM object code and is meaningful only in the CM program development process.
I16 I16V I16V filenum := EXPANDUSLF (uslfnum, increment);
FATHER
NM and CM callable. Returns the process identification number (PIN) of the parent calling process. Process handling (PH) capability is required.
I16 pin := FATHER;
FCHECK
NM and CM callable. Returns specific details about error conditions that occurred when a file system intrinsic returns a condition code indicating an I/O error. FCHECK applies to files on any device.
I16V I16 I16 I32 I16
FCHECK (filenum, fserrorcode, translog, blocknum, numrecs);
FCLOSE
NM and CM callable. Terminates access to a file on any device by closing the reference file descriptor. If the file is not being accessed by another process, resources associated with the open file description are released.
I16V I16V I16V
FCLOSE (filenum, disposition, securitycode);
FCONTROL
NM and CM callable. Performs various control operations on a file or on the device where the file resides, including:
Supplying a printer or terminal carriage control directive.
Verifying I/O.
Reading the hardware status word for the device where the file resides.
Setting a terminal's timeout interval.
Repositioning a file at its beginning.
Writing an end-of-file marker.
Skipping forward or backward to a tape mark.
I16V I16V *
FCONTROL (filenum, itemnum, item);
FDELETE
NM and CM callable. Deactivates a specified logical record in an RIO file.
I16V I32V
FDELETE (filenum, lrecnum);
FDEVICECONTROL
NM and CM callable. Provides control operations to a printer, terminal, or a spooled device file and is used to:
Download character sets, forms, and internal or control tables used in printing.
Control the page size, pen positioning, form and use of character sets, the number of copies to be printed, and all other printing environment characteristics.
Perform control operations on a terminal, printer, or spooled device file.
I16V UDS I16V I16V U16V U16V
FDEVICECONTROL (filenum, buffer, length, controlcode, parm1, parm2,
U16
fserrorcode);
FERRMSG
NM and CM callable. Returns a message corresponding to an FCHECK error number and enables error messages to be displayed from a program.
I16 CA I16
FERRMSG (fserrorcode, msgbuffer, msglength);
FFILEINFO
NM and CM callable. Returns information about a file.
I16V I16V *
FFILEINFO (filenum [,itemnum, item] [...]);
Up to five itemnum/item pairs can be specified.
FFINDBYKEY
NM and CM callable. Positions the record pointer at the beginning of the first record matching the key value comparison. For KSAM files only.
I16V CA I16V I16V I16V
FFINDBYKEY (filenum, value, location, length, relop);
FFINDN
NM and CM callable. Positions the logical record pointer to the relative record number according to the key sequence. For KSAM files only.
I16V DV I16V
FFINDN (filenum, number, location);
FGETINFO
NM and CM callable. Returns access and status information about a file. FGETINFO is provided for compatibility with MPE V/E-based systems only. It is recommended that FFILEINFO be used to access data.
I16V CA U16 U16 I16
FGETINFO (filenum, formaldesig, foption, aoption, lrecsize,
I16 U16 U16 I16 I32 I32 I32
devtype, ldevnum, hdaddr, filecode, lrecptr, eof, filelimit,
I32 I32 I16 U16 I16 I16
logcount, physcount, blksize, extsize, numextent, userlabels,
CA I32
creatorid, labaddr);
FGETKEYINFO
NM and CM callable. Requests access and status information about a KSAM file. For KSAM files only.
I16V BA BA
FGETKEYINFO (filenum, param, control)
FINDJCW
NM and CM callable. Searches the job control word table for a specified job control word (JCW) and returns its value.
CA U16 I16
FINDJCW (jcwname, jcwvalue, jcwstatus);
FINTEXIT
NM and CM callable. Causes the return from your interrupt procedure.
U16V
FINTEXIT (interruptstate);
FINTSTATE
NM and CM callable. Enables/disables all software interrupts against the calling process.
U16 U16V oldstate := FINTSTATE (interruptstate);
FLABELINFO
NM and CM callable. Returns information from the file label of a disk file.
CA I16V I16 I16A REC
FLABELINFO (formaldesig, mode, fserrorcode, itemnum, item,
I16A
itemerror);
FLOCK
NM and CM callable. Dynamically locks a file. If dynamically locking more than one RIN, multiple RIN (MR) capability is required.
I16V U16V
FLOCK (filenum, lockflag);
FLUSHLOG
NM and CM callable. Flushes the contents of the user logging memory buffer to the user logging file. User logging (LG) or system supervisor (OP) capability is required.
I32 I16
FLUSHLOG (index, logstatus);
FMTCALENDAR
NM and CM callable. Passes any calendar date, in the same format as the CALENDAR intrinsic, and returns it in the following format: FRI, JAN 27, 1989
U16V CA
FMTCALENDAR (date, formatdate);
FMTCLOCK
NM and CM callable. Passes the time of day, in the same format as the CLOCK intrinsic, and returns it in the following format:
I32V CA
FMTCLOCK (time, formattime);
FMTDATE
NM and CM callable. Passes in the calendar date and time of day, in the same format as the CALENDAR and CLOCK intrinsics, and returns it in the following format:
U16V I32V CA
FMTDATE (date, time, datetime);
FOPEN
NM and CM callable. Establishes access to a file and defines the physical characteristics of the file prior to access.
I16 CA U16V U16V I16V CA
filenum := FOPEN (formaldesig, foption, aoption, recsize, device,
CA I16V I16V I16V I32V I16V
formmsg, userlabels, blockfactor, numbuffer, filesize, numextent,
I16V I16V
initialloc, filecode);
FPARSE
NM and CM callable. Parses and validates MPE (only) file designators.
CA I16A U16A I32A
FPARSE (formaldesig, result, item, vector);
FPOINT
NM and CM callable. Sets the logical record pointer for a disk file containing fixed-length or undefined-length records to any logical record. When the next FREAD or FWRITE file request is made, this record is read or written to. (KSAM) Sets both the chronological and logical record pointers to the next record in chronological sequence (the order records were written to the file).
I16V I32V
FPOINT (filenum, lrecnum);
FREAD
NM and CM callable. Reads a logical record or portion of a record from a file to the stack.
I16 I16V UDS I16V transfercount := FREAD (filenum, buffer, length);
FREADBACKWARD
NM and CM callable. Reads a logical record backward from the current record pointer. Data is presented as if read forward. Used for tape files only. Can recover tape errors when handling I/O management and data recovery routines.
I16 I16V UDS I16V transfercount := FREADBACKWARD (filenum, buffer, length);
FREADBYKEY
NM and CM callable. Reads a logical record randomly from a KSAM file to the data stack. For KSAM file only.
I16V I16V LA I16V CA I16V length := FREADBYKEY (filenum, target, tcount, value, location);
FREADC
NM and CM callable. Reads a logical record in chronological sequence from a KSAM file to the data stack. For KSAM files only.
I16V I16V LA I16V length := FREADC (filenum, target, tcount);
FREADDIR
NM and CM callable. Reads a specific logical record or portion of a record from a direct-access disk file to the data stack.
I16V UDS I16V I32V
FREADDIR (filenum, buffer, length, lrecnum);
FREADLABEL
NM and CM callable. Reads a user-defined label from a disk or magnetic tape file.
I16V UDS I16V I16V
FREADLABEL (filenum, buffer, length, labelid);
FREADSEEK
NM and CM callable. Moves a record from a disk file to a buffer in anticipation of a FREADDIR intrinsic call.
I16V I32V
FREADSEEK (filenum, lrecnum);
FREEDSEG
NM and CM callable. Releases an extra data segment assigned it by the GETDSEG intrinsic. Data segment management (DS) capability is required. Data segment management (DS) intrinsics are not recommended for use in the MPE/iX native mode programming environment. Use of DS intrinsics in NM will degrade your program's performance.
U16V U16V
FREEDSEG (index, id);
FREELOCRIN
NM and CM callable. Frees all local resource identification numbers (RINs) from allocation to a job/session.
FREELOCRIN;
FRELATE
NM and CM callable. Determines whether a file pair (on any device) is interactive, duplicative, or both interactive and duplicative.
U16 I16V I16V intordup := FRELATE (infilenum, listfilenum);
FREMOVE
NM and CM callable. Marks the current record in a KSAM file for deletion. For KSAM files only.
I16V
FREMOVE (filenum);
FRENAME
NM and CM callable. Renames an open disk file (and its lockword, if applicable). The file being renamed must be either:
A new file.
An old file (permanent or temporary), opened for exclusive access with the exclusive option of the HPFOPEN/FOPEN intrinsics, and with security provisions allowing write access.
I16V CA
FRENAME (filenum, formaldesig);
FSETMODE
NM and CM callable. Controls the following access modes of files or devices:
Issuing carriage return and line feed to terminal after a terminal read.
Reporting tape automatic error recovery.
Guaranteeing chronological order of user program write requests.
Blocking program execution until physical completion of write requests.
I16V U16V
FSETMODE (filenum, modeflags);
FSPACE
NM and CM callable. Moves a record pointer forward or backward on a magnetic tape or disk file, spaces physical records on magnetic tape files and logical records on disk files.
I16V I16V
FSPACE (filenum, displacement);
FUNLOCK
NM and CM callable. Dynamically unlocks a file's global resource identification number (RIN) that was locked with the FLOCK intrinsic.
I16V
FUNLOCK (filenum);
FUPDATE
NM and CM callable. Updates (writes) a logical record in a disk file.
I16V UDS I16V
FUPDATE (filenum, buffer, length);
FWRITE
NM and CM callable. Writes a logical or physical record or portion of a record from the stack to a file on any device.
I16V UDS I16V U16V
FWRITE (filenum, buffer, length, controlcode);
FWRITEDIR
NM and CM callable. Writes a specific logical record from the stack to a disk file.
I16V UDS I16V I32V
FWRITEDIR (filenum, buffer, length, lrecnum);
FWRITELABEL
NM and CM callable. Writes a user-defined label onto a disk file or magnetic tape file that is labeled with an ANSI-standard or IBM-standard label. It also overwrites old user labels.
I16V UDS I16V I16V
FWRITELABEL (filenum, buffer, length, labelid);
GENMESSAGE
NM and CM callable. Provides access to messages in catalogs that were formatted with the MAKECAT utility.
I16 I16V I16V I16V CA
msglength := GENMESSAGE (filenum, setnum, msgnum, buffer,
I16V I16V * * * * *
buffersize, parmask, param1, param2, param3, param4, param5,
I16V I16
msgdestination, errornum);
GETDSEG
NM and CM callable. Creates or acquires an extra data segment for use by the process. Data segment management (DS) capability is required. Data segment management (DS) intrinsics are not recommended for use in the MPE/iX native mode programming environment. Use of DS intrinsics in NM degrades your program's performance.
U16 I16 U16V
GETDSEG (index, length, id);
GETINFO
NM and CM callable. Returns user-supplied information that was passed to a process when it was created.
I16 CA I16 I16 result := GETINFO (infostring, infolength, parm);
GETJCW
NM and CM callable. Returns the value of the system-defined job control word (JCW) to the calling process.
U16 jcw := GETJCW;
GETLOCRIN
NM and CM callable. Acquires local resource identification numbers (RINs) for a job/session.
U16V
GETLOCRIN (rincount);
GETORIGIN
NM and CM callable. Returns the source of the activation call for the calling process that has been previously suspended and subsequently reactivated. The source of the activation request can be the parent process, a child process, or another source (for example, an interrupt or the timer). Process handling (PH) capability is required.
I16 source := GETORIGIN;
GETPRIORITY
NM and CM callable. Changes the priority of a process. Process handling (PH) capability is required.
I16V U16V I16V
GETPRIORITY (pin, priorityclass, rank);
GETRIVMODE
NM and CM callable. Dynamically enters privileged mode. Privileged mode (PM) capability is required. The normal checks and limitations that apply to the standard users in MPE/iX are bypassed in privileged mode (PM). It is possible for a PM program to destroy file integrity, including the MPE/iX operating system software itself. Hewlett-Packard will investigate and attempt to resolve problems resulting from the use of PM code. This service, which is not provided under the standard service contract, is available on a time and materials billing basis. Hewlett-Packard will not support, correct, or attend to any modification of the MPE operating system software.
O-P GETPRIVMODE;
GETPROCID
NM and CM callable. Returns the process identification number (PIN) of a child process. Process handling (PH) capability is required.
I16 I16V pin := GETPROCID (numchild);
GETPROCINFO
NM and CM callable. Returns status information about the parent or a child process. Process handling (PH) capability is required.
I32 I16V processinfo := GETPROCINFO (pin);
GETUSERMODE
NM and CM callable. Dynamically returns a program to nonprivileged mode.
GETUSERMODE;
HP32208
CM callable only. Returns the current VUF (version, update, fix level) of KSAM/3000.
D version := HP32208
HPACDINFO
Lists security information from the access control definition (ACD) of a specified file or device. Any user with RACD access to an ACD can obtain information about that ACD.
I32 IV * IV *
HPACDINFO (status, itemnum1, item1 [,itemnum2, item2 [,...]]);
HPACDPUT
Manipulates security information in the access control definition (ACD) of a specified file or device.
I32 IV * IV *
HPACDPUT (status, itemnum1, item1, itemnum2, item2);
HPCALENDAR
This intrinsic returns the date in the supported date type code 4 listed in the table, "Supported Date Formats."
I32 date := HPCALENDAR;
HPCICOMMAND
NM callable only. Executes a command programmatically.
CA I16 I16 I16V
HPCICOMMAND (cmdimage, cmderror, parmnum, msglevel);
HPCIDELETEVAR
NM callable only. Removes a valid variable name from the session-level variable table.
CA I32
HPCIDELETEVAR (varname, status);
HPCIGETVAR
NM callable only. Retrieves a valid variable name from the session-level variable table and returns the current value and/or attributes.
CA I32 U32 *
HPCIGETVAR (varname, status [,itemnum, item [,...]]);
Up to six itemnum/item pairs can be specified.
HPCIPUTVAR
NM callable only. Sets the value of a session-level variable.
CA I32 U32 *
HPCIPUTVAR (varname, status [,itemnum, item [,...]]);
Up to three itemnum/item pairs can be specified.
HPDDATECONVERT
NM callable only. Converts the dates from one supported format to another.
I32V * I32V *
HPDATECONVERT (inputcode, inputdate, outputcode, outputdate,
I32V I32V
status, cutoff);
HPDDATEDIFF
NM callable only. This intrinsic determines the number of days that separate two given dates.
I32V * * I32
HPDATEDIFF (datecode, firstdate, seconddate, diffindays,
I32 I32V
status, cutoff);
HPDDATEFORMAT
NM callable only. You can use this routine to format the dates that can be combinations of display formats as explained below. Many of these elements are taken from ALLBASE/SQL date formats. You can convert dates in the "Supported Date Formats" to a display string of your choice (with restrictions). The HPDATEFORMAT intrinsic will accept these format strings. The format specifcation strings can have the following syntax:
[{Format Element}{Punctuation}]
HPDDATEOFFSET
NM callable only. This intrinsic adds or subtracts a specified offset to or from the given date.
I32V * I32V *
HPDATEOFFSET (datecode, inputdate, offset, outputdate,
I32 I32V
status, cutoff);
HPDDATEVALIDATE
NM callable only. This intrinsic checks the validity of the given date with respect to the supported formats given in the table, "Supported Date Formats.".
I32 I32V * I32V result := HPDATEVALIDATE (datecode, inputdate, cutoff);
HPDEBUG
NM callable only. Enters the system debugger and optionally executes a defined set of system debug commands.
I32 CA I32V *
HPDEBUG (status, cmdstr [,itemnum, item [,...]]);
HPDEVCONTROL
NM callable only. Provides access to specified peripheral functionality without the device being opened. Allows access to device utilities; not for general control (for example, reading or writing). Nonshareable device (ND) capability is required.
I32 CA I32 I32
HPDEVCONTROL (status, ldev, itemnum, item);
HPENBLTRAP
NM callable only. Selectively enables or disables arithmetic traps.
I32V I32
HPENBLTRAP (mask, oldmask);
HPERRDEPTH
NM callable only. Returns the current depth of the process error stack.
I32 I32
HPERRDEPTH (depth, status);
HPERRMSG
NM callable only. Obtains or displays error messages from the system catalog.
I32V I32V I16 I32V CA
HPERRMSG (displaycode, depth, errorproc, errornum, buffer,
I16 I32
buflength, status);
HPERRREAD
NM callable only. Reads any specified error from the process stack.
I32V I32 I32 I32
HPERRREAD (depth, errornum, procnum, status);
HPFADDTOPOINTER
NM callable only. This routine can be used to perform arithmetic on a 64-bit pointer value. Byte offsets can be added to or subtracted from a pointer by specifying either a positive or negative offset value.
@64 I64 @64 I32
HPFADDTOPOINTER (base_ptr, offset, return_ptr, status);
HPFDUPLICATE
NM callable only. Creates duplicate file descriptors for files opened for MULTI, SHARED, or EXCLUSIVE access.
I16 I32 I32V * filenum := HPFDUPLICATE (source, status, target);
HPFFILLDATA
NM callable only. This routine can be used to efficiently initialize a buffer with a specified character value.
I64 @64 CV I32
HPFFILLDATA (count, buffer_ptr, fill_char, status);
HPFIRSTLIBRARY
NM callable only. Returns the file name of the first native mode executable library (XL) in the binding sequence of the calling process.
CA I32 I32
HPFIRSTLIBRARY (formaldesig, status, length);
HPFMOVEDATA
NM callable only. This routine can be used to efficiently move data from a source buffer to a target buffer.
I64 @64 @64 I32
HPFMOVEDATA (count, source_ptr, target_ptr, status);
HPFMOVEDATALTOR
NM callable only. This routine can be used to efficiently move data from a source buffer to a target buffer. If the source and target buffers were viewed horizontally, like a line of text, the data movement is performed by starting at leftmost position of the source buffer (to the leftmost position of the target buffer) and proceeding to the rightmost
I64 @64 @64 I32
HPFMOVEDATALTOR (count, source_ptr, target_ptr, status);
HPFMOVEDATARTOL
NM callable only. This routine can be used to efficiently move data from a source buffer to a target buffer. If the source and target buffers were viewed horizontally, like a line of text, the data movement is performed by starting at rightmost position of the source buffer (to the rightmost position of the target buffer) and proceeding to the leftmost
I64 @64 @64 I32
HPFMOVEDATARTOL (count, source_ptr, target_ptr, status);
HPFMTCALENDAR
NM callable only. This intrinsic handles HPCALENDAR format. It does the same job as FMTCALENDAR except that it accepts the 32-bit integer returned by HPCALENDAR intrinsic.
I32V CA
HPFMTCALENDAR (date, formatdate);
HPFOPEN
NM callable only. Establishes access to a file on any device and creates a file on any shareable device.
I32 I32 I32V *
HPFOPEN (filenum, status [,itemnum, item [,...]]);
Up to 87 itemnum/item pairs can be specified.
HPFPCONVERT
NM callable only. Converts data between binary floating-point formats.
* * I16V I16V I32
HPFPCONVERT (source, destination, sformat, dformat, status,
I16 I16V
exceptions, roundmode);
HPGETPROCPLABEL
NM callable only. Dynamically loads a native mode (NM) executable library procedure.
CA U32 I32 CA
HPGETPROCPLABEL (procname, plabel, status, firstfile,
B
casesensitive);
HPLOADCMPROCEDURE
NM callable only. Obtains CM procedure plabel in preparation for Switch to CM through plabel.
U16 CA U16V I32 plabel := HPLOADCMPROCEDURE (procname, library, status);
HPLOADNMPROC
CM callable only. Returns the plabel of an NM procedure.
U32 CA I16V CA I16V plabel := HPLOADNMPROC (procname, proclen, libname, liblen);
HPMERGEEND
NM callable only. Releases the MERGE/XL work area and ends the merging operation.
I32 I32A
HPMERGEEND (status, statistics);
HPMERGEERRORMESS
NM callable only. Accepts HP MERGE intrinsic error code values and returns the error messages associated with them.
I32 CA I32
HPMERGEERRORMESS (status, message, length);
HPMERGEINIT
NM callable only. Initializes the MERGE/XL subsystem.
I32 I32A PROC I32A
HPMERGEINIT (status, inputfiles, preprocessor, outputfiles,
PROC I32V I32V I32A CA PROC
postprocessor, keysonly, numkeys, keys, altseq, keycompare,
PROC I32A I32V I32A
errorproc, statistics, memsize, charseq);
HPMERGEOUTPUT
NM callable only. Retrieves records, one at a time, from MERGE/XL.
I32 CA I32
HPMERGEOUTPUT (status, buffer, length);
HPMERGESTAT
NM callable only. Prints MERGE/XL statistics on $STDLIST.
I32 I32A
HPMERGESTAT (status, statistics);
HPMERGETITLE
NM callable only. Prints the version number and title information for MERGE/XL on $STDLIST.
I32
HPMERGETITLE (status);
HPMYFILE
NM callable only. Returns the file name of the native mode program or executable library (XL) that called the HPMYFILE intrinsic.
CA I32 I32
HPMYFILE (formaldesig, status, length);
HPMYPROGRAM
NM callable only. Returns the file name of the program being executed by the calling process.
CA I32 I32
HPMYPROGRAM (formaldesig, status, length);
HPRESETDUMP
NM callable only. Disarms the system debugger call from a process abort.
I32
HPRESETDUMP (status);
HPSETCCODE
NM callable only. Sets the condition code for the calling process.
I32V
HPSETCCODE (ccodevalue);
HPSETDUMP
NM callable only. Arms the system debugger call from a process abort.
I32 CA
HPSETDUMP (status, cmdstr);
HPSORTEND
NM callable only. Releases the SORT/XL work area and ends the sorting operation.
I32 I32A
HPSORTEND (status, statistics);
HPSORTERRORMESS
NM callable only. Retrieves an error message if a fatal error occurs in SORT/XL.
I32 CA I32
HPSORTERRORMESS (status, message, length);
HPSORTINIT
NM callable only. Initializes the SORT/XL subsystem.
I32 I32A I32A I32
HPSORTINIT (status, inputfiles, outputfiles, outputoption,
I32V I32V I32V I32A CA PROC
reclength, numrecs, numkeys, keys, altseq, keycompare,
PROC I32A I32V I32A
errorproc, statistics, memsize, charseq);
HPSORTINPUT
NM callable only. Passes records, one at a time, to SORT/XL.
I32 CA I32V
HPSORTINPUT (status, buffer, length);
HPSORTOUTPUT
NM callable only. Retrieves records, one at a time, from SORT/XL program.
I32 CA I32
HPSORTOUTPUT (status, buffer, length);
HPSORTSTAT
NM callable only. Prints the SORT/XL statistics on $STDLIST.
I32 I32A
HPSORTSTAT (status, statistics);
HPSORTTITLE
NM callable only. Prints the version number and title information for SORT/XL on $STDLIST and prints the date and time produced by the DATELINE intrinsic.
I32
HPSORTTITLE (status);
HPSWITCHTOCM
NM callable only. Makes native mode (NM) to compatibility mode (CM) mixed-mode procedure calls possible.
REC I32V I32V RECA I32V RECV
HPSWITCHTOCM (proc, method, numparms, parms, fretlen, fretval,
I16 I32
condcode, status);
HPSWTONMNAME
CM callable only. Allows CM user programs, user libraries, and system code to invoke NM procedures as follows:
Convert CM references in an argument list to virtual NM addresses.
Change the execution mode.
Invoke the NM procedure specified by the CM caller.
CA I16V CA I16V I16V I16
HPSWTONMNAME (procname, proclen, libname, liblen, nparms, arglist,
I16 I16V
argdesc, functype);
HPSWTONMPLABEL
CM callable only. Allows CM user programs, user libraries, and system code to invoke NM procedures as follows:
Convert CM references in the argument list to virtual NM addresses.
Change the execution mode.
Invoke the NM procedure specified by the CM caller.
U32V I16V I16 I16 I16V
HPSWTONMPLABEL (proc, nparms, arglist, argdesc, functype):
HPUNLOADCMPROCEDURE
NM callable only. Unloads a target CM procedure whose plabel is obtained through the HPLOADCMPROCEDURE intrinsic.
CA U8V I32
HPUNLOADCMPROCEDURE (procname, library, status);
INITUSLF
NM and CM callable. Initializes a USL file to the empty state. A USL contains CM object code and is meaningful only in the CM program development process.
I16 I16V I16A uslferror := INITUSLF (uslfnum, record);
IODONTWAIT
NM and CM callable. Initiates completion operations for an I/O request.
I16 I16V UDS I16 U16 fnum := IODONTWAIT (filenum, buffer, length, cstation);
IOWAIT
NM and CM callable. Initiates completion operations for an I/O request.
I16 I16V UDS I16 U16 fnum := IOWAIT (filenum, buffer, length, cstation);
JOBINFO
NM and CM callable. Provides access to job and session information.
I16V I32 U16A I16V * I16
JOBINFO (jsind, jsnum, jsstatus [,itemnum, item, itemerror [,...]]);
Up to five
itemnum/item/itemerror triples
can be specified.
KILL
NM and CM callable. Deletes a child process of the calling process and all of its descendants. Process handling (PH) capability is required.
I16V
KILL (pin);
LOADPROC
NM and CM callable. Dynamically loads a compatibility mode (CM) segmented library (SL) procedure and any external procedures it has referenced.
I16 CA I16V I16 idnum := LOADPROC (procname, library, plabel);
LOCKGLORIN
NM and CM callable. Locks a global resource identification number (RIN). Multiple RIN (MR) capability is required to lock more than one global RIN simultaneously.
I16V U16 CA
LOCKGLORIN (rinnum, lockflag, rinpassword);
LOCKLOCRIN
NM and CM callable. Locks a local resource identification number (RIN).
I16V U16
LOCKLOCRIN (rinnum, lockflag);
LOCRINOWNER
NM and CM callable. Determines process identification number (PIN) of the process that locked a local resource identification number (RIN).
I16 I16V pin := LOCRINOWNER (rinnum);
LOGINFO
NM and CM callable. Provides information about an opened user logging file (whole file set). User logging (LG) or system supervisor (OP) capability is required.
I32V I16 I16V *
LOGINFO (index, logstatus [,itemnum, item [,...]]);
Up to four itemnum/item pairs can be specified.
LOGSTATUS
NM and CM callable. Provides information about a currently opened user logging file. User logging (LG) or system supervisor (OP) capability is required.
I32 U16A I16
LOGSTATUS (index, loginfo, logstatus);
NM and CM callable. Determines the status of the mailbox used by its parent or child. Process handling (PH) capability is required.
U16 I16V I16 mailstatus := MAIL (pin, length);
MERGEEND
NM and CM callable. Restores the data stack to its original state and ends the merging operation.
MERGEEND;
MERGEERRORMESS
NM and CM callable. Retrieves a message if a fatal error occurs during the MERGE/XL operation and converts MERGEINIT error code values into ASCII strings.
I16V CA I16
MERGEERRORMESS (errorcode, message, length);
MERGEINIT
NM and CM callable. Initializes the MERGE/XL subsystem and the merging of two or more sorted files.
I16A PROC I16A PROC
MERGEINIT (inputfiles, preprocessor, outputfiles, postprocessor,
I16V I16V I16A I16A PROC PROC
keysonly, numkeys, keys, altseq, keycompare, errorproc,
I16A I16 I16 I16 I16A
statistics, failure, errorparm, spaceallocation, charseq);
MERGEOUTPUT
NM and CM callable. Provides an alternative method of specifying how records are output from the MERGE program.
CA I16
MERGEOUTPUT (record, length);
MERGESTAT
NM and CM callable. Prints the MERGE program statistics on $STDLIST.
I16A
MERGESTAT (statistics);
MERGETITLE
NM and CM callable. Prints the version number and title of the merge segment on $STDLIST and prints the date and time produced by the DATELINE intrinsic.
MERGETITLE;
MYCOMMAND
NM and CM callable. Parses (delineates and defines) parameters for a user-defined command image.
I16 CA CA I16V
entrynum := MYCOMMAND (cmdimage, delimiters, maxparms,
I16 I32A CA @*
numparms, params, dictionar, definition);
NLAPPEND
NM and CM callable. Appends a language ID number to a file name that allows an application to designate which language-dependent file to use.
CA I16V U16A
NLAPPEND (formaldesig, langnum, error);
NLCOLLATE
NM and CM callable. Collates two character strings according to the specified language collating sequence and determines a lexical ordering.
CA CA I16V I16 I16V
NLCOLLATE (buffer1, buffer2, bufferlength, result, langnum,
U16A U16A
error, collseq);
NLCONVCLOCK
NM and CM callable. Converts the time format from a character string to numeric value; checks the input string using the formatting template returned by itemnum=3 of the NLINFO intrinsic, then converts the time to the general time format returned by the CLOCK intrinsic.
I32 CA I16V I16V U16A time := NLCONVCLOCK (buffer, bufferlength, langnum, error);
NLCONVCUSTDATE
NM and CM callable. Converts the custom date format from a character string to a numeric value; checks the input string by using the formatting template returned by item 2 of the NLINFO intrinsic, then converts the date to the general date format as returned by the CALENDAR intrinsic.
U16 CA I16V I16V U16A date := NLCONVCUSTDATE (buffer, bufferlength, langnum, error);
NLCONVNUM
NM and CM callable. Converts native language numbers with native decimal and thousands separators to an ASCII number with NATIVE-3000 decimal and thousands separators. Optionally, the decimal and thousands separators can be removed.
I16V CA I16V CA I16V U16V
NLCONVNUM (langnum, instring, inlength, outstring, outlength, error,
U16V U16V U16V O-V
numspec, fmtmask, decimals);
NLFINDSTR
NM and CM callable. Searches string1 for string2, and returns an integer value indicating the offset in string1 where string2 was found.
I16 I16V CA I16V CA I16V
offset := NLFINDSTR (langnum, string1, length1, string2, length2,
U16A U16A
error, charset);
NLFMTCALENDAR
NM and CM callable. Formats the date according to language-dependent templates. The formatting is done according to the template returned by itemnum=1 of the NLINFO intrinsic.
U16V CA I16V U16A
NLFMTCALENDAR (date, buffer, langnum, error);
NLFMTCLOCK
NM and CM callable. Formats the time of day, in the specified language, obtained with the CLOCK intrinsic.
I32V CA I16V U16A
NLFMTCLOCK (time, buffer, langnum, error);
NLFMTCUSTDATE
NM and CM callable. Formats the general date format returned by the CALENDAR intrinsic into the custom date format for a native language. A custom date is an abbreviated format such as 10/1/82 or 82.10.1. The formatting is done according to the template returned by itemnum=2 of the NLINFO intrinsic.
U16V CA I16V U16A
NLFMTCUSTDATE (date, buffer, langnum, error);
NLFMTDATE
NM and CM callable. Formats the date and time according to language-dependent templates returned by itemnums 1 and 3 of the NLINFO intrinsic.
U16V I32V CA I16V U16A
NLFMTDATE (date, time, buffer, langnum, error);
NLFMTLONGCAL
NM and CM callable. Formats the supplied date according to the long calendar format. The formatting is done according to the template returned by NLINFO itemnum=30.
LV BA IV LA
NLFMTLONGCAL (date, string, langnum, error);
NLFMTNUM
NM and CM callable. Converts a string containing an ASCII number (can include NATIVE-3000 decimal separator (.), thousands separator (,), and currency symbol/name ($)) to a language-specific format using the decimal separator, thousands separator, and currency symbol/name defined for the native language.
I16V CA I16V CA I16V U16A
NLFMTNUM (langnum, instring, inlength, outstring, outlength, error,
U16A U16V I16V O-V
numspec, fmtmask, decimals);
NLGETLANG
NM and CM callable. Returns a language ID number that characterizes the current user, data, or system. Hewlett-Packard subsystems and application programs use NLGETLANG for automatic configuration.
I16 I16V U16A langnum := NLGETLANG (langtype, error);
NLINFO
NM and CM callable. Returns language-dependent information. The type of information that can be obtained includes:
Calendar format
Date and time format
Currency
Collating
Translation
Character set
I16V * I16 U16A
NLINFO (itemnum, item, langnum, error);
NLJUDGE
NM and CM callable. Judges whether a character is a 1 byte or 2 byte Asian character.
I16V I16V CA I16V CA
n2bytes := NLJUDGE (langnum, instring, stringlength, flags,
U16A U16A
error, charset);
NLKEYCOMPARE
NM and CM callable. Compares two strings of different length (for use with KSAM generic key searching).
CA I16V CA I16V I16 I16V
NLKEYCOMPARE (generickey, length1, key, length2, result, langnum,
U16A U16A
error, collseq);
NLNUMSPEC
NM and CM callable. Returns the information needed for formatting and converting numbers. It combines several calls to NLINFO to simplify the use of native language formatting. By calling NLNUMSPEC once, and passing the obtained information to NLFMTNUM and NLCONVNUM, implicit calls to NLNUMSPEC from NLFMTNUM and NLCONVNUM are avoided and performance is improved.
I16V U16A U16A
NLNUMSPEC (langnum, string, error);
NLREPCHAR
NM and CM callable. Replaces all nondisplayable control characters in the string with the replacement character. Nondisplayable characters are those with attribute 3 (undefined graphic character) or 5 (control code), as returned by itemnum=12 of the NLINFO intrinsic.
CA CA I16V CV I16V
NLREPCHAR (inbuffer, outbuffer, bufferlength, replacechar, langnum,
U16A U16A
error, charset);
NLSCANMOVE
NM and CM callable. Scans and moves character strings according to character attributes. This function is handled in a language-dependent manner.
I16 CA CA U16V I16V
numchar := NLSCANMOVE (inbuffer, outbuffer, flags, bufferlength,
I16V U16A U16A CA
langnum, error, charset, shiftinfo);
NLSUBSTR
NM and CM callable. Extracts movelength bytes from the instring to the outstring.
CA I16V CA I16 I16V
NLSUBSTR (instring, inlength, outstring, outlength, startposition,
I16V I16V I16V U16A U16A
movelength, langnum, flags, error, charset);
NLSWITCHBUF
NM and CM callable. Converts a string of characters from phonetic order to screen order or from screen order to phonetic order.
I16V CA CA I16V
NLSWITCHBUF (langnum, instring, outstring, stringlength,
U16V U16A
left-to-right, error);
NLTRANSLATE
NM and CM callable. Translates a string of characters from EBCDIC-to-ASCII or ASCII-to-EBCDIC using the appropriate native language table.
I16V CA CA I16V I16V
NLTRANSLATE (transcode, inbuffer, outbuffer, bufferlength, langnum,
U16A CA
error, transtable);
OPENLOG
NM and CM callable. Provides access to the user logging facility. User logging (LG) or system supervisor (OP) capability is required.
I32 CA CA I16 I16
OPENLOG (index, logid, pass, mode, logstatus);
PAUSE
NM and CM callable. Suspends the calling process for a specified number of seconds.
R32
PAUSE (interval);
NM and CM callable. Prints character string on job/session listing device.
CA I16V I16V
PRINT (message, length, controlcode);
PRINTFILEINFO
NM and CM callable. Prints a file or directory information display on the job/session list device.
I16V
PRINTFILEINFO (filenum);
PRINTOP
NM and CM callable. Prints a character string on the system console.
CA I16V I16V
PRINTOP (message, length, controlcode);
PRINTOPREPLY
NM and CM callable. Prints a character string on the system console and solicits a reply.
I16 CA I16V I16V CA I16V length := PRINTOPREPLY (message, length, zero, reply, maxlength);
PROCINFO
NM and CM callable. Provides access to process information.
I16 I16 I16V I16V *
PROCINFO (error1, error2, pin [,itemnum, item [,...]]);
Up to six itemnum/item pairs can be specified.
PROCTIME
NM and CM callable. Returns the accumulated CPU time for a process.
I32 time := PROCTIME;
PUTJCW
NM and CM callable. Assigns the value of a particular job control word (JCW) in the job control word table.
CA U16 I16
PUTJCW (jcwname, jcwvalue, jcwstatus);
QUIT
NM and CM callable. Aborts the calling process.
I16V
QUIT (num);
QUITPROG
NM and CM callable. Aborts the entire user process structure.
I16V
QUITPROG (num);
READ
NM and CM callable. Reads an ASCII string from $STDIN into an array.
I16 CA I16V length := READ (message, msglength);
READX
NM and CM callable. Reads an ASCII string from $STDINX into an array.
I16 CA I16V length := READX (message, msglength);
RECEIVEMAIL
NM and CM callable. Receives mail from another process. Process handling (PH) capability is required.
U16 I16V UDS U16V mailstatus := RECEIVEMAIL (pin, location, waitflag);
RESETCONTROL
NM and CM callable. Reenables the subsystem break trap which allows a process to accept other subsystem break signals.
RESETCONTROL;
RESETDUMP
NM and CM callable. Disables the abort stack analysis facility. Only the current process is affected.
RESETDUMP;
SEARCH
NM and CM callable. Searches a specially-formatted array for a specified entry or name.
I16 CA I16V CA @* entrynum := SEARCH (buffer, length, dictionary, definition);
SENDMAIL
NM and CM callable. Sends mail to another process. Process handling (PH) capability is required.
U16 I16V I16V UDS U16V mailstatus := SENDMAIL (pin, length, location, waitflag);
SETDUMP
NM and CM callable. Arms a call to the system debugger from a process abort.
I16V
SETDUMP (flags);
SETJCW
NM and CM callable. Sets bits in the system job control word (JCW).
U16V
SETJCW (jcword);
SORTEND
NM and CM callable. Closes the scratch file and restores the data stack to its original state.
SORTEND;
SORTERRORMESS
NM and CM callable. Retrieves and prints a message if a fatal error occurs during the SORT program.
I16V CA I16
SORTERRORMESS (errorcode, message, length);
SORTINIT
NM and CM callable. Initiates the SORT program.
I16A I16A I16V I16V
SORTINIT (inputfiles, outputfiles, outputoption, reclength,
I32V I16V I16A I16A PROC PROC
numrecs, numkeys, keys, altseq, keycompare, errorproc,
I16A I16 I16 I16 I16A
statistics, failure, errorparm, spaceallocation, charseq);
SORTINPUT
NM and CM callable. Provides an alternative method of specifying how records are supplied to the SORT program.
CA I16V
SORTINPUT (record, length);
SORTOUTPUT
NM and CM callable. Provides an alternative method of specifying how records are output from the SORT program.
CA I16
SORTOUTPUT (record, length);
SORTSTAT
NM and CM callable. Prints the SORT program statistics on $STDLIST. Call SORTSTAT after you have called the SORTEND intrinsic.
I16A
SORTSTAT (statistics);
SORTTITLE
NM and CM callable. Prints the version number and title of the SORTLIB segment on $STDLIST.
SORTTITLE;
STACKDUMP
NM and CM callable. Calls the system debugger to send a stack trace to $STDLIST or to the file specified in the formaldesig parameter. Control then returns to the calling procedure. (NM and CM)
CA I16V I16V I32
STACKDUMP (formaldesig, idnumber, flags, selec);
(CM: SPL language only)
CA I16V I16V I32
STACKDUMP' (formaldesig, idnumber, flags, selec);
STARTSESS
NM and CM callable. Initiates a session on the specified terminal. Programmatic sessions (PS) capability is required.
I16V CA I16 I32 I16A
STARTSESS (ldev, logonstring, jsid, jsnum, jsstatus);
SUSPEND
NM and CM callable. Suspends a process. Process handling (PH) capability is required.
U16V I16V
SUSPEND (allow, rin);
SWITCHDB
CM callable only. Switches the DB register pointer. Privileged mode (PM) capability is required.
U16 O-P U16V logindex := SWITCHDB (index)
TERMINATE
NM and CM callable. Releases all resources held by the process and its descendants are released. All remaining files, opened by the process and its descendants, are closed and assigned the same disposition they had when opened.
TERMINATE;
TIMER
NM and CM callable. Returns system timer information.
I32 count := TIMER;
UNLOADPROC
NM and CM callable. Dynamically unloads a compatibility mode (CM) segmented library (SL) procedure.
I16V
UNLOADPROC (procid);
UNLOCKGLORIN
NM and CM callable. Unlocks a global resource identification number (RIN) that was locked with the LOCKGLORIN intrinsic.
I16V
UNLOCKGLORIN (rinnum);
UNLOCKLOCRIN
NM and CM callable. Unlocks a local resource identification number (RIN) that was locked by the LOCKLOCRIN intrinsic.
I16V
UNLOCKLOCRIN (rinnum);
WHO
NM and CM callable. Returns the access mode and attributes of the user calling the intrinsic.
U16 I32 I32 CA CA CA
WHO (mode, capability, localattr, username, groupname, acctname,
CA U16
homename, term);
WRITELOG
NM and CM callable. Writes database and subsystem file records to the user logging file. User logging (LG) or system supervisor (OP) capability is required.
I32 U16A I16 I16 I16
WRITELOG (index, data, length, mode, logstatus);
XARITRAP
NM and CM callable. Arms or disarms the user-written arithmetic trap handling procedure.
I*V I32V I32 I32
XARITRAP (mask, plabel, oldmask, oldplabel);
XCONTRAP
NM and CM callable. Arms or disarms user-written subsystem break trap handling procedure.
I*V I*
XCONTRAP (plabel, oldplabel);
XLIBTRAP
NM and CM callable. Enables or disables a user-written software library trap handling procedure.
I*V I*
XLIBTRAP (plabel, oldplabel);
XSYSTRAP
NM and CM callable. Enables or disables a user-written system trap handling procedure.
I*V I*
XSYSTRAP (plabel, oldplabel);
ZSIZE
NM and CM callable. Alters current DB to Z area of the compatibility mode (CM) stack.
I16 I16V newsize := ZSIZE (size);
|
Chapter 3 Intrinsics Descriptions |
Chapter 4 FCOPY Commands |