900 Series HP 3000 Computer Systems MPE/iX Intrinsics Reference Manual ABCDE HP Part No. 32650-90028 Printed in U.S.A.
The information contained in this document is subject to change without notice. Hewlett-Packard makes no warranty of any kind with regard to this material, including, but not limited to, the implied warranties of merchantability or tness for a particular purpose. Hewlett-Packard shall not be liable for errors contained herein or for direct, indirect, special, incidental or consequential damages in connection with the furnishing or use of this material.
Printing History The following table lists the printings of this document, together with the respective release dates for each edition. The software version indicates the version of the software product at the time this document was issued. Many product releases do not require changes to the document. Therefore, do not expect a one-to-one correspondence between product releases and document editions.
iv
Preface MPE/iX, Multiprogramming Executive with Integrated POSIX, is the latest in a series of forward-compatible operating systems for the HP 3000 line of computers. In HP documentation and in talking with HP 3000 users, you will encounter references to MPE XL, the direct predecessor of MPE/iX. MPE/iX is a superset of MPE XL.
vi
Conventions UPPERCASE In a syntax statement, commands and keywords are shown in uppercase characters. The characters must be entered in the order shown; however, you can enter the characters in either uppercase or lowercase.
Conventions (continued) [ ... ] In a syntax statement, horizontal ellipses enclosed in brackets indicate that you can repeatedly select the element(s) that appear within the immediately preceding pair of brackets or braces. In the example below, you can select parameter zero or more times. Each instance of parameter must be preceded by a comma: [,parameter][...
Contents 1. Introduction What Is an Intrinsic? . . . . . . . . . . . . . . . . . . . . . . . . . What Is an Intrinsic Mechanism? . . . . . . . . . . . . . . . . . . . . 2. Intrinsic Use Parameters . . . . . . . . . . . Parameter Declarations . . . . Parameter Alignment . . . . . Parameter Bit Settings . . . . Syntax Statement Mnemonics . Itemnum and Item Pair Options Data Type Mappings . . . . . Functional Returns . . . . . . . Error Handling . . . . . . . . . Condition Code Errors . . . . .
CATREAD . . . . CAUSEBREAK . . CLEANUSL . . . . CLOCK . . . . . . CLOSELOG . . . . COMMAND . . . . CREATE . . . . . CREATEPROCESS . CTRANSLATE . . . DASCII . . . . . . DATELINE . . . . DBINARY . . . . . DEBUG . . . . . . DLSIZE . . . . . . DMOVIN . . . . . DMOVOUT . . . . ENDLOG . . . . . EXPANDUSLF . . . FATHER . . . . . FCHECK . . . . . FCLOSE . . . . . . FCONTROL . . . . FDELETE . . . . . FDEVICECONTROL FERRMSG . . . . FFILEINFO . . . . FFINDBYKEY . . . FFINDN . . . . . . FGETINFO . . . . FGETKEYINFO . .
FRELATE . . . . . . . . FREMOVE . . . . . . . FRENAME . . . . . . . FSETMODE . . . . . . . FSPACE . . . . . . . . . FUNLOCK . . . . . . . FUPDATE . . . . . . . . FWRITE . . . . . . . . FWRITEDIR . . . . . . FWRITELABEL . . . . . GENMESSAGE . . . . . GETDSEG . . . . . . . . GETINFO . . . . . . . . GETJCW . . . . . . . . GETLOCRIN . . . . . . GETORIGIN . . . . . . . GETPRIORITY . . . . . GETPRIVMODE . . . . . GETPROCID . . . . . . GETPROCINFO . . . . . GETUSERMODE . . . . HP32208 . . . . . . . . . HPACDINFO .
HPRESETDUMP . . . . . . HPSELECT . . . . . . . . HPSETCCODE . . . . . . HPSETDUMP . . . . . . . HPSORTEND . . . . . . . HPSORTERRORMESS . . . HPSORTINIT . . . . . . . HPSORTINPUT . . . . . . HPSORTOUTPUT . . . . . HPSORTSTAT . . . . . . . HPSORTTITLE . . . . . . HPSWITCHTOCM . . . . . HPSWTONMNAME . . . . HPSWTONMPLABEL . . . HPUNLOADCMPROCEDURE HPVOLINFO . . . . . . . INITUSLF . . . . . . . . . IODONTWAIT . . . . . . . IOWAIT . . . . . . . . . . JOBINFO . . . . . . . . . KILL . . . . . . . . . . .
NLKEYCOMPARE . NLMATCH . . . . NLMATCHINIT . . NLNUMSPEC . . . NLREPCHAR . . . NLSCANMOVE . . NLSUBSTR . . . . NLSWITCHBUF . . NLTRANSLATE . . OPENLOG . . . . PAUSE . . . . . . PRINT . . . . . . PRINTFILEINFO . PRINTOP . . . . . PRINTOPREPLY . PROCINFO . . . . PROCTIME . . . . PUTJCW . . . . . QUIT . . . . . . . QUITPROG . . . . READ . . . . . . . READX . . . . . . RECEIVEMAIL . . RESETCONTROL . RESETDUMP . . . SEARCH . . . . . SENDMAIL . . . . SETDUMP . . . . SETJCW . . . . . SORTEND . . . . .
ZSIZE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Figures 4-1. 4-2. 4-3. 4-4. 4-5. 4-6. 4-7. 4-8. 4-9. DMOVIN Data Movement. . . DMOVOUT Data Movement. Foption Bit Summary . . . . Aoption Bit Summary . . . . Foption Bit Summary . . . . Aoption Bit Summary . . . . Foption Bit Summary . . . . Carriage Control Byte . . . . Carriage-Control Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Tables 2-1. 2-2. 2-3. 2-4. 2-5. 2-6. 3-1. 3-2. 3-3. 3-4. 3-5. 3-6. 3-7. 3-8. 3-9. 3-10. 3-11. 3-12. 3-13. 3-14. 3-15. 3-16. 3-17. 3-18. 3-19. 3-20. 4-1. 4-2. 4-3. 4-4. 4-5. 4-6. 4-7. 4-8. 4-9. 4-10. 4-11. 4-12. 4-13. 4-14. 4-15. 4-16. 4-17. Mnemonic Descriptions . . . . . . . . . . . . . . Data Type Mappings . . . . . . . . . . . . . . . Condition Code Descriptions . . . . . . . . . . . . Status.subsys Parameter Identi ers . . . . . . . . . Status.info Parameter Identi ers . . . . . . . . . .
4-18. 4-19. 4-20. 4-21. 4-22. 4-23. 4-24. 4-25. 4-26. 4-27. HPDEVCONTROL Itemnum/Item Values HPDEVCREATE Keywords/Keyvalues . HPFOPEN Itemnum/Item Values . . . . . . . . . . . . . . . . . . . . . . . JOBINFO Itemnum/Item Values . . . . LOGINFO Itemnum/Item Values . . . . NLINFO Itemnum/Item Values . . . . . PROCINFO Error1,Error2 Values . . . . PROCINFO Itemnum/Item Values . . . STARTSESS Status Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1 Introduction Many programs use procedures or subroutines to handle recurring tasks. In the MPE/iX operating system many of these tasks are performed by a set of system procedures called intrinsics. Intrinsics are available to any process which has the capabilities required to call the intrinsic.
What Is an Intrinsic? The term intrinsic refers to any external system or subsystem. However, under MPE/iX this term has a more speci c meaning. To qualify as a true Hewlett-Packard documented and user-callable intrinsic, it must meet the following criteria: An intrinsic is a Hewlett-Packard supported external interface to an operating system or subsystem service.
What Is an Intrinsic Mechanism? The MPE/iX intrinsics mechanism provides exible and convenient access to intrinsic routines from various languages. When an external routine is designated as an intrinsic, the compiler uses the intrinsics mechanism to determine how to invoke the routine correctly.
2 Intrinsic Use You invoke an intrinsic by calling it explicitly from within a program, subprogram, or procedure. All system intrinsics are treated as external procedures by user programs and the intrinsics mechanism facilitates the declaration.
A process must call intrinsic parameters in the exact calling sequence (order) speci ed in the syntax statement and must separate them by commas. For example, write a call to the CLOSELOG intrinsic as follows: CLOSELOG(ACCESS,0,0); You must represent optional intrinsic parameters if they are missing. To indicate a missing parameter within the parameter list, omit the parameter, but retain the preceding commas.
Syntax Statement Mnemonics An intrinsic's syntax statement contains the calling sequence, or order, of the parameters, indicates whether a parameter is required or optional, and speci es the parameter type. Syntax statements have the following format: I16V U16V ACTIVATE(pin,allow); Required parameters, such as pin in the example above, appear in boldface italics. Optional parameters, such as allow , are shown in italics .
Table 2-1.
Data Type Mappings Table 2-2 maps generic data types to possible implementations in programming languages supported by the operating system. The mnemonics associated with the generic types appear in parentheses. For more information on calling intrinsics from these languages, refer to the appropriate language reference manual. Note The IEEE oating-point standard is the default real format for the 900 Series Hewlett-Packard 3000 computers.
Table 2-2. Data Type Mappings Generic Type COBOL II/XL FORTRAN 77/XL Pascal/XL C & C/XL 16-bit signed integer (I16) PIC S9(1) - S9(4) BINARY SYNC Integer*2 SHORTINT or any SHORTINT 16-bit subrange 32-bit signed integer (I32) PIC S9(5) - S9(9) BINARY SYNC Integer or integer*4 Integer or any 32-bit subrange 32-bit 64-bit signed integer (I64) PIC S9(10) S9(18) BINARY SYNC N/A N/A N/A 16-bit unsigned integer (U16) PIC S9(1) - S9(4) BINARY SYNC Integer*2 0..
Functional Returns Certain intrinsics return a value to the calling program in functional returns. These routines return a speci ed value type (for example, 16-bit signed integer, character, or 64-bit real) in its name. Functional returns are declared in an assignment statement, where the value returned is assigned to some variable of the same type as the functional return. The symbol := is the assignment operator that is \assigned the value of" or \receives the value of".
Error Handling Three types of errors can occur when an intrinsic is executed: Condition code errors. Such errors are generally recoverable since control returns to the calling program. The operating system maintains condition codes to provide backward compatibility with previous (MPE V/E-based) operating systems. Status parameter errors. When you include the status parameter in the intrinsic call, it returns status information to the calling routine.
Status Parameter Errors Some intrinsics use the status parameter to return information on the status of the intrinsic call. This parameter is a native mode (NM) implementation of the condition code feature with extended capabilities. The status parameter is a 32-bit signed integer value passed by reference. Note It is good programming practice to specify the status parameter and check its value after an intrinsic call.
Table 2-4. Status.
Table 2-4. Status.
Abort Errors Software traps are interrupts generated by software events in which the operating system interrupts the normal ow of a process' execution. Some intrinsics generate a software trap when they detect certain error conditions. Normally, if an intrinsic causes a trap, the system trap handler aborts the user program. However, you can write a procedure to handle abort errors and use it in place of the default system trap handler, which will permit recovery from errors in certain cases.
Additional Capabilities Required Most system intrinsics do not require additional capabilities to access operating system features. However, if an intrinsic requires the operating system to check for an additional capability at program load and/or run time, that capability must be assigned prior to running the program. Table 2-6 lists additional capabilities and the assignments required by some intrinsics.
The operating system performs two capability checks prior to executing the program. The checks must succeed before the program can run: At load time, the le system checks the user capability list against the account-level, group-level, and le-level security provisions for the program le and all referenced executable library (XL) les. At load time, the loader checks the program le's capability list against the capability list for the group in which the program le resides.
PH Capability The process handling (PH) capability allows you to do the following programmatically: Create and delete processes Activate and suspend processes Send mail between processes Change process scheduling Get existing process information PM Capability The privileged mode (PM) capability allows you to access all operating system routines and data structures. The operating system protects privileged users from executing at the same privilege level as the operating system.
3 Intrinsic Tasks This chapter is a quick reference for locating intrinsics that perform designated tasks. Table 3-1 through Table 3-14 describe the general task, a subtask to the general task, and the intrinsic associated with it. The general task is, in most cases, the title of a programmer's guide and the subtasks correlate to chapters within that programmer's guide. For information about the intrinsic speci cally, refer to chapter 4 of this manual.
Table 3-1.
Accessing Files (Continued) Function Intrinsic Manual Error Checking HPERRDEPTH HPERRREAD HPERRMSG PRINTFILEINFO Accessing Files Programmer's Guide (32650-90017) Accessing an RIO le FOPEN FDELETE FREAD FWRITE HPFOPEN Accessing Files Programmer's Guide (32650-90017) Table 3-2.
Table 3-3.
Table 3-4.
Table 3-6.
Table 3-8. Converting Data Types Function Intrinsic Manual Converting binary numbers ASCII DASCII Data Types Conversion Programmer's Guide (32650-90015) Converting numeric ASCII strings BINARY DBINARY Data Types Conversion Programmer's Guide (32650-90015) Translating ASCII/EBCDIC or JISCII/EBCDIK CTRANSLATE Data Types Conversion Programmer's Guide (32650-90015) Converting oating-point formats HPFPCONVERT Data Types Conversion Programmer's Guide (32650-90015) Table 3-9.
Table 3-10. Handling Traps Function Intrinsic ARITRAP FINTEXIT FINSTATE HPENABLTRAP RESETCONTROL XARITRAP XCONTRAP XLIBTRAP XSYSTRAP Manual Trap Handling Programmer's Guide (32650-90026) Table 3-11.
Table 3-13. Obtaining Device Information Function Intrinsic Obtaining volume information HPVOLINFO Accessing peripheral functionality HPDEVCONTROL Manual Table 3-14. Programming in Privileged mode Function Intrinsic Manual Starting privileged mode GETPRIVMODE Introduction to MPE XL for MPE V Programmers (30367-90005) Ending privileged mode GETUSERMODE Introduction to MPE XL for MPE V Programmers (30367-90005) Table 3-15.
Table 3-18. Using the Compiler Library Function Intrinsic Manual Compiler Library/XL Reference Manual (32650-90029) Table 3-19.
Table 3-20.
4 Command Definitions This chapter describes MPE/iX intrinsics, arranged alphabetically. Throughout this chapter, paragraphs beginning with the following acronyms should be interpreted as follows: (NM) For use in native mode programming only. (CM) For use in compatibility mode programming only. (KSAM) For use with KSAM les only. (ASC) For use with asynchronous serial communications only. (SPL) For use with SPL programming language only.
ABORTSESS NM and CM callable. Enables a program to abort a speci ed job or session from the system. Syntax I16V I32V I16A ABORTSESS(jsid,jsnum,jsstatus); Parameters jsid 16-bit signed integer by value (required) Indicates whether the jsnum parameter refers to a job number or a session number: Value 1 2 Meaning Session number Job number jsnum Because jobs and sessions can have identical numbers, the jsid parameter is required to indicate whether jsnum describes a job or a session.
ABORTSESS Operation Notes All resources held by the aborted job/session are released, and any I/O activity is terminated. Although the job/session is abnormally terminated, the operating system issues log records and updates CPU and connect times. The following message is displayed on the job/session list device: SESSION ABORTED BY SYSTEM MANAGEMENT ABORTSESS can be applied to waiting or scheduled jobs, or executing jobs or sessions.
ACTIVATE NM and CM callable. Activates a newly created process, or a process suspended with the SUSPEND intrinsic. Requires process handling (PH) capability. Syntax I16V U16V ACTIVATE(pin,allow); Parameters pin 16-bit signed integer by value (required) allow Indicates the parent or child process to be activated. To indicate a parent process, set pin to zero. To indicate a child process, set pin to the process identi cation number (PIN) of the process.
ACTIVATE Operation Notes A newly created process can only be activated by its parent. A suspended process can be reactivated by its parent, or any of its children, as speci ed in the allow parameter of the ACTIVATE and SUSPEND intrinsics. When a process is activated, it runs until it is either suspended or deleted. The ACTIVATE intrinsic aborts the calling process (and possibly the entire job/session) if a request to activate the parent results in the activation of the root CI or a system process.
ADJUSTUSLF NM and CM callable. Adjusts directory space in a USL le by moving the start of the information block forward (or backward) on a user subprogram library (USL) le, thereby increasing (or decreasing) the space available for the le directory block. The overall length of the le does not change. This intrinsic is intended for programmers writing compilers. Note A USL contains CM object code and is meaningful only in the CM program development process.
ADJUSTUSLF Parameters uslfnum 16-bit signed integer by value (required) increment Passes the le number of the USL le (returned by FOPEN/HPFOPEN). 16-bit signed integer by value (required) Returns the assigned record count: If a positive value, the information block is moved toward the end-of- le in the USL le, increasing the directory block and decreasing the information block.
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.
ALMANAC weekdaynum 16-bit signed integer by reference (optional) Returns the day of week. For example, 1=Sunday, 7=Saturday.
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 e cient use of memory. Data segment management (DS) capability is required. Data segment management (DS) intrinsics are not recommended for use in the operating system native mode programming environment; use of DS intrinsics degrade program performance.
ALTDSEG Operation Notes Incrementation and decrementation is accomplished in even multiples of four half words, which are rounded up. For example (in half words): Present Segment Size Change Value New Segment Size 128 128 128 128 128 -3 -4 +1 +3 +4 128 124 132 132 132 When a data segment is created through GETDSEG, the required virtual space is allocated by the system to accommodate the original length of the data segment. This virtual space is allocated in increments of 512 half words.
ARITRAP NM and CM callable (di erences noted below). Collectively enables all arithmetic traps (except the IEEE inexact result trap) or disables all arithmetic traps.
ARITRAP (NM) The possible interrupts listed below are collectively called the arithmetic traps: 3000 mode double-precision divide by zero 3000 mode double-precision over ow 3000 mode double-precision under ow 3000 mode oating-point divide by zero 3000 mode oating-point over ow 3000 mode oating-point under ow 3000 mode packed decimal error Decimal divide by zero Decimal over ow IEEE oating-point divide by zero IEEE oating-point under ow IEEE oating-point over ow IEEE oating-point, invalid operation Integer
ARITRAP Condition Codes CCE (2) CCG (0) CCL (1) Request granted. All arithmetic traps were originally disabled. Request granted. At least one arithmetic trap was originally enabled. Not returned.
ASCII ASCII NM and CM callable. Converts a 16-bit binary number to a speci ed base and represents it as a numeric ASCII string. Syntax I16 * I16V CA numchar:=ASCII(binvalue,base,asciieqv); Functional Return numchar 16-bit signed integer (assigned functional return) Returns the number of characters in the resulting ASCII equivalent.
ASCII For decimal conversions, binvalue is considered a 16-bit, twos complement integer ranging from -32768 to +32767. If binvalue=0, only one zero character is returned in asciieqv; numchar returns the total number of characters (including the sign). For example, if binvalue=0, the length returned is 1; and if binvalue=327, the length returned is 3.
BEGINLOG BEGINLOG NM and CM callable. Posts a special record to the user logging le to mark the beginning of a logical transaction. When BEGINLOG is called, the logging memory bu er is ushed to ensure that the record gets to the logging le. User logging (LG) or system supervisor (OP) capability is required. Syntax I32 U16A I16 I16 I16 BEGINLOG(index,data,length,mode,logstatus) Parameters index 32-bit signed integer by reference (required) data Passes access information to the user logging system.
BEGINLOG logstatus 16-bit signed integer by reference (required) Returns a value, indicating the success/failure of the intrinsic call: Value 0 1 2 4 5 9 12 14 15 Meaning Successful Nowait mode requested, and user logging process is busy Parameter out of bounds Incorrect index parameter passed Incorrect mode parameter passed Error occurred while writing System out of disk space, user logging cannot proceed Invalid access End-of- le Operation Notes Use the data parameter of this intrinsic to post user
BINARY BINARY NM and CM callable. Converts a numeric (octal or decimal) ASCII string to a 16-bit twos complement binary value. Syntax I16 CA I16V bineqv:=BINARY(asciieqv,length); Functional Return bineqv 16-bit signed integer (assigned functional return) Passes the twos complement binary equivalent of the numeric string. Parameters asciieqv character array (required) length Passes the octal or signed-decimal number (in ASCII characters) to be converted.
BINARY Related Information Intrinsics Commands Manuals 4-20 DBINARY None Data Types Conversion Programmer's Guide (32650-90015) Command Definitions
CALENDAR CALENDAR NM and CM callable. Returns the calendar date, including the day of year and the year of century.
CATCLOSE NM and CM callable. Closes an application message catalog that was opened with CATOPEN. Syntax I32V U16A CATCLOSE(catindex,catstatus) Parameters catindex 32-bit signed integer by value (required) catstatus Passes the catalog index returned by the CATOPEN intrinsic. 16-bit unsigned integer array (required) Returns two elements; the rst element is the error number, the second element is reserved and always returns 0.
CATOPEN CATOPEN NM and CM callable. Opens an application message catalog that was formatted with the GENCAT utility. CATOPEN returns a value that identi es the catalog and is used by CATREAD and CATCLOSE. Syntax I32 CA U16A catindex:=CATOPEN(formaldesig,catstatus); Functional Return catindex 32-bit signed integer (assigned functional return) An internal value recognized by the CATREAD and CATCLOSE intrinsics. Note The functional return is not a le number.
CATOPEN Operation Notes The CATOPEN intrinsic may alter the condition code (CCODE).
CATREAD 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. Syntax I16 I32V I16V U16A CA I16V msglength:=CATREAD(catindex,setnum,msgnum, I16V catstatus,bu er,bu ersize, CA CA CA CA CA parm1,parm2,parm3,parm4,parm5, I16V msgdest); Functional Return msglength 16-bit signed integer (assigned functional return) Returns the length of the message (in bytes).
CATREAD catstatus 16-bit unsigned integer array (required) Returns two elements; the rst element is the error number, the second element is reserved and always returns 0.
CATREAD msgdest 16-bit signed integer by value (optional) Passes the le number of the message's destination le (0 or -1 = $STDLIST, >2 = le number of the destination le). If bu er or msgdest are not speci ed, the message goes to $STDLIST ($STDLIST = 0). Operation Notes The combined total size of the bu er and parm1 through parm5 parameters cannot exceed 64,000 bytes.
CAUSEBREAK NM and CM callable. Interrupts the program (the entire process structure). The CAUSEBREAK intrinsic is the programmatic equivalent to pressing 4Break5 in a session, and is not applicable in jobs. The program is suspended while in break mode. Execution of the program can resume where the interruption occurred by entering the RESUME command, or be aborted by entering the ABORT command. Syntax CAUSEBREAK; Condition Codes CCE (2) CCG (0) CCL (1) Request granted. Not returned. Request denied.
CLEANUSL CLEANUSL NM and CM callable. Deletes all inactive entries from currently managed USL les and returns the le number of the new USL le. Therefore, you must test the condition code immediately upon return from the intrinsic. Unpredictable results occur if an error number is used as a le number. Note A USL contains CM object code and is meaningful in the CM program development process only.
CLEANUSL Condition Codes CCE (2) CCG (0) CCL (1) Request granted. The new le number is returned to lenum . Not returned. Request denied. An error number is returned to lenum .
CLOCK CLOCK NM and CM callable. Returns the time (hours, minutes, seconds, and tenths of seconds) according to the system timer.
CLOSELOG NM and CM callable. Closes access to the user logging facility. User logging (LG) or system supervisor (OP) capabilities are required. Syntax I32 I16 I16 CLOSELOG(index,mode,logstatus); Parameters index 32-bit signed integer by reference (required) mode Passes access capabilities to the user logging system. This is the value returned in the index parameter of the OPENLOG intrinsic.
CLOSELOG Operation Notes The number of users and log entries are independent of the number of times the OPENLOG/CLOSELOG intrinsics are called within an application. The user logging facility establishes a logging bu er (LOGBUFF) entry and increments the user count only at the rst OPENLOG call. Another counter keeps track of the number of times OPENLOG and CLOSELOG are called. The counter is incremented for every OPENLOG and decremented for every CLOSELOG.
COMMAND NM and CM callable. Programmatically executes a command. Syntax CA I16 I16 COMMAND(cmdimage,cmderror,parmnum); Parameters cmdimage cmderror character array (required) Passes an ASCII string of <=279 characters consisting of a command and parameters, terminated by a carriage return. The carriage return character (%15) must be the last character of the command string. Do not include a prompt character in this string.
COMMAND Note The cmderror is the correct parameter to check to verify if cmdimage succeeded. The parmnum may provide additional information. Operation Notes User-de ned commands (UDCs) cannot be executed with the COMMAND intrinsic. RUN and other process creation commands are allowed if you, or the program calling COMMAND, have process handling (PH) capability. Command les and the implied RUN are not allowed.
CREATE NM and CM callable (di erences noted below). Creates a process as a child of the calling process. Process handling (PH) capability is required. Syntax CA CA I16 I16V U16V CREATE(formaldesig,entryname,pin,parm,load ags, I16V I16V I16V U16V I16V stacksize,dlsize,maxdata,priorityclass,rank); Parameters formaldesig character array (required) entryname The name of the program to be created, speci ed either in MPE or HFS syntax.
CREATE load ags 16-bit unsigned integer by value (optional) Speci es the loading options as follows: Bits Value/Meaning 15:1 Active: 0 Calling process not activated when the new process terminates 1 The system reactivates the calling process (parent) when the new process terminates 14:1 Default: 0 Loadmap (equivalent to the LMAP parameter of the RUN command): 0 No map produced 1 A list of the allocated (loaded) program is produced on the job/session list device; displays information about all SOMs
CREATE Bits Value/Meaning 10:2 LIBSEARCH bits; speci es a failed load if the formaldesignator parameter contains a program name which cannot be expressed using the MPE syntax. This option is equivalent to the LIB= parameter of the RUN command: 00 (NM) If formaldesig was linked using the XL= parameter of the LINK command, then search the libraries specifying XL= rst. Otherwise, search only the system libraries. (CM) Search only the system libraries (SL.PUB.SYS).
CREATE Bits Value/Meaning 7:2 5:2 Reserved for operating system Stack dump; control the enabling/disabling mechanism where the stack is dumped in the event of an abort: 00 Stack dump mechanism enabled only at parent level 01 Stack dump mechanism enabled unconditionally 10 Stack dump mechanism enabled only at parent level 11 Stack dump mechanism disabled unconditionally for new process 4:1 3:1 0:3 stacksize Default: 00 Reserved for operating system DL to initial Q; ignored if formaldesig speci es a na
CREATE dlsize 16-bit signed integer by value (optional) (NM) Ignored if formaldesig speci es an NM program le (used for backward-compatibility with MPE V/E-based systems only). The NM stack is created using NM default values and the CM stack is created using MPE V/E maximum default values. (Equivalent to the DL= parameter of the RUN command.) maxdata (CM) Passes the number of words in the user stack area bounded by the DL and DB registers.
CREATE priorityclass 16-bit unsigned integer by value (optional) Returns the integer equivalent of two ASCII characters specifying the priority class where the new process is scheduled (AS, BS, CS, DS, ES). It is computed as: (ASCII of first character * 256) + (ASCII of second character) The integer equivalents are: AS BS CS DS ES = = = = = 16,723 16,979 17,235 17,491 17,747 If a user is nonprivileged, the processes can be rescheduled into any of the ve subqueues except the AS queue.
CREATE Operation Notes The CREATE intrinsic does the following: 1. Loads the program to be run by the new process into virtual memory. 2. Creates the process as the child of the calling process. 3. Initializes the process data areas. 4. Schedules the process. 5. Returns the new process identi cation number (PIN) to the requesting process.
CREATEPROCESS CREATEPROCESS NM and CM callable (di erences noted below). Creates a process and allows you to assign $STDIN and $STDLIST to any le. Process handling (PH) capability is required. Syntax I* I16 CA CREATEPROCESS(createstatus,pin,formaldesig, I*A I*A itemnums,items); Parameters createstatus (NM) 32-bit signed integer by reference (required) (CM) 16-bit signed integer by reference (required) Returns a value indicating the type of success or failure.
CREATEPROCESS Value 15 16 17 18 19 20 Meaning Process not created; reserved item was speci ed Process not created; hard load error occurred (for example, I/O error reading formaldesig ) Process not created; illegal value speci ed for itemnum =7 Process not created; speci ed $STDIN could not be opened Process not created; speci ed $STDLIST could not be opened Process not created; string to be passed to new process invalid (pointer without length, length without pointer, or length exceeds stack size of ca
CREATEPROCESS Table 4-1. CREATEPROCESS Itemnum/Item Values Itemnum Item Description 0 Indicates the end of the option list. No value is required in the corresponding item . 1 The address must be a byte address (type-coerced) containing the entry point name in the program where the new process is to begin execution (equivalent to the entrypoint parameter of the RUN command.) The name consists of a string of characters terminated by a blank.
CREATEPROCESS Table 4-1. CREATEPROCESS Itemnum/Item Values (continued) Itemnum Item Description 8 The address must be a byte address (type-coerced) containing a de nition of the le to be used as $STDIN for the new process (equivalent to the STDIN= parameter of the RUN command). Must contain an ASCII string (terminated by a carriage return) specifying the le to be used as $STDIN (that is, everything after the FILE formaldesig= ; portion of the le equation).
CREATEPROCESS Table 4-1. CREATEPROCESS Itemnum/Item Values (continued) Itemnum Item Description 24 (NM Only) The length of the string referenced by itemnum =19. 25 (NM Only) Reserved for operating system. 26 The address must be a byte address containing the maximum size (in bytes) that the NM stack can grow (equivalent to the NMSTACK= parameter of the RUN command).
CTRANSLATE NM and CM callable. Converts a string of characters between EBCDIC and ASCII, or between EBCDIK (HP-speci c version of EBCDIC) and KANA8 (8-bit, Japanese International Standard (JIS) version of USASCII code).
CTRANSLATE transtable character array (required when transcode=0, otherwise optional) Passes the user-de ned translation table. The contents and order of transtable de ne the translation process. Transtable must be <= 256 bytes. Transtable is constructed so that each byte corresponds to a byte value in the source string to be translated. For example, the rst byte in transtable gives the code to be substituted for source bytes whose value is 0. Condition Codes CCE (2) CCG (0) CCL (1) Request granted.
CTRANSLATE DASCII NM and CM callable. Converts a 32-bit binary number to a speci ed base and represents it as a numeric ASCII string. Syntax I16 I32V I16V CA numchar:=DASCII(binvalue,base,asciieqv); Functional Return numchar 16-bit signed integer (assigned functional return) Returns the number of characters in the resulting string. Parameters binvalue 32-bit signed integer by value (required) base Contains the binary number to be converted to an ASCII string.
DASCII returns the total number of characters (including the sign). For example, if binvalue=0, the length returned is 1. For hexadecimal conversions (base=16), 8 characters (including leading zeros) are returned. The digits can be 0..9 and A..F.Numchar returns the number of signi cant (right-justi ed) characters (excluding leading zeros). For example, if binvalue=32, numchar is 2 and asciieqv will be 00000020.
DATELINE NM and CM callable. Returns the current date and time, including the day of week, month, day, year, hours, and minutes.
DBINARY 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. Syntax I32 CA I16V dbineqv:=DBINARY(dasciieqv,length); Functional Return dbineqv 32-bit signed integer (assigned functional return) Returns the converted 32-bit binary value. Parameters dasciieqv character array (required) length Passes the octal or signed decimal number (in ASCII characters) to be converted.
DBINARY Related Information Intrinsics Commands Manuals 4-54 BINARY None Data Types Conversion Programmer's Guide (32650-90015) Command Definitions
DEBUG DEBUG NM and CM callable. Invokes the debug facility from an interactive program and allows object code to be analyzed. Note Consult the MPE/iX System Debug Reference Manual (32650-90013) before attempting to use the debug facility. Syntax DEBUG; Operation Notes The debug facility has its own set of commands and a symbolic window display feature. The intrinsic call acts as a hard-coded breakpoint. Execution of the calling program is halted and the debug facility prompt is displayed.
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. Syntax I16 I16V dldbsize:=DLSIZE(size); Functional Return dldbsize 16-bit signed integer (assigned functional return) Returns the granted number of half words for the DL-to-DB area. This value is negative, unless error condition CCL (1) is returned; a positive value is possible.
DLSIZE Condition Codes CCE (2) CCG (0) CCL (1) Request granted. The value returned is >= the value requested. Request denied. The requested size exceeded the maximum limit allowed. The maximum limit allowable is granted, and its size is returned. Request denied. An illegal size parameter was speci ed, the size requested is less than the initial DL size, or the size parameter was a positive integer. The original area size, assigned when the CM stack segment was created, is granted.
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.
DMOVIN Operation Notes When DMOVIN is called, a bounds check is initiated to ensure that the data is taken from within the data segment boundaries and moved to an available data area.
DMOVIN Related Information Intrinsics Commands Manuals 4-60 DMOVOUT, GETDSEG None Introduction to MPE XL for MPE V Programmers (30367-90005) Command Definitions
DMOVOUT DMOVOUT NM and CM callable. Copies data from the data area to an extra data segment. Data segment management (DS) capability is required. Note 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.
DMOVOUT Operation Notes When DMOVOUT is called, a bounds check is initiated to ensure that the data is taken from within an available data area and moved to an area within the extra data segment boundaries.
DMOVOUT Related Information Intrinsics Commands Manuals DMOVIN None Introduction to MPE XL for MPE V Programmers (30367-90005) Command Definitions 4-63
ENDLOG NM and CM callable. Posts a record to the logging le marking the end of a logical transaction. When the record is posted, ENDLOG ushes the user logging memory bu er to ensure that the record gets to the logging le. User logging (LG) or system supervisor (OP) capability is required. Syntax I32 U16A I16 I16 I16 ENDLOG(index,data,length,mode,logstatus); Parameters index 32-bit signed integer by reference (required) data Passes the access to the user logging system.
ENDLOG logstatus 16-bit signed integer by reference (required) Returns one of the following values, indicating the success/failure of the intrinsic call: Value 0 1 2 4 5 9 12 14 15 Meaning Successful Nowait mode requested, and the user logging process is busy Parameter out of bounds Incorrect index parameter passed Incorrect mode parameter passed Error occurred while writing System out of disk space; user logging cannot proceed Invalid access End-of- le encountered Operation Notes Use the data param
EXPANDUSLF NM and CM callable. Changes length of a USL le by creating a USL le with the increment length longer or shorter than the USL le speci ed by uslfnum. The old USL le is copied to the new le with the same le name; the old USL le is then deleted. A USL contains CM object code and is meaningful only in the CM program development process. Note Syntax I16 I16V I16V lenum:=EXPANDUSLF(uslfnum,increment); Functional Return lenum 16-bit signed integer (optional) Returns the new le number.
EXPANDUSLF Parameters uslfnum 16-bit signed integer by value (required) increment Passes the le number of the le. 16-bit signed integer by value (required) Passes the number of records the length of the USL le is to be changed: If a positive value, the new USL le is longer than the old USL. If a negative value, the new USL le is shorter than the old USL. Condition Codes CCE (2) CCG (0) CCL (1) Request granted. The new le number is returned. Not returned. Request denied.
FATHER NM and CM callable. Returns the process identi cation number (PIN) of the parent calling process. Process handling (PH) capability is required. Syntax I16 pin:=FATHER; Functional Return pin 16-bit signed integer (assigned functional return) Returns the process identi cation number (PIN) of the parent process. Condition Codes CCE (2) CCG (0) CCL (1) Request granted. The parent is a user process. Request granted. The parent is a job or session main process (logon CI). Request granted.
FCHECK FCHECK NM and CM callable. Returns speci c details about error conditions that occurred when a le system intrinsic returns a condition code indicating an I/O error. FCHECK applies to les on any device. Syntax I16V I16 I16 I32 I16 FCHECK( lenum,fserrorcode,translog,blocknum,numrecs); Parameters lenum 16-bit signed integer by value (optional) fserrorcode Passes the le number of the le for which error information is to be returned.
FCHECK Table 4-2.
FCHECK Table 4-2.
FCHECK Table 4-2.
FCHECK Table 4-2. File System Error Codes (continued) Error Code Description 88 Nonexistent spool le 89 Power failure 90 Exclusive violation; le being accessed 91 Exclusive violation; le accessed exclusively 92 Lockword violation 93 Security violation 94 User not creator 95 Read not completed; the terminal user pressed 4BREAK5 (The user must enter the RESUME command to continue. The le system sees the restart, the application does not.
FCHECK Table 4-2.
FCHECK Table 4-2.
FCHECK Table 4-2.
FCHECK Table 4-2.
FCHECK Related Information Intrinsics Commands Manuals 4-78 None None Accessing Files Programmer's Guide (32650-90017), Using KSAM XL (32650-90168), and MPE XL Asynchronous Serial Communications Programmer's Reference Manual (32022-90012) Command Definitions
FCLOSE FCLOSE NM and CM callable. Terminates access to a le on any device. Syntax FCLOSE( I16V I16V I16V lenum,disposition,securitycode); Parameters lenum disposition 16-bit signed integer by value (required) Passes the le number of the le to be closed. 16-bit signed integer by value (required) Passes the disposition of the le, signi cant only for les on disk and magnetic tape; ignored for spooled and hot printers. (ASC) This parameter is not meaningful for asynchronous devices.
FCLOSE Bits Value/Meaning 13:3 Domain disposition (Continued): 010 Close as a temporary job le (rewound). The le is retained in your temporary (job/session) le domain and can be requested by any process within your job/session. If the le is a disk le, the le name is checked. If a le of the same name already exists in the temporary le domain, an error code is returned and the le remains open. If a le resides on unlabeled magnetic tape, the tape is rewound.
FCLOSE Bits Value/Meaning 11:2 Disk space disposition (valid only for standard disk les with either xed-length, unde ned-length, or variable-length record formats): 00 Does not return any disk space allocated beyond the end-of- le marker. 01 Returns any disk space allocated beyond the end-of- le (EOF) marker to the system. The EOF becomes the le limit; records cannot be added to the le beyond the EOF. 10 0:11 Note Returns any disk space allocated beyond the end-of- le (EOF) marker to the system.
FCLOSE securitycode 16-bit signed integer by value (required) Returns the type of security initially applied to the le (signi cant for new permanent les only). The valid options are: Value 0 1 Meaning Unrestricted access; can be accessed by any user, unless prohibited Private le creator security; can be accessed only by the creator The securitycode parameter selects the security mask assigned to new permanent les whether or not the le is within an MPE group.
FCLOSE If one of the following device settings is altered programmatically, the device returns to the system default at FCLOSE: Disable read timeout (value set by FCONTROL itemnum =4). Disable subsystem break (enabled through FCONTROL itemnum =17). Enable printing a string of three exclamation points (!!!) when a line is deleted (disabled through FCONTROL itemnum =35). Disable transparent editing (enabled through FCONTROL itemnum =41).
FCONTROL NM and CM callable. Performs various control operations on a le or on the device where the le resides, including: Supplying a printer or terminal carriage control directive. Verifying I/O. Reading the hardware status word for the device where the le resides. Setting a terminal's timeout interval. Repositioning a le at its beginning. Writing an end-of- le marker. Skipping forward or backward to a tape mark.
FCONTROL Table 4-3. FCONTROL Itemnum/Item Values Itemnum Mnemonic 0 U16 Item Description General device control: The value speci ed is passed to the appropriate device driver. A value from the driver is returned in item. Not valid for spooled device les. 1 U16 Carriage control (CCTL): Passes a carriage control directive to the driver of the speci ed nonspooled device le, regardless of whether the le is opened CCTL or NOCCTL. For spooled devices, use FWRITE to pass carriage control directives.
FCONTROL Table 4-3. FCONTROL Itemnum/Item Values (continued) Itemnum Mnemonic 4 U16 Item Description Set read timeout interval: Passes the timeout interval, in seconds, to be applied to the next read from the speci ed le. The maximum value allowed is 65,535 seconds. If input is requested from a le but is not received in this interval, the FREAD request terminates with CCL (1). The interval is speci ed in seconds and returned no value.
FCONTROL Table 4-3. FCONTROL Itemnum/Item Values (continued) Itemnum Mnemonic 6 U16 Item Description Write end-of- le: Marks the end-of- le (EOF) on disk or magnetic tape and is e ective only for those devices: If used for a disk le it writes a logical end-of-data marker where the le was last accessed. The disk le label is updated and written to disk. If used for a le residing on unlabeled magnetic tape, a tape mark is written at that current position.
FCONTROL Table 4-3. FCONTROL Itemnum/Item Values (continued) Itemnum Mnemonic 10 U16 Item Description Change line speed of a device: Passes a value specifying a new line speed for both input and output. The value passed must be expressed in characters per second (1 character per second = 10-bits per second). The supported choices are: 30 120 240 960 1920 (300 bps) (1200 bps) (2400 bps) (9600 bps) (19200 bps) Any setting other than those listed returns CCL (1).
FCONTROL Table 4-3. FCONTROL Itemnum/Item Values (continued) Itemnum Mnemonic 11 U16 Item Description Change line speed of a device: Passes a value specifying a new line speed for both input and output. The value passed must be expressed in characters per second (1 character per second = 10-bits per second). The supported choices are: 30 120 240 960 1920 (300 bps) (1200 bps) (2400 bps) (9600 bps) (19200 bps) Any setting other than those listed returns CCL (1).
FCONTROL Table 4-3. FCONTROL Itemnum/Item Values (continued) Itemnum Mnemonic 12 U16 Item Description Enable echo facility: Returns a value indicating the previous echo status: 0 1 Echo ON Echo OFF When enabled, all characters transmitted to the DTC are echoed onto the terminal's screen (DTC echo). When the system is initialized, all characters are echoed except for XON, XOFF, NULL, DEL, and DC2. During binary reads, all characters are passed as data and echoed.
FCONTROL Table 4-3. FCONTROL Itemnum/Item Values (continued) Itemnum Mnemonic 14 U16 Item Description Disable system break function: Enter a value of 1 to disable the system break function. System break is enabled by default for any terminal on which a session is active. If a user presses 4BREAK5 or a process calls the CAUSEBREAK intrinsic, the system attempts to interrupt the processing and place the terminal at the command interpreter level.
FCONTROL Table 4-3. FCONTROL Itemnum/Item Values (continued) Itemnum Mnemonic 16 U16 Item Description Disable subsystem break function: Item has no meaning; enter a value of 0 to satisfy internal requirements. Subsystem break is initially disabled on all devices; it must be enabled before it can be used. It is available only for devices running sessions and has no e ect on programmatically controlled devices. Subsystem break is reset to disabled at FCLOSE.
FCONTROL Table 4-3. FCONTROL Itemnum/Item Values (continued) Itemnum Mnemonic 17 U16 Item Description Enable subsystem break function: Item has no meaning; enter a value of 0 to satisfy internal requirements. Subsystem break is initially disabled on all devices; it must be enabled before it can be used. It is available only for devices running sessions, and has no e ect on programmatically controlled devices. Subsystem break is reset to disabled at FCLOSE.
FCONTROL Table 4-3. FCONTROL Itemnum/Item Values (continued) Itemnum Mnemonic 18 U16 Item Description Disable tape option (Default) Item is ignored. 19 U16 Enable tape option: Item is ignored. 20 U16 Disable the terminal input timer: Reset in break mode; reset after FCLOSE. (Default) Item is ignored. 21 U16 Enable the terminal input timer: Reset in break mode; reset after FCLOSE. Item is ignored. 22 U16 Read the terminal input timer: Item returns the measured time duration of the last read.
FCONTROL Table 4-3. FCONTROL Itemnum/Item Values (continued) Itemnum Mnemonic 24 U16 Item Description Enable parity checking and generation Item has no meaning; enter a value of 0 to satisfy internal requirements. If a call is issued against a terminal connected through PAD, CCE (2) is returned, but the device control action does not take place. Parity can be used for terminals opened programmatically and for those in session mode. The default for these is to operate in 8-bit pass-through mode.
FCONTROL Table 4-3. FCONTROL Itemnum/Item Values (continued) Itemnum Mnemonic 25 U16 Item Description De ne additional end-of-record characters: Item passes the value of a character to be used as an additional end-of-record (AEOR) character. The octal or decimal code for the character must be in the right byte of the parameter; the left byte is ignored. If the NULL character (%0) is speci ed, default EOR conditions are restored.
FCONTROL Table 4-3. FCONTROL Itemnum/Item Values (continued) Itemnum Mnemonic 26 U16 Item Description Disable binary mode: Item has no meaning, enter a value of 0 to satisfy internal requirements. Ignored for terminals connected through PAD. Binary mode is disabled by default. 27 U16 Enable binary mode: Item has no meaning, enter a value of 0 to satisfy internal requirements.
FCONTROL Table 4-3. FCONTROL Itemnum/Item Values (continued) Itemnum Mnemonic 28 U16 Item Description Disable user block mode: Item has no meaning; enter a value of 0 to satisfy internal requirements. Ignored for terminals connected through PAD. User block mode is not supported with terminal type 18. Under system default conditions, block mode processing occurs through a method called Hewlett-Packard block mode.
FCONTROL Table 4-3. FCONTROL Itemnum/Item Values (continued) Itemnum Mnemonic 34 U16 Item Description Enable line deletion response: Item has no meaning; enter a value of 0 to satisfy internal requirements. In character mode, with standard editing, the computer will output !!!, carriage return, and line feed when the line deletion (cancel) character is entered. This is referred to as 4CTRL5X echo (the default line deletion character). Not reset in break mode; reset after FCLOSE.
FCONTROL Table 4-3. FCONTROL Itemnum/Item Values (continued) Itemnum Mnemonic 37 U16 Item Description Set terminal type and speed: Item passes a value specifying line speed and terminal type. Bits (0:11) specify the line speed; bits (11:5) specify the terminal type. Ensure that the speed associated with a device matches the physical speed setting of the device and modem (if part of the connection).
FCONTROL Table 4-3. FCONTROL Itemnum/Item Values (continued) Itemnum Mnemonic 40 U16 Item Description Obtain terminal output speed Item returns the current line speed associated with an asynchronous port in characters per second. Use this information to get the original setting before calling itemnum =11 or 37. Note: Do not confuse the current line speed returned with the default line speed speci ed during system con guration.
FCONTROL Table 4-3. FCONTROL Itemnum/Item Values (continued) Itemnum Mnemonic Item Description Transparent mode reads can be terminated in any of the following ways: 41 Cont'd The read encountered the EOR character de ned in item . This character functions like a 4RETURN5 character in normal reads and is stripped when found. No carriage return or line feed is sent to the terminal. The read encountered an AEOR character, de ned through a previous call to FCONTROL itemnum =25.
FCONTROL Table 4-3. FCONTROL Itemnum/Item Values (continued) Itemnum Mnemonic 46 U16 Item Description Enable/disable reading writer's ID: Applicable only if lenum speci es a message le. For interprocess communication, an item value of 1 enables reading the writer's ID. Each record read has a two-word header. The rst word indicates the type of record: 0 Data record 1 Open record 2 Close record The second word contains the writer's ID number. If the record is a data record, the data follows the header.
FCONTROL Table 4-3. FCONTROL Itemnum/Item Values (continued) Itemnum Mnemonic 51 Item Description Append mode: Enables or disables append mode based on the value of the item parameter. Append mode is enabled if item is one (1) and disabled if item is zero (0). Write operations append data at the end of a le while reads and seeks may occur anywhere within the le when POSIX append mode is enabled for that le.
FCONTROL Table 4-3. FCONTROL Itemnum/Item Values (continued) Itemnum Mnemonic 54 Item Description This item provides for compatibility with the ioct( ) function found in most UNIX implementations. This option is only valid for streams and network socket les and tape devices. Any attempt to use this option with other le types results in an FSERR 8 - ILLEGAL PARAMETER VALUE error.
FCONTROL Condition Codes CCE (2) CCG (0) CCL (1) Request granted. Not returned. Request denied. An error occurred.
FDELETE FDELETE NM and CM callable. Deactivates a speci ed logical record in an RIO le. Syntax FDELETE( I16V I32V lenum,lrecnum); Parameters lenum lrecnum 16-bit signed integer by value (required) Passes the le number of the le to be modi ed. 32-bit signed integer by value (optional) Passes the relative logical record to be deactivated. Operation Notes If a record is not speci ed or the lrecnum is negative, the next logical record becomes inactive.
FDEVICECONTROL NM and CM callable. Provides control operations to a printer, terminal, or a spooled device le 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 le.
FDEVICECONTROL controlcode 16-bit signed integer by value (required) Passes the item value to be returned. (Refer to Table 4-4.) (ASC) Passes the number of the operation to be performed.Controlcode 192 is used to apply control directives to a device le. parm1, parm2 fserrorcode Codes 0 through 64 call FCONTROL. Control passes to FCONTROL, and any errors returned will have originated with FCONTROL.
FDEVICECONTROL Table 4-4. FDEVICECONTROL Controlcode/Parm1,Parm2 Values Control- Mnemonic code 128 I16V Parm1,Parm2 Description Character set selection: parm1 (8:8) Primary character set identi cation parm2 (8:8) Secondary character set identi cation The Hewlett-Packard 268x page printer can contain up to 32 character sets, allowing the use of a variety of fonts, styles, print rotations, and languages.
FDEVICECONTROL Table 4-4. FDEVICECONTROL Controlcode/Parm1,Parm2 Values (continued) Control- Mnemonic code 130 I16V Parm1,Parm2 Description Relative pen displacement: parm1 A 16-bit signed integer containing the desired X-axis displacement, in dots, of the pen from its current position. parm2 A 16-bit signed integer containing the desired Y-axis displacement, in dots, of the pen from its current position. No pen movement results from requests to move the pen o the logical page.
FDEVICECONTROL Table 4-4. FDEVICECONTROL Controlcode/Parm1,Parm2 Values (continued) Control- Mnemonic code 133 I16V Parm1,Parm2 Description De ne physical page.
FDEVICECONTROL Table 4-4.
FDEVICECONTROL Table 4-4.
FDEVICECONTROL Table 4-4. FDEVICECONTROL Controlcode/Parm1,Parm2 Values (continued) Control- Mnemonic code 141 I16V Parm1,Parm2 Description Clear environment: When set to zero, the following bits are ignored. parm1 (0:1) 1 = Clear all character sets parm1 (1:1) 1 = Clear all forms parm1 (2:1) 1 = Clear all vertical format controls (VFCs) parm1 (3:1) 1 = Clear all pictures parm2 Not used The printer ushes all data currently in its bu ers and then performs the indicated clears, if any.
FDEVICECONTROL Table 4-4. FDEVICECONTROL Controlcode/Parm1,Parm2 Values (continued) Control- Mnemonic code 145 I16V Parm1,Parm2 Description End of job: parm1 parm2 146 148 I16V I16V Not used Not used Device extended capability mode: parm1 0 = Clear 1 = Set parm2 Not used Device Status: Enable, disable, or return various types of extended device status.
FDEVICECONTROL Table 4-4. FDEVICECONTROL Controlcode/Parm1,Parm2 Values (continued) Control- Mnemonic code 149 I16V Parm1,Parm2 Description Set data block number: To be used for printer error recovery. The data block number is used as the printing application/utility data index. The printing application can set data block numbers allowing it to return to that place in the data stream and retransmit data from that point forward.
FDEVICECONTROL Table 4-4. FDEVICECONTROL Controlcode/Parm1,Parm2 Values (continued) Control- Mnemonic code 192 U16V Parm1,Parm2 Description Perform control functions on terminal device les: parm1 Indicates the speci c control directive applied to the terminal device le being accessed. For printers, onlyparm1=1 is supported. Valid values are: 1 Specify terminal type or printer type le: Speci es a new terminal type or printer type le for use with a device.
FDEVICECONTROL Table 4-4. FDEVICECONTROL Controlcode/Parm1,Parm2 Values (continued) Control- Mnemonic code 192 Cont'd U16V Parm1,Parm2 Description parm1 5 Cont'd Set system break response on or o at a terminal: Enable or disable system response to the entry of a system 4BREAK5 at the terminal. Valid values are: 0 Disable break 1 Enable break 6 Set subsystem break response on or o at a terminal: Enable or disable system response to the entry of a subsystem break character at the terminal.
FDEVICECONTROL Table 4-4.
FDEVICECONTROL Table 4-4. FDEVICECONTROL Controlcode/Parm1,Parm2 Values (continued) Control- Mnemonic code 192 Cont'd U16V Parm1,Parm2 Description parm1 15 Cont'd Set transparent editing mode: Enables or disables transparent (unedited) mode. When enabled, allows most special characters to be read and treated as data and a small subset to retain their meaning: AEOR The AEOR character de ned through a previous call to FCONTROL itemnum =25.
FDEVICECONTROL Table 4-4. FDEVICECONTROL Controlcode/Parm1,Parm2 Values (continued) Control- Mnemonic code 192 Cont'd U16v Parm1,Parm2 Description parm1 26 Cont'd Device XON/XOFF: Enable or disable XON/XOFF ow control between the device and the DTC: 1 Enable device XON/XOFF 0 Disable device XON/XOFF When enabled, the DTC stops sending data to the device when XOFF is received and resume when XON is received. XON/XOFF characters are not sent to the host.
FDEVICECONTROL Table 4-4. FDEVICECONTROL Controlcode/Parm1,Parm2 Values (continued) Control- Mnemonic code 192 Cont'd U16V Parm1,Parm2 Description parm1 29 Cont'd Block mode alert character: Speci es the character used to signal Hewlett-Packard block mode transfers. The standard alert character is DC2. This call only de nes the alert character; it does not enable Hewlett-Packard block mode. If issued to a terminal connected through PAD, CCE (2) is returned, but the device control action does not occur.
FDEVICECONTROL Table 4-4. FDEVICECONTROL Controlcode/Parm1,Parm2 Values (continued) Control- Mnemonic code 192 Cont'd U16V Parm1,Parm2 Description parm1 41 Cont'd Subsystem break character: Speci es the character is to be used as the subsystem break character. This value is passed in the high order byte (value * 256) of bu er .
FDEVICECONTROL Table 4-4. FDEVICECONTROL Controlcode/Parm1,Parm2 Values (continued) Control- Mnemonic code 192 Cont'd U16V Parm1,Parm2 Description parm1 55 Cont'd Backspace response action: Selects the action the DTC takes when it receives a backspace character.
FDEVICECONTROL Table 4-4. FDEVICECONTROL Controlcode/Parm1,Parm2 Values (continued) Control- Mnemonic code 192 Cont'd U16V Parm1,Parm2 Description parm1 61 Cont'd Bypass typeahead bu er: Valid values are: 1 The next read is taken from the device, and any information currently in the typeahead bu er is bypassed. The data in the typeahead bu er is not ushed, and can be obtained by a subsequent read. The request is valid for the next read only. 0 Disable the request.
FDEVICECONTROL Table 4-4. FDEVICECONTROL Controlcode/Parm1,Parm2 Values (continued) Control- Mnemonic code 193 I16V Parm1,Parm2 Description Record processing information for NRJE spool les: parm1 Indicates the character code (for example, ASCII) of spool le data. Refer to SNA NRJE Network Remote Job Entry User/Programmer Reference Manual (30245-90001).
FDEVICECONTROL Table 4-5.
FDEVICECONTROL Table 4-5.
FERRMSG NM and CM callable. Returns a message corresponding to an FCHECK error number and enables error messages to be displayed from a program. Syntax I16 CA FERRMSG(fserrorcode,msgbu I16 er,msglength); Parameters fserrorcode 16-bit signed integer by reference (required) msgbu er Passes an error code returned by the FCHECK intrinsic indicating which message to return in msgbu er. character array (required) msglength Returns the error message identi ed with fserrorcode.
FFILEINFO FFILEINFO NM and CM callable. Returns information about a le. Syntax FFILEINFO( Note I16V I16V * lenum[,itemnum,item] [...]); Up to ve itemnum/item pairs can be speci ed. Parameters lenum 16-bit signed integer by value (required) itemnum Passes the le number of the le for which information is requested. 16-bit signed integer by value (optional) item Speci es which item value is to be returned. (Refer to Table 4-6.
FFILEINFO Table 4-6. FFILEINFO Itemnum/Item Values Item Description Itemnum Item Type 1 CA File designator (28 bytes): Returns the le designator of the le being referenced in the format: lename.groupname.accountname Must be >=28 bytes in length. Unused bytes are lled with right-justi ed blanks and a nameless le returns an empty string. The fully quali ed name of the le referenced by lenum is returned as the value of this itemnum .
FFILEINFO Table 4-6. FFILEINFO Itemnum/Item Values (continued) Item Description Itemnum Item Type 6 U16 Logical device number: Returns the logical device number of the device where the disk le label resides. If the le is a disk le, the LDEV is the location of the le label. (File data can reside on the same device as the le label.) If the le is spooled, the LDEV is a virtual device number that does not correspond to the system con guration I/O device list.
FFILEINFO Table 4-6. FFILEINFO Itemnum/Item Values (continued) Item Description Itemnum Item Type 14 I16 Block size: Returns the le block size: If the le is binary, the value is positive and the size is in half words. If the le is ASCII, the value is negative and the size is in bytes. For standard xed ASCII les with odd record sizes, the block size is computed as \(record size + 1)" X block factor. For even record sizes, it returns the block size from the gufd.
FFILEINFO Table 4-6. FFILEINFO Itemnum/Item Values (continued) Item Description Itemnum Item Type 19 I32 Label address: Returns a zero. For compatibility with MPE V/E-based systems only.
FFILEINFO Table 4-6. FFILEINFO Itemnum/Item Values (continued) Item Description Itemnum Item Type 41 I16 Device type 42 I16 Device subtype 43 CA Environment le name (>=36 bytes) 44 I16 Number of disk extents currently allocated to the le 45 CA File name from labeled tape header 1 record (>= 17 bytes) 46 I16 Tape density 47 I16 DRT number: Always returns an 8. 48 I16 Device unit number: Always returns a 0.
FFILEINFO Table 4-6.
FFILEINFO Table 4-6. FFILEINFO Itemnum/Item Values (continued) Item Description Itemnum Item Type 67 U32 (NM) Record size (indicates bytes) 68 U32 Block size (indicates bytes). Odd or even record sizes are returned as the block size from the gufd. 69 U32 Extent size (indicates bytes) 74 @64 Virtual address of le label: Applicable for standard disk les only. (Requesting itemnum s 64, 74, or 75 for any other le type (RIO, MSG, CIR) causes an error and returns CCL (1).
FFILEINFO Table 4-6. FFILEINFO Itemnum/Item Values (continued) Item Description Itemnum Item Type 80 CA HFS syntax lename. This itemnum returns a null-terminated POSIX-syntax system absolute pathname for the le or directory referenced by lenum . On input the rst four bytes of this bu er are interpreted as a 32-bit unsigned integer specifying the maximum bu er size in bytes. This maximum bu er size does not include the four bytes used to represent this size.
FFILEINFO Table 4-6. FFILEINFO Itemnum/Item Values (continued) Item Description Itemnum Item Type 85 CA File Owner The full le owner name. Unused characters are blank lled. A symbolic zero (ASCII 48 in decimal) is returned as the le owner for root directories, accounts, and MPE groups created prior to the POSIX release. 86 I32 File owner identi er The le owner identi er (UID). Zero is returned as the le owner ID for root directories, accounts, and MPE groups created prior to the POSIX release.
FFILEINFO Table 4-6. FFILEINFO Itemnum/Item Values (continued) Item Description Itemnum Item Type 88 I32 File group identi er The le group identi er (GID). Zero is returned as the le group ID for root directories whose GID's have not been assigned.
FFILEINFO Table 4-6.
FFILEINFO Table 4-6. FFILEINFO Itemnum/Item Values (continued) Item Description Itemnum Item Type 94 I32 MPE/iX device type: This item returns the following values for the following types of devices: 95 I32 0 Disk device 1 Tape device 2 Terminal device 3 Printer device 4 Remote device 5 Ports device 6 Reserved 7 Streams device 8 Sockets device Close-on-Exec This item returns a value indication whether or not this lenum is closed if one the POSIX.
FFILEINFO Table 4-6. FFILEINFO Itemnum/Item Values (continued) Item Description Itemnum Item Type 99 I32 Setuid Flag This item returns a value indicating whether or not this le has the setuid ag turned on. When the setuid ag is on for a program le, the program will execute under the user who owns the le rather than under the user who invoked the program. A value of 1 indicates that the setuid ag is on; a value of 0 indicates the ag is o .
FFILEINFO Table 4-6. FFILEINFO Itemnum/Item Values (continued) Item Description Itemnum Item Type 103 I32 MPE Tape labels ag This item returns a value indicating whether or not a tape was opened labeled or unlabeled. A value of 0 indicates an unlabeled tape; a value of 1 indicates a labeled tape. This item is identical to bit 6:1 of the foptions. 104 I32 File designator type This item returns the le designator type for this le. It is identical to bit 10:3 of the foptions.
FFILEINFO Table 4-7.
FFILEINFO Table 4-7.
FFILEINFO Table 4-7.
FFILEINFO Table 4-7.
FFILEINFO Figure 4-4. Aoption Bit Summary Condition Codes CCE (2) CCG (0) CCL (1) Request granted. Not returned. Request denied. Access or calling sequence error.
FFINDBYKEY FFINDBYKEY NM and CM callable. Positions the record pointer at the beginning of the rst record matching the key value comparison. Note For KSAM les only. Syntax I16V CA I16V I16V I16V FFINDBYKEY( lenum,value,location,length,relop); Parameters lenum 16-bit integer by value (required) value Identi es the le number of the le to be positioned. character array (required) location Contains a value that determines which record is read.
FFINDBYKEY relop 16-bit signed integer by value (required) Speci es the relational operator for the comparison of the key value of the le to the value speci ed in value. The record where the le is positioned has this relation to key value: Value 0 1 2 Meaning Equal Greater than Equal to or greater than When relop is set to 1 or 2, the search is for an approximate key. Operation Notes Split stack calls are permitted.
FFINDN FFINDN NM and CM callable. Positions the logical record pointer to the relative record number according to the key sequence. Note For KSAM les only. Syntax FFINDN( I16V DV I16V lenum,number,location); Parameters lenum 16-bit signed integer (required) number Passes the le number of the le to be positioned. double by value (required) location Speci es a record number relative to the rst logical record in the le.
FFINDN Condition Codes CCE (2) CCG (0) CCL (1) Request granted. Request denied. The requested position was beyond the logical end-of- le. Request denied. An error occurred.
FGETINFO FGETINFO NM and CM callable. Returns access and status information about a le. Note FGETINFO is provided for compatibility with MPE V/E-based systems only. It is recommended that FFILEINFO be used to access data.
FGETINFO foption 16-bit unsigned integer by reference (optional) Returns seven le access characteristics by setting bit groupings (refer to Figure 4-5) as follows: Bits 14:2 Value/Meaning Domain: The le domain searched to locate the le: 00 01 10 11 New le Old permanent le Old temporary le Old temporary or permanent le The record format extension bit is returned as the foption (1:1) bit.
FGETINFO Bits 8:2 Value/Meaning Record format foption : 00 01 10 11 Fixed-length records Variable-length records Unde ned-length records Spool le format records 7:1 (ASC) Not valid for asynchronous device les; however, \ xed-length" may have been set if le redirection was anticipated. Carriage control: 6:1 0 No carriage-control character expected 1 Carriage-control character expected MPE/iX tape label: 0 1 5:1 Nonlabeled tape Labeled tape (ASC) Not valid for asynchronous device les.
FGETINFO Bits Value/Meaning 2:3 File type: 000 001 010 011 100 101 110 aoption Standard le (STD) KSAM/3000 le Relative I/O le (RIO) KSAM XL le Circular le (CIR) NM spool le Message le (MSG) 1:1 (ASC) Set to 000 for asynchronous device les.
FGETINFO Bits Value/Meaning 7:1 Inhibit bu ering: Inhibits automatic bu ering by the operataing system and allows I/O to take place directly between the stack and the applicable hardware device: 0 1 5:2 Normal bu ering Inhibit bu ering (ASC) Not valid for asynchronous device les. Multiaccess mode: Provides the accessors with shared access to the le: 00 01 10 4:1 Nonmultiaccess Intrajob multiaccess Interjob multiaccess (ASC) Not valid for asynchronous device les.
FGETINFO Returns the type and subtype of the device being used for a KSAM, RIO, circular, or message le, or devices such as a tape drive, printer, or terminal where bits (0:8) indicate device subtype, and bits (8:8) indicate device type. For standard disk les, bits (8:8)=00000011 and bits (0:8)=00001000 (indicate a 7933/35 disk drive). ldevnum If the le is not spooled or is opened as a spool le through the logical device, the returned devtype is actual.
FGETINFO lelimit 32-bit signed integer by reference (optional) Returns a number representing the last logical record that could exist in the le (the physical limits of the le). If the le does not reside on disk, this value is zero. logcount (ASC) Not valid for asynchronous device les. 32-bit signed integer by reference (optional) physcount Returns the total number of logical records passed to and from the program during the current le access.
FGETINFO A symbolic zero (ASCII 48 in decimal) is returned as the le owner for root directories, accounts, and MPE groups created prior to the POSIX release. If the le is not located in the account in which the le owner is a member, a blank le owner name is returned. labaddr (ASC) Not valid for asynchronous device les. 32-bit signed integer by reference (optional) Returns a zero. Maintained for backward compatibility with MPE V/E-based systems. (ASC) Not valid for asynchronous device les. Figure 4-5.
FGETINFO Figure 4-6. Aoption Bit Summary Operation Notes Returns access and status information about a le located on any device. The le must be opened by the calling process at the time of the FGETINFO call. Condition Codes CCE (2) CCG (0) CCL (1) Request granted. Not returned. Request denied. An error occurred.
FGETKEYINFO NM and CM callable. Requests access and status information about a KSAM le. For KSAM les only. Note Syntax FGETKEYINFO( I16V BA BA lenum,param,control) Parameters lenum 16-bit signed integer by value (required) Passes the le number of the le about which information is requested. byte array (required) param Returns information describing the key information for a KSAM le. The length depends on the number of keys in the le. The le size is given as the number of sectors.
FGETKEYINFO Condition Codes CCE (2) CCG (0) CCL (1) Request granted. Not returned. Request denied. An error occurred; insu cient space was declared for param or control, an illegal le number was speci ed, or the DB register is not set to the user stack.
FINDJCW NM and CM callable. Searches the job control word table for a speci ed job control word (JCW) and returns its value. Syntax CA U16 I16 FINDJCW(jcwname,jcwvalue,jcwstatus); Parameters jcwname character array (required) jcwvalue Passes the name of the job control word (JCW) to be found. This name can contain up to 255 alphanumeric characters, starting with a letter and delimited by a nonalphanumeric character, such as a blank.
FINDJCW Operation Notes There are three types of JCWs in the system: User-de ned System-de ned System-reserved FINDJCW can return the value of any type of JCW.
FINTEXIT NM and CM callable. Causes the return from your interrupt procedure. Syntax U16V FINTEXIT(interruptstate); Parameters interruptstate 16-bit unsigned integer by value (optional) Passes the state in which software interrupts should be left. Bit (15:1) controls this as: Value 1 0 Meaning Enable software interrupts (Default) Disable software interrupts Operation Notes Software interrupts are set on return, according to interruptstate .
FINTSTATE FINTSTATE NM and CM callable. Enables/disables all software interrupts against the calling process. Syntax U16 U16V oldstate:=FINTSTATE(interruptstate); Functional Return oldstate 16-bit unsigned integer (assigned functional return) Returns the previous state (enabled or disabled) of the software interrupts.
FINTSTATE The rst parameter of the software interrupt procedure is the le number of the le that caused the interrupt. It is necessary to issue a call to the IODONTWAIT intrinsic against the le in order to complete the request. When reading, the bu er parameter is ignored in the FREAD call. The data is moved to the array speci ed by the bu er parameter of IODONTWAIT. An incomplete FREAD/FWRITE request can be aborted by issuing an FCONTROL call with an itemnum of 43 (abort nowait I/O).
FLABELINFO FLABELINFO NM and CM callable. Returns information from the le label of a disk le. Syntax CA I16V I16 FLABELINFO( formaldesig,mode,fserrorcode, I16A REC I16A itemnum,item,itemerror); Parameters formaldesig character array (required) Passes a formal le designator interpreted according to MPE-escaped semantics. The le name must be terminated by a nonalphanumeric character other than a period (.), a slash (/), a hyphen (-), and an underscore ( ).
FLABELINFO mode 16-bit signed integer by value (required) Passes an option specifying the valid backreferencing to le equations for the le. Bits Value/Meaning 0:11 Reserved for future use. 11:1 Symbolic Link Traversal 0 To traverse through symbolic links, if they exist. 1 Do not traversing through symbolic links, if they exist. 12:2 Caller Privilege Level fserrorcode Allows the caller to pretend to be less privileged. The privilege level is passed in this eld.
FLABELINFO itemnum 16-bit signed integer array (required) item To indicate the end of the list, place a zero in the element following the last itemnum. record (required) Speci es which item value is to be returned. (Refer to Table 4-8.) Returns the value of the item speci ed in the corresponding itemnum . (Refer to Table 4-8.) itemerror Itemnum/items are paired such that the n th eld of the item record corresponds to the n th element of the itemnum array.
FLABELINFO Table 4-8. FLABELINFO Itemnum/Item Values Itemnum Mnemonic 1 CA Item Description File name (8 bytes): The le name component for the le referenced in formaldesig is returned as the value. If the le name is not expressible using MPE-only semantics, a le system error code (391) is returned in the associated itemerror . 2 CA Group name (8 bytes): The group name component for the le referenced in formaldesig is returned as the value.
FLABELINFO Table 4-8. FLABELINFO Itemnum/Item Values (continued) Itemnum Mnemonic Item Description 9 I16 File code of disk le 10 U16 Number of user labels written: May not be up-to-date when the le is open. 11 U16 Number of user labels available: May not be up-to-date when the le is open. 12 I32 Total number of logical records possible in the le: Equivalent to the le limit measured in logical records. 13 U16 File options: The record format extension bit is returned as the foption (1:1) bit.
FLABELINFO Table 4-8. FLABELINFO Itemnum/Item Values (continued) Itemnum Mnemonic 19 U32 Item Description Number of logical records in le: Equivalent to EOF. May not be up-to-date when the le is open. 20 U32 File allocation time: The time when le was last restored (in CLOCK intrinsic format). Zero is returned as the le allocation time for root directories, MPE accounts, and MPE groups created prior to release 4.5.
FLABELINFO Table 4-8. FLABELINFO Itemnum/Item Values (continued) Itemnum Mnemonic 34 CA Item Description Volume restriction (34 bytes): The last two characters indicate the type of restriction, as follows: 0 1 2 35 CA File is placed on the speci ed volume at creation File can be placed on any volume containing the speci ed class at creation File can be placed on any volume within the speci ed volume set at creation (Default) Volume set names (32 bytes): No restrictions.
FLABELINFO Table 4-8.
FLABELINFO Table 4-8.
FLABELINFO Table 4-8. FLABELINFO Itemnum/Item Values (continued) Itemnum Mnemonic 50 I32 Item Description KSAM XL File Version: This item returns a value indicating the version number of a KSAM XL le. A value of 1 indicates an original type KSAM XL le. A value of 2 indicates the next generation KSAM XL le. A value of zero is returned if the le is not a KSAM XL le.
FLABELINFO Figure 4-7. Foption Bit Summary Condition Codes CCE (2) CCG (0) Request granted. Not returned. UnCCL (1)nRequest denied. An error occurred. Refer to the fserrorcode and itemerror parameters for more information.
FLOCK NM and CM callable. Dynamically locks a le. If dynamically locking more than one RIN, multiple RIN (MR) capability is required. Syntax FLOCK( I16V U16V lenum,lock ag); Parameters lenum lock ag 16-bit signed integer by value (required) Passes the le number of the le whose global resource identi cation number (RIN) is to be locked.
FLOCK The following condition codes are possible when lock ag bit (15:1)=0: CCE (2) Request granted. CCG (0) Request denied. The le was locked by another process. CCL (1) Request denied. This le was not opened with the dynamic locking aoption bit (10:1) speci ed in the FOPEN/HPFOPEN intrinsic, or there was an attempt to lock more than one RIN and the calling process does not have multiple RIN (MR) capability.
FLUSHLOG NM and CM callable. Flushes the contents of the user logging memory bu er to the user logging le. User logging (LG) or system supervisor (OP) capability is required. Syntax I32 I16 FLUSHLOG(index,logstatus); Parameters index 32-bit signed integer by reference (required) logstatus Passes the access to the user logging system. This is the value returned in the index parameter of the OPENLOG intrinsic.
FMTCALENDAR FMTCALENDAR NM and CM callable.
FMTCLOCK NM and CM callable.
FMTDATE FMTDATE NM and CM callable.
FMTDATE Operation Notes If invalid input values are supplied, the output values returned are unpredictable; an error status is not returned.
FOPEN FOPEN NM and CM callable. Establishes access to a le and de nes the physical characteristics of the le prior to access. Syntax I16 CA U16V U16V I16V CA lenum:=FOPEN(formaldesig,foption,aoption,recsize,device, CA I16V I16V I32V I16V I16V I16V formmsg,userlabels,blockfactor,numbu er I16V lesize,numextent,initialloc, lecode); Functional Return lenum 16-bit signed integer (assigned functional return) Returns a unique le number identifying the opened le.
FOPEN If formaldesig is the name of a user-de ned le, it can begin with an asterisk (*). If formaldesig is the name of a system-de ned le, it can begin with a dollar sign ($). When creating a KSAM le, formaldesig must be a unique le name, that is, one not currently existing in the permanent le directory. The formal le designator can contain command interpreter variables and expressions that are evaluated before formaldesig is parsed and validated.
FOPEN Bits Value/Meaning 13:1 ASCII/binary Indicates which code, ASCII or binary, a new le is in when written to a device that supports both codes. For disk les, this also a ects padding (zeros for a binary le, blank characters for an ASCII le) that can occur when you issue a direct-write intrinsic call (FWRITEDIR) to a record that lies beyond the current logical end-of- le indicator. By default, magnetic tape and les are treated as ASCII les. This option is applicable only at le creation.
FOPEN Bits Value/Meaning The designator option is not equated with the formaldesig parameter if both of the following conditions are true: The disallow le equation option foption bit (5:1) allows le equations for this le opening. An explicit or implicit FILE command equating the formal le designator to a di erent actual le designator occurs in the job/session. 8:2 A leading * in a formal le designator passed by the formaldesig parameter overrides the disallow le equation option setting.
FOPEN Bits Value/Meaning 10 Unde ned-length records. The le contains records of varying length that were not written as variable-length les. By default, all les not on disk or magnetic tape are treated as containing unde ned-length records. The le system makes no assumption about the amount of data that is useful. You must determine how much data is required. For unde ned-length records, only the data supplied is written, with no information about its length.
FOPEN Bits Value/Meaning If a carriage-control character is sent to a le where the control cannot be executed directly (for example, line-spacing characters sent to a disk or tape le), the control character is embedded as the rst byte of the record. If a carriage-control character is sent to other types of les, the control is transmitted to the driver. Control codes %400 through %403 are remapped to %100 through %103, so that they t into one byte and thus can be embedded.
FOPEN Bits Value/Meaning 5:1 Disallow le equation option Indicates whether or not to allow le equations. A leading * in a formal le designator can override the setting to disallow FILE. The following bit settings are valid: 2:3 0 Allow FILE equations to override programmatic or system-de ned le speci cations. 1 Disallow FILE equations from overriding programmatic or system-de ned le speci cations. Default: 0 File type option Indicates internal record structure used to access records in a le.
FOPEN Bits Value/Meaning 1:1 cont'd Record format extension Files created using byte stream record format are assigned le attributes which override values speci ed by FOPEN parameters.
FOPEN Bits Value/Meaning 0011 Allows append access only if the le's security provisions allow either append or write access. FREAD, FREADDIR, FREADSEEK, FUPDATE, FSPACE, FPOINT, and FWRITEDIR intrinsic calls cannot reference this le. Data written by the FWRITE intrinsic is appended to the EOF, thereby extending the EOF. When a le is opened for append access, it is impossible to overwrite data in the le. For disk les, the EOF is updated after each FWRITE call. Therefore, data cannot be overwritten.
FOPEN Bits Value/Meaning 11:1 Multirecord Indicates whether or not individual read or write requests are con ned to record boundaries.
FOPEN Bits Value/Meaning 10:1 Dynamic locking Enables/disables le locking for the le. When this option is speci ed, the FLOCK and FUNLOCK intrinsics can be used to dynamically permit or restrict concurrent access to a disk le by other processes at speci ed times. The following bit settings are valid: 0 Disallow dynamic locking/unlocking 1 Allow dynamic locking/unlocking Default: 0 The process can continue this temporary locking/unlocking until it closes the le.
FOPEN Bits Value/Meaning 8:2 Exclusive option Indicates continuous exclusive access to this le, from open to close. Use this option when performing a critical operation (for example, updating the le). The following bit settings are valid: 00 If access type option (aoption bits (12:4)) speci es read only access, then read-share access takes e ect. Otherwise, exclusive access takes e ect. Regardless of which access option was selected, FFILEINFO reports zero. 01 Exclusive access.
FOPEN Bits Value/Meaning 10 Read-share access (semi-exclusive access). After the le is opened, concurrent write access to this le through another HPFOPEN/FOPEN request is prohibited, whether issued by this process or another process, until this process issues the FCLOSE request or terminates. A subsequent request for the read/write or update access type option (aoption bits (12:4)) obtains read access. However, other types of read access are allowed.
FOPEN Bits Value/Meaning 7:1 Inhibit bu ering option Enables/disables automatic bu ering by the operating system. If NOBUF is speci ed, I/O is allowed directly between the data area and the applicable hardware device. The following bit settings are valid: 0 Allow normal bu ering (BUF) 1 Inhibit bu ering (NOBUF) Default: 0 NOBUF access is for physical block transfer; not logical record transfer.
FOPEN Bits Value/Meaning The end-of- le (EOF) marker, next record pointer, and record transfer count are maintained in terms of logical records for all les. The number of logical records a ected by each transfer is determined by the size of the transfer. Transfers always begin on a block boundary. Those transfers that do not transfer whole blocks leave the next record pointer set to the rst record in the next block. The EOF marker always points at the last record in the le.
FOPEN Bits Value/Meaning 5:2 Multiaccess mode option Indicates how the le's record pointer is to be shared. This option is useful for sharing standard input devices where there is some natural sequence of access to the le. This option permits processes located in di erent jobs or sessions to open the same le and share that le's record pointer. The following bit settings are valid: 00 No MULTI access. A unique record pointer is created for this access to the le.
FOPEN Bits Value/Meaning 3:1 Copy mode option Determines whether a le should be treated as a standard sequential le (copy by logical record) or physical block (copy to another le). Copy must be set to obtain EXCLUSIVE access. This causes the multiaccess bits to be set to 00. The following values are valid: 0 The le is accessed as its own le type. 1 The le is treated as a standard (STD) le, with variable-length records.
FOPEN recsize 16-bit signed integer by value (optional) Passes the size, in half words or bytes, of the logical records in the le. If recsize =0, the system uses the default record size, 256 bytes. Positive values are half words; negative values are bytes. The valid range is dependent on storage and record formats: For xed-length and unde ned-length ASCII les, the valid range is 1..32,767 bytes. For variable-length ASCII les and xed-length, variable-length, and unde ned-length binary les, the range is 1.
FOPEN node # remote environment option Passes a remote node name to be accessed through remote le access (RFA). The node name string must be followed by a pound character (#) to delimit the string. The internal format of the name must match that de ned by the NS 3000/XL subsystem. Refer to the NS 3000/XL User/Programmer Reference Manual (36920-90001).
FOPEN devname devclass device name option Passes the logical device number, in ASCII format, of a speci c device. The le is assumed to be permanent. If the logical device number of a nonshareable device is speci ed, the nonshareable device must be ready prior to the FOPEN call.
FOPEN tape density option density Passes the tape density to be used while writing to a tape le. This option is applicable only when writing to a tape on a drive that supports more than one density. When reading from a tape, the density of the tape overrides the density value speci ed. To specify density when writing to the tape le, use the keyword ;DEN=.
FOPEN ;VTERM reverse VT option Indicates that the speci ed device name is allocated on a remote machine. Specify the remote location of a device with the device parameter as VTERM. Specify the remote environment in the same open request, using either the formaldesig parameter or the remote environment option (see node# above) of the device parameter. Reverse VT is almost the same as a terminal opened up through remote le access, except that no session is required on the remote machine.
FOPEN seq Use one of the following methods to specify the position of the le in relation to other les on the tape: A zero, which causes a search of all volumes until the le is found. An unsigned integer (1-9999), which speci es the position of the le relative to the current le on the tape. ADDF which causes the tape to be positioned to add a new le on the end of the volume (or last volume in a multivolume set). NEXT which positions the tape at the next le on the tape.
FOPEN userla- 16-bit signed integer by value (optional) bels Passes the number, in the range 0..254, of user-label records to be created for the le. Applicable to new disk les only. Default: 0 (ASC) Not valid for asynchronous device les. block- 16-bit signed integer by value (optional) factor Passes the number of logical records in one physical record (block). This value is used to calculate the physical record size for disk and magnetic tape les. The valid range for this option is 1..255.
FOPEN numbu er 16-bit signed integer by value (optional) Passes the number of bu ers, number of copies, and output priority indicated by setting the following bits: Bits 11:5 Value/Meaning Numbu ers Indicates the number of bu ers to allocate to the le. The valid range is dependent on le type: For standard les, the valid range is 1..31. For circular and RIO les, the valid range is 1..16. For message les, the valid range is 2..
FOPEN Bits Value/Meaning 0:4 Output priority Indicate the output priority to be attached to the le for spooled output. Applicable only to spooled devices. The valid range for this option is the binary equivalent of 1..13. The output priority must be a number between 1 (lowest priority) and 13 (highest priority), inclusive.
FOPEN numextent 16-bit signed integer by value (optional) Passes a value in the range 1..32 that determines the number of extents for the le. If a value of 1 and an initialloc value of 1 is speci ed, the le is created as one contiguous extent of disk space. If a value >1 is speci ed, a variable number of extents (with varying extent sizes) is allocated on a need basis. Applicable only at le creation. Default: initialloc >8 extents (ASC) Not valid for asynchronous device les.
FOPEN Table 4-9.
FOPEN Table 4-9. FOPEN/HPFOPEN Parameter Equivalents (continued) FOPEN Parameter numbu ers: Bits (11:5) Numbu ers Bits (4:7) Spooler copies Bits (0:4) Output priority lesize HPFOPEN Itemnum,Item 44, numbu ers 34, spooler copies 27, output priority 35, lesize numextent 47, numextent initialloc 36, initial allocation lecode 37, lecode Operation Notes A le can be referenced by its formal le designator. When executed, a unique le number is returned to the process.
FPARSE NM and CM callable. Parses and validates le designators. Only MPE syntax names can be parsed. Escaped or POSIX syntax names will return errors. Syntax CA I16A U16A I32A FPARSE(formaldesig,result,item,vector); Parameters formaldesig character array (required) Passes the le reference string to be parsed. Terminate the string with any nonalphanumeric character except a slash (/), period (.), or colon (:).
FPARSE Value -1 -2 -3 -4 -5 -6 -7 -8 -9 -101 -102 -103 -104 -105 -106 -107 -108 -109 -110 -111 -112 -113 -114 -115 Note Meaning Invalid item values Parameter bounds violation Illegal delimiter; misuse of .
FPARSE Value 0 1 2 3 4 5 vector Meaning End of item list File name Lockword Group name Account name NS 3000/XL envidname 32-bit signed integer array (optional) Returns vectors, one per element, for the requested item . A vector cannot be passed without a corresponding item value. Note Information is returned as follows: Bits Value/Meaning 16:16 Return the length of the string speci ed by the corresponding items parameter.
FPOINT FPOINT NM and CM callable. Sets the logical record pointer for a disk le containing xed-length or unde ned-length records to any logical record. When the next FREAD or FWRITE le 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 le).
FPOINT Condition Codes CCE (2) CCG (0) CCL (1) Request granted. Request denied. The logical record pointer position is unchanged. Positioning was requested at a point beyond the le limit. Request denied.
FREAD FREAD NM and CM callable. Reads a logical record or portion of a record from a le to the stack. Syntax I16 transfercount:=FREAD( I16V UDS I16V lenum,bu er,length); Functional Return transfercount 16-bit signed integer (assigned functional return) Note If the le was opened with the nowait I/O option enabled, transfercount is zero. The IOWAIT intrinsic can be used to determine the length of the data transferred.
FREAD length 16-bit signed integer by value (required) Passes the length of the data to be transferred to bu Value <0 =0 >0 er: Meaning Length in bytes No transfer occurs Length in half words If length is larger than the size of the logical record, and the multirecord aoption in FOPEN/HPFOPEN was not speci ed, transfer is limited to the length of the logical record.
FREAD When reading from an empty message le and another process has opened that le for write access, the process waits. If the message le is empty and there are no writers, the process waits if there is an FCONTROL=45 in e ect or if this is the rst FREAD after the reader's FOPEN/HPFOPEN. Otherwise, CCG (0) is returned. If an FREAD is issued against a message le and an FCONTROL=46 is in e ect, the writer's ID and the record type code are appended to the beginning of the record.
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 les only. Can recover tape errors when handling I/O management and data recovery routines. Syntax I16 transfercount:=FREADBACKWARD( I16V UDS I16V lenum,bu er,length); Functional Return transfercount 16-bit signed integer Note If the le is opened with the nowait I/O option enabled, transfercount is zero.
FREADBACKWARD length 16-bit signed integer by value (required) Returns the length of the data to be transferred to bu Value <0 =0 >0 er: Meaning Length in bytes No transfer occurs Length in half words If length is larger than the size of the logical record, and the multirecord aoption in FOPEN/HPFOPEN was not speci ed, transfer is limited to the length of the logical record.
FREADBYKEY NM and CM callable. Reads a logical record randomly from a KSAM le to the data stack. For KSAM les only. Note Syntax I16V length:=FREADBYKEY( I16V LA I16V CA lenum,target,tcount,keyvalue,); I16V keylocation); Functional Return length 16-bit signed integer by value (assigned functional return) Returns the length of the information transferred. If tcount is positive, length is a word count; if negative it is a byte count.
FREADBYKEY keyvalue character array (required) keylocation Passes the value determining the record to be read. The rst record found with an identical value in the key speci ed by keylocation is the record read. 16-bit signed integer by value (required) Passes the relative byte location in the record of the key whose value determines which record is to be read. The rst byte is numbered as 1. If a value of zero is speci ed, the primary key is used.
FREADC NM and CM callable. FREADC returns records in physical sequence, not chronological sequence. For KSAM/XL les with the REUSE option, physical is not equal to chronological sequence and FREADC reads the le in physical sequence. Deleted records are not returned using the FREADC intrinsic, the FREADDIR intrinsic must be used if deleted records are required. For KSAM les only.
FREADC Condition Codes CCE (2) CCG (0) CCL (1) Request granted. Request denied. The logical end-of-data or beginning-of-data was encountered during the read. Request denied. An error occurred.
FREADDIR NM and CM callable. Reads a speci c logical record or portion of a record from a direct-access disk le to the data stack. Syntax FREADDIR( I16V UDS I16V I32V lenum,bu er,length,lrecnum); Parameters lenum 16-bit signed integer by value (required) bu er Passes the le number of the le to be read. user-de ned structure (required) length Returns the record that was read. This structure should be large enough to hold all of the information to be transferred.
FREADDIR Operation Notes This intrinsic is di erent than the FREAD intrinsic. The FREAD intrinsic reads only the record already pointed to by the logical record pointer. Issue the FREADDIR intrinsic only for disk les composed of xed-length or unde ned-length records. If RIO access is used, FREADDIR inputs the speci ed logical record. If the record is inactive, the contents of the inactive record are transmitted and CCE (2) is returned; there is no indication of the block containing some inactive records.
FREADLABEL NM and CM callable. Reads a user-de ned label from a disk or magnetic tape le. Syntax FREADLABEL( I16V UDS I16V I16V lenum,bu er,length,labelid); Parameters lenum 16-bit signed integer by value (required) bu er Passes the le number of the le whose label is to be read. user-de ned structure (required) length Returns the label that was read. This structure must be large enough to hold the number of half words speci ed by length .
FREADLABEL Condition Codes CCE (2) CCG (0) CCL (1) Request granted. The label was read. Request denied. A label was referenced beyond the label written on the le. Request denied. The label was not read; an error occurred.
FREADSEEK NM and CM callable. Moves a record from a disk le to a bu er in anticipation of a FREADDIR intrinsic call. Syntax FREADSEEK( I16V I32V lenum,lrecnum); Parameters lenum lrecnum 16-bit signed integer by value (required) Passes the le number of the le to be read. 32-bit signed integer by value (required) Passes the relative number of the logical record to be read. A value of zero indicates the rst logical record. Operation Notes The FREADSEEK intrinsic enhances direct access of disk les.
FREADSEEK Related Information Intrinsics Commands Manuals None None Accessing Files Programmer's Guide (32650-90017) Command Definitions 4-237
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 native mode programming environment. Use of DS intrinsics in NM will degrade your program's performance.
FREEDSEG Condition Codes CCE (2) CCG (0) CCL (1) Request granted. The data segment is deleted from the job/session. Request granted. The data segment is deleted from the calling process but continues to exist in the job/session; it is being shared by another process. Request denied. Either the index is invalid, or index and id do not specify the same shared data segment.
FREELOCRIN NM and CM callable. Frees all local resource identi cation numbers (RINs) from allocation to a job/session. Syntax FREELOCRIN; Operation Notes The FREELOCRIN intrinsic must be called before a second call to GETLOCRIN. Condition Codes CCE (2) CCG (0) CCL (1) Request granted. Request denied. No RINs are currently reserved for the job. Request denied. A minimum of one RIN is currently locked by a process.
FRELATE FRELATE NM and CM callable. Determines whether a le pair (on any device) is interactive, duplicative, or both interactive and duplicative. Syntax U16 intordup:=FRELATE(in I16V I16V lenum,list lenum); Functional Return intordup 16-bit unsigned integer (assigned functional return) Returns values indicating whether the two les referenced are interactive and/or duplicative: Bits Value/Meaning 15:1 0 Files speci ed by in lenum and list lenum do not form an interactive pair.
FRELATE Operation Notes A device le is interactive if it requires human intervention for all input operations; this is necessary to establish the person/machine dialog required to support a session. A device le is duplicative if all input operations are echoed to a corresponding display without intervention by the operating system software. The interactive/duplicative attributes of a le pair do not change between the time the les are opened and closed. (KSAM) This intrinsic cannot be used for KSAM les.
FREMOVE FREMOVE NM and CM callable. Marks the current record in a KSAM le for deletion. Note For KSAM les only. Syntax FREMOVE( I16V lenum) Parameters lenum 16-bit signed integer by value (required) Passes the le number of the le where the record is to be deleted. Operation Notes Split stack calls are permitted. Deleted records can be read with this intrinsic. (KSAM/3000) When executed, the rst word of the current record is set to 1's; the record is not physically deleted from the le.
FRENAME NM and CM callable. Renames an open disk le (and its lockword, if applicable). The le being renamed must be either: A new le. An old le (permanent or temporary), opened for exclusive access with the exclusive option of the HPFOPEN/FOPEN intrinsics, and with security provisions allowing write access. Syntax FRENAME( I16V CA lenum,formaldesig); Parameters lenum formaldesig 16-bit signed integer by value (required) Passes the le number of the le to be renamed.
FRENAME If formaldesig is the name of a user-de ned le, it can begin with an asterisk (*). If formaldesig is the name of a system-de ned le, it can begin with a dollar sign ($). When creating a KSAM le, formaldesig must be a unique le name, that is, one not currently existing in the permanent le directory. The formal le designator can contain command interpreter variables and expressions that are evaluated before formaldesig is parsed and validated.
FRENAME Condition Codes CCE (2) CCG (0) CCL (1) Request granted. Not returned. Request denied. An error occurred.
FSETMODE FSETMODE NM and CM callable. Controls the following access modes of les 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.
FSETMODE Bits Value/Meaning 14:1 Controls blocking of program execution until completion of physical write operations. This mode controls writes to lenum only from the calling process. 0 Return control to the program from a write request without waiting for completion of the physical write operation 1 Force the program to wait until the physical write operation is completed (the record is posted) (ASC) Not used for asynchronous serial devices. (KSAM) Bit (14:1) only is returned.
FSETMODE Bits Value/Meaning 12:1 Reporting tape device automatic error recovery. 0 Do not report automatic error recovery on a tape device. 1 Report tape device automatic error recovery by returning CCL (1) to FREAD and FWRITE. (ASC) Not used for asynchronous serial devices. 0:12 (KSAM) Set this bit to zero.
FSPACE NM and CM callable. Moves a record pointer forward or backward on a magnetic tape or disk le, spaces physical records on magnetic tape les and logical records on disk les. Syntax FSPACE( I16V I16V lenum,displacement); Parameters lenum displacement 16-bit signed integer by value (required) Passes the le number of the le on which spacing is to be done.
FSPACE Condition Codes CCE (2) CCG (0) CCL (1) Request granted. Request denied. An end-of- le indicator was encountered during spacing. For disk les, this is the le limit, and the logical record pointer is not changed. For magnetic tape les, this is the end-of- le mark, and the logical record pointer points to the (logical) end-of- le. The magnetic tape is positioned to one record past the le mark on the tape. For labeled tape, the logical record pointer is at the le mark. Request denied.
FUNLOCK NM and CM callable. Dynamically unlocks a le's global resource identi cation number (RIN) that was locked with the FLOCK intrinsic. Syntax FUNLOCK( I16V lenum); Parameters lenum 16-bit signed integer by value (required) Passes the le number of the le whose global RIN is to be unlocked. Condition Codes CCE (2) CCG (0) CCL (1) Request granted. Request denied. The calling process did not lock the le. Request denied.
FUPDATE FUPDATE NM and CM callable. Updates (writes) a logical record in a disk le. Syntax FUPDATE( I16V UDS I16V lenum,bu er,length); Parameters lenum 16-bit signed integer by value (required) bu er Passes the le number of the le to be updated. user-de ned structure (required) length Passes the record to be written in the update. 16-bit signed integer by value (required) Passes the number of half words or bytes to be written to the le.
FUPDATE Operation Notes This intrinsic a ects the logical record (or block for NOBUF les) of the le last referenced by any intrinsic call, except an FPOINT call, which a ects the record prior to the last record referenced. FUPDATE moves the speci ed information from the stack into this record. The le containing this record must be opened with the update aoption speci ed in the FOPEN/HPFOPEN call and the le cannot have variable-length records.
FWRITE FWRITE NM and CM callable. Writes a logical or physical record or portion of a record from the stack to a le on any device. Syntax FWRITE( I16V UDS I16V U16V lenum,bu er,length,controlcode); Parameters lenum 16-bit signed integer by value (required) bu er Passes the le number of the le to be written on. user-de ned structure (required) length Passes the record to be written. 16-bit signed integer by value (required) Passes the number of half words or bytes to be written to the record.
FWRITE controlcode 16-bit unsigned integer by value (required) Passes a carriage-control code, e ective if the le is transferred to a line printer or terminal (including a spooled le whose destination is a line printer or a terminal). This parameter is e ective only for les opened with carriage-control speci ed. The options are: Value 0 1 Meaning Print the full record transferred, using single spacing. This results in a maximum of 132 characters per printed line.
FWRITE When a le is opened with CCTL, use the carriage-control codes in one of the following ways: As the value of the controlcode parameter. When controlcode =1, as the rst byte of the bu er array. The default carriage-control code is postspacing with automatic page eject. This applies to all Hewlett-Packard subsystems except FORTRAN 77/XL and COBOLII/XL (these have prespacing with automatic page eject). Note Channel assignments shown in Table 4-10 are the Hewlett-Packard standard defaults.
FWRITE Table 4-10.
FWRITE Table 4-10.
FWRITE Figure 4-9.
FWRITE Operation Notes If information is written to a xed-length record and the NOBUF aoption in FOPEN/HPFOPEN is not speci ed, any unused portion of the record is padded with binary zeros or ASCII blanks. When the FWRITE intrinsic is executed, the logical record pointer is set to the record immediately following the record just written, or to the rst logical record in the next block for NOBUF les. If RIO access is used, the modi ed record is set to the ACTIVE state.
FWRITE Condition Codes CCE (2) CCG (0) CCL (1) Request granted. Request denied. The physical bounds of the le prevented further writing. Request denied. An error occurred; length exceeded the size of the record in nonmultirecord mode, the FSETMODE option was enabled to signify recovered tape errors, or the end-of-tape marker was sensed. If the le is being written to a multivolume labeled magnetic tape set, CCL (1) is not returned when the end-of-tape marker is sensed.
FWRITEDIR FWRITEDIR NM and CM callable. Writes a speci c logical record from the stack to a disk le. Syntax FWRITEDIR( I16V UDS I16V I32V lenum,bu er,length,lrecnum); Parameters lenum 16-bit signed integer by value (required) bu er Passes the le number of the le to be written to. user-de ned structure (required) length Passes the record to be written. This structure should be large enough to hold all of the information to be transferred.
FWRITEDIR Operation Notes This intrinsic di ers from the FWRITE intrinsic, the FWRITE intrinsic writes only the record pointed to by the logical record pointer. Use the FWRITEDIR intrinsic only for disk les composed of xed-length or unde ned-length records. When information is written to a xed-length record and NOBUF is not speci ed in the FOPEN/HPFOPEN call that opens the le, any unused portion of the record is padded with binary zeros or ASCII blanks.
FWRITELABEL FWRITELABEL NM and CM callable. Writes a user-de ned label onto a disk le or magnetic tape le that is labeled with an ANSI-standard or IBM-standard label. It also overwrites old user labels. Syntax I16V UDS I16V I16V FWRITELABEL( lenum,bu er,length,labelid); Parameters lenum 16-bit signed integer by value (required) bu er Passes the le number of the le to be labeled. user-de ned structure (required) length Passes the label to be written.
FWRITELABEL Related Information Intrinsics Commands Manuals 4-266 None None Accessing Files Programmer's Guide (32650-90017), Using KSAM XL (32650-90168), and KSAM/3000 Reference Manual (30000-90079) Command Definitions
GENMESSAGE GENMESSAGE NM and CM callable (di erences noted below). Provides access to messages in catalogs that were formatted with the MAKECAT utility. Syntax I16 msglength:=GENMESSAGE( I16V I16V I16V lenum,setnum,msgnum, CA I16V I16V bu er,bu ersize,parmask, * * * I16V * * param1,param2,param3,param4 param5,msgdestination, I16 errornum); Functional Return msglength 16-bit signed integer (assigned functional return) Returns the length of the message (in bytes).
GENMESSAGE parmask 16-bit signed integer by value (optional) Passes a mask indicating parameter types for param1 through param5 .
GENMESSAGE param1 through param5 type varies (optional) (NM) Passes the parameter to be inserted into the message. If parmask is 000 (string), pass the 32-bit address of the array containing the string. If parmask is 001 (16-bit signed integer), pass a signed 16-bit integer (a value from -32,768 through 32,767). If parmask is 010 (32-bit signed integer by reference), pass the 16-bit address of the word identi er that returns the value. (CM) Passes the parameter to be inserted into the message.
GENMESSAGE errornum 16-bit signed integer by reference (optional) Returns one of the following values, indicating the success or failure of the intrinsic call.
GENMESSAGE Condition Codes CCE (2) CCL (1) CCG (0) Request granted. Request denied. File system error. Request denied. Missing required parameter, invalid parameter, or invalid le number of catalog or destination le.
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 native mode programming environment. Use of DS intrinsics in NM degrades your program's performance.
GETDSEG Operation Notes The number of extra data segments that can be requested, and the maximum size allowed these segments, is limited by parameters speci ed when the system is con gured. When an extra data segment is created, the GETDSEG intrinsic returns a logical index number to the process. This index number is assigned by the operating system and allows the process to reference the extra data segment in later intrinsic calls.
GETDSEG Condition Codes CCE (2) CCG (0) CCL (1) Request granted. A new extra data segment was created. Request granted. An extra data segment with this identity exists already. Request denied. The following values are returned in index: Value %2000 %2001 %2002 %2003 %2004 Meaning An illegal length was speci ed. The process requested more than the maximum allowable number of data segments. Su cient storage was not available for the data segment.
GETINFO GETINFO NM and CM callable. Returns user-supplied information that was passed to a process when it was created. Syntax I16 CA I16 I16 result:=GETINFO(infostring,infolength,parm); Functional Return result 16-bit signed integer (assigned functional return) Returns an execution value: Value 0 1 Meaning Successful execution. Execution error, one of the following conditions exist: Infostring was speci ed, but infolength was not speci ed.
GETINFO infolength 16-bit signed integer by reference (optional) Passes and receives a value. If infostring is speci ed, infolength must pass the length, in bytes, of infostring . When returning from the call, infolength contains the smaller of either the length of the information string returned in infostring or the original value of infolength . Note Specify a value at least as large as the length of the information string supplied at process creation time.
GETJCW GETJCW NM and CM callable. Returns the value of the system-de ned job control word (JCW) to the calling process. Syntax U16 jcw:=GETJCW; Functional Return jcw 16-bit unsigned integer (assigned functional return) Returns the JCW. This word is structured by the calling program through the SETJCW or PUTJCW intrinsic.
GETLOCRIN NM and CM callable. Acquires local resource identi cation numbers (RINs) for a job/session. Syntax U16V GETLOCRIN(rincount); Parameters rincount 16-bit unsigned integer by value (required) Passes the number of local RINs to be acquired by the job/session. The maximum number of RINs available is de ned when the system is con gured. Operation Notes All local RINs required by a job/session must be acquired in a single call to GETLOCRIN.
GETORIGIN 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.
GETPRIORITY NM and CM callable. Changes the priority of a process. Process handling (PH) capability is required. Syntax I16V U16V I16V GETPRIORITY( pin,priorityclass,rank); Parameters pin 16-bit signed integer by value (required) priorityclass Passes the process whose priority is to be changed. To specify the calling process, set pin to zero. To specify a child process, set pin to the process identi cation number (PIN) of a child process.
GETPRIORITY If in privileged mode, specify the priorityclass parameter as an absolute priority by x A, where x is an 8-bit priority number and A is the ASCII character A. For example, to request a priority class of 31 in the master queue, set priorityclass to %017501. An absolute priority must be speci ed in order to overcome the MAXPRI setting of an account.
GETPRIVMODE NM and CM callable. Dynamically enters privileged mode. Privileged mode (PM) capability is required. Caution Normal operating system checks and limitations are bypassed in privileged mode (PM). It is possible for a PM program to destroy le integrity, including the operating system software itself. Hewlett-Packard will investigate and attempt to resolve problems resulting from the use of PM code.
GETPROCID GETPROCID NM and CM callable. Returns the process identi cation number (PIN) of a child process. Process handling (PH) capability is required. Syntax I16 I16V pin:=GETPROCID(numchild); Functional Return pin 16-bit signed integer (assigned functional return) Returns the PIN of the speci ed child process. Parameters numchild 16-bit signed integer by value (required) Passes a number indicating which child's PIN GETPROCID returns.
GETPROCINFO NM and CM callable. Returns status information about the parent or a child process. Process handling (PH) capability is required.
GETPROCINFO Parameters pin 16-bit signed integer by value (required) Passes the PIN of the process that the returned message pertains to. If requesting a parent process, set pin to zero. If requesting a child process, set pin to the process identi cation number (PIN) of that process. Condition Codes CCE (2) CCG (0) CCL (1) Request granted. Request denied. The process is already being terminated. Request denied. An illegal PIN was speci ed.
GETUSERMODE NM and CM callable. Dynamically returns a program to nonprivileged mode. Syntax GETUSERMODE; Condition Codes CCE (2) CCG (0) CCL (1) Request granted. The program was in privileged mode at the time of the intrinsic call. Request granted. The program was in nonprivileged mode at the time of the intrinsic call. Not returned.
HP32208 HP32208 CM callable only. Returns the current VUF (version, update, x level) of KSAM/3000. Syntax D version:=HP32208 Functional Return version 32-bit signed integer (assigned functional return) Returns the VUF in the following format: Bits Value/Meaning 0:8 8:8 16:16 Version (ASCII format) Update (binary format) Fix level (binary format) Operation Notes This intrinsic is for use with KSAM les only.
HPACDINFO Lists security information from the access control de nition (ACD) of a speci ed le or device. Syntax I32 IV * HPACDINFO(status,itemnum1,item1 IV * [,itemnum2,item2][,...]); A maximum of four itemnum2/item2 pairs can be speci ed. The last speci ed itemnum2/item2 pair takes precedence over all identical itemnum2/item2 pairs speci ed. Any con ict produces a warning message. Note Parameters status 32-bit signed integer by reference (required) Returns the status of the HPACDINFO call.
HPACDINFO itemnum2 integer by value (optional) item2 Passes the number indicating the item2 . Refer to Table 4-12. Type varies (optional) Returns the variable information as speci ed in itemnum2 . Refer to Table 4-12.
HPACDINFO Table 4-11. HPACDINFO Itemnum1/Item1 Values Itemnum Mnemonic Item Description The following constants have been de ned for a le or device request: 1 BA Speci es the target le name. The item1 value speci ed must be a byte array of 1 to 35 characters (for MPE lenames), word aligned. Note that no wildcard characters are allowed, a lockword can be included, and the le name speci ed does not need to be fully quali ed and can be speci ed using an MPE or HFS name syntax.
HPACDINFO Table 4-12. HPACDINFO Itemnum2/Item2 Values Itemnum Mnemonic Item Description Security information that is not user-dependent can be requested using the following itemnum2/item2 pairs: 20 A Returns a unique identi er representing the current version of the ACD. Currently the version number is 5. The item2 value returned is a 16-bit integer. 21 I Returns the number of ACD entries located in the target le ACD. The item2 value returned is a 16-bit integer.
HPACDINFO Table 4-12. HPACDINFO Itemnum2/Item2 Values (continued) Itemnum Mnemonic Item Description Security information that is user-dependent can be requested using the following itemnum2/item2 pairs: 30 BA Speci es the user whose ACD information is to be returned. The item2 value speci ed must be an 18-character byte array, word aligned. If it is <18 characters, it must be terminated with a null character or a carriage return. This entry is required for subsequent user-dependent requests.
HPACDINFO Operation Notes The HPACDINFO intrinsic lists the requested security attributes of a speci ed le or device. Three types of itemnum/item pair descriptors can be used to de ne supplied input or to specify returned ACD information. Such descriptors identify the le or device and request nonuser-dependent and user-dependent data.
HPACDPUT Manipulates security information in the access control de nition (ACD) of a speci ed le or device. Syntax I32 IV * IV * HPACDPUT(status,itemnum1,item1,itemnum2,item2); Parameters status 32-bit signed integer by reference (required) Returns the status of the HPACDPUT call. If no errors or warnings are encountered, status returns 32-bits of zero. If errors or warnings are encountered, status is interpreted as two 16-bit elds: Bits (0:16) comprise status.info .
HPACDPUT item2 Type varies by reference (required) Passes the information to be used to manipulate the ACD of the speci ed le or device. Functionality requests can be made using one of the prede neditemnum2/item2 pairs. Refer to Table 4-14. Table 4-13. HPACDPUT Itemnum1/Item1 Values Itemnum Mnemonic 1 BA Item Description Speci es the target le name. The item1 value speci ed must be a byte array of 1 to 35 characters, word aligned.
HPACDPUT Table 4-14. HPACDPUT Itemnum2/Item2 Values Itemnum Mnemonic Item Description 20 BA Create a new ACD. The item2 value speci ed must be a 1 to 279 character byte array. 21 BA Add ACD pairs. The item2 value speci ed must be a 1 to 279 character byte array. 22 BA Replace ACD pairs. The item2 value speci ed must be a 1 to 279 character byte array. 23 BA Delete ACD pairs. The item2 value speci ed must be a 1 to 279 character byte array. 24 N/A Delete an ACD.
HPACDPUT Operation Notes The HPACDPUT intrinsic allows programmatic adjustment, creation, and deletion of ACDs and their security provisions. The intrinsic is used to create, copy, and delete an ACD and to add, replace, modify, and delete pairs within an ACD.
HPCICOMMAND NM callable only. Executes a command programmatically. Syntax CA I16 I16 I16V HPCICOMMAND( cmdimage,cmderror,parmnum,msglevel); Parameters cmdimage cmderror character array (required) Passes an ASCII string of <=279 characters consisting of a command and parameters, terminated by a carriage return. The carriage return character (%15) must be the last character of the command string. Do not include a prompt character in this string.
HPCICOMMAND Note Check the cmderror parameter to verify ifcmdimage succeeded. The parmnum may provide additional information. msglevel 16-bit signed integer by value (optional) Passes one of the following values, indicating how to handle error and warning messages: Value 0 1 2 Meaning All error/warning messages will be printed to $STDLIST (Default) All CI error messages will be printed to $STDLIST; warning messages will be suppressed No error/warning messages will be printed to $STDLIST.
HPCIDELETEVAR NM callable only. Removes a valid variable name from the session-level variable table. Syntax CA I32 HPCIDELETEVAR(varname,status); Parameters varname character array (required) status Passes the name of a session-level variable whose value is to be retrieved. The name must begin with either an alphabetic character or the underscore character. It must consist of alphanumeric or underscore characters.
HPCIGETVAR HPCIGETVAR NM callable only. Retrieves a valid variable name from the session-level variable table and returns the current value and/or attributes. Syntax CA I32 U32V * HPCIGETVAR( varname,status[,itemnum,item] [...]) Note You can specify up to six itemnum /item pairs. Parameters varname character array (required) status Passes the name of a session-level variable whose value is to be retrieved. The name must begin with either an alphabetic character or the underscore character.
HPCIGETVAR itemnum 32-bit unsigned integer by value (optional) item Passes a number indicating the item , refer to Table 4-15. type varies (optional) Returns variable information as speci ed in itemnum , refer to Table 4-15. Note 4-302 If the type of variable is unknown, pass the maximum number of itemnum,item pairs (6) and check itemnum 13 (variable type) to determine which item holds the variable's value.
HPCIGETVAR Table 4-15. HPCIGETVAR Itemnum/Item Values Itemnum Mnemonic Itemnum/item pair ignored 0 1 Item Description I32 Integer value of variable (output): 0 if variable is not an integer. Default: No value returned 2 CA String value of variable (output): An ASCII 0 is returned if the value of the variable is not a string. Default: No value returned 3 I32 Boolean value of variable (output): 1 for a true value, 0 for a false value, 0 if variable is not a boolean.
HPCIGETVAR Related Information Intrinsics Commands Manuals 4-304 HPCIPUTVAR, HPCIDELETEVAR DELETEVAR, SETVAR, SHOWVAR Command Interpreter Access and Variables Programmer's Guide (32650-90011) and MPE/iX Commands Reference Manual Volumes 1 and 2 (32650-90003 and 32650-90364) Command Definitions
HPCIPUTVAR HPCIPUTVAR NM callable only. Sets the value of a session-level variable. Syntax CA I32 U32V * HPCIPUTVAR( varname,status[,itemnum,item] [...]) Note Up to three itemnum/item pairs can be speci ed. Parameters varname character array (required) Passes the name of a session-level variable for which the value needs to be set. This name must begin with either an alphabetic character or the underscore character and consists of alphanumeric or underscore characters.
HPCIPUTVAR itemnum 32-bit unsigned integer by value (optional) item Passes an item number indicating the item . Refer to Table 4-16. type varies by reference (optional) Passes the variable information speci ed in itemnum . Refer to Table 4-16. Table 4-16. HPCIPUTVAR Itemnum/Item Values Itemnun Mnemonic Itemnum/item pair ignored 0 1 Item Description I32 Integer value assigned to speci ed variable name (input): No other pairs are needed and, if speci ed, will cause an error.
HPCIPUTVAR HPCIPUTVAR itemnum 14 with item Value Value of var value of item Type/Value of my var =0 \TRUE" Boolean (TRUE) \FALSE" Boolean (FALSE) \123" Integer (123) \other chars" String (\other chars") \TRUE" String (\TRUE") \FALSE" String (\FALSE") \123" String (\123") \other chars" String (\other chars") <>0 values Operation Notes Allows the value of a session-level variable to be set. The name must be a valid MPE/iX variable name.
HPDEBUG NM callable only. Enters the system debugger and optionally executes a de ned set of system debug commands. Syntax I32 CA I32V * HPDEBUG(status,cmdstr[,itemnum,item][...]); Parameters status 32-bit signed integer by reference (optional) Returns the status of the HPDEBUG call. If no errors or warnings are encountered, status returns 32-bits of zero. If errors or warnings are encountered, status is interpreted as two 16-bit elds: Bits (0:16) comprise status.info .
HPDEBUG itemnum 32-bit signed integer by value (optional) item Passes an item number indicating the item , refer to Table 4-17. type varies by value (optional) Passes the information speci ed in itemnum , refer to Table 4-17. Table 4-17. HPDEBUG Itemnum/Item Values Itemnum Mnemonic 1 I32 Item Description Output le number: Passes an opened le number where all output generated by Debug is sent. It must be an ASCII le with write access. The value 1 is valid and speci es that $STDLIST is used.
HPDEVCONTROL NM callable only. Provides access to speci ed 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. Syntax I32 CA I32 I32 HPDEVCONTROL(status,ldev,itemnum,item); Parameters status 32-bit integer (required) Returns the status of the HPDEVCONTROL call. If no errors or warnings are encountered, status returns 32-bits of zero.
HPDEVCONTROL itemnum It also may be important to understand that the system converts this parameter to a pointer before passing it to the intrinsic. It should not be coded as a pointer in the calling program, however. 32-bit integer (required) item Speci es which operation is to be performed (refer to Table 4-18). 32-bit integer (required) Table 4-18. HPDEVCONTROL Itemnum/Item Values Itemnum Mnemonic 100 I32 Item Description Load Media: Attempts to load the media (tape devices only).
HPDEVCREATE Provides an application interface to create a streams, fo, and device link le. Syntax CA I32V I32V HPDEVCREATE (pathname,path syntax,path length,status, I32V [,itemnum,item] [ . . . ]); Parameters pathname 32-bit pointer to a packed array of characters (required) path syntax The name of the device le to be created. If the path length does not indicate the length of the pathname, the device le name is assumed to be terminated with a null.
HPDEVCREATE If an invalid character is found in the pathname , an error is returned. Passing a -1 value indicates that the length of the name is unknown. HPDEVCREATE parses the name in the pathname parameter until it nds either a terminating character, an invalid character, or the name is 1023 characters. Passing a value of zero indicates a null or empty name will result in an error. Passing a negative value other than -1 will result in an error. status Default is -1.
HPDEVCREATE Table 4-19. HPDEVCREATE Keywords/Keyvalues Keyword Type 0 None Description End of option list. There is no corresponding keyvalue. Terminates the keyword/keyvalue list and is equivalent to not passing a keyword/keyvalue pair. 1 I32 Device File Category. This option allows you to create one of several types of device les. The following is a list of valid categories: 1 FIFO Specifying this category creates a FIFO le. You can specify the ACD option with this item number.
HPDEVCREATE HPDEVCREATE Keywords/Keyvalues Keyword Type 4 I32 Description Minor Number. This option is used in conjunction with option 3 to provide UNIX compatible device speci cation. If the minor number is speci ed, the major number must be speci ed, or an error is returned. The interpretation of the minor number is dependent on the value of the major number. The minor number represents a streams connection to a driver. A minor number is valid in the range from 0 to 16777215 (represented by 24 bits).
HPENBLTRAP NM callable only. Selectively enables or disables arithmetic traps. Syntax I32V I32 HPENBLTRAP( mask,oldmask); Parameters mask 32-bit signed integer by value (required) Passes a value indicating which arithmetic traps are enabled and which are not: If a bit is on (=1), the corresponding trap is enabled. If a bit is o (=0), the corresponding trap is disabled.
HPENBLTRAP Bits Value/Meaning 15:1 14:1 13:1 12:1 11:1 10:1 IEEE oating-point over ow IEEE oating-point divide by zero IEEE oating-point, invalid operation Range errors Software-detected NIL pointer reference Software-detected misaligned result of pointer arithmetic or error in conversion from long pointer to short pointer Unimplemented condition traps Paragraph stack over ow 3000 mode packed decimal error Reserved for MPE/iX Assertion trap 9:1 8:1 7:1 1:7 0:1 Note The following apply to various trap
HPENBLTRAP Operation Notes Allows selective enabling or disabling of arithmetic traps. It provides more exibility than the ARITRAP intrinsic, which collectively enables or disables traps. There is a di erence between arming and enabling traps: Enabling a trap means that the occurrence of a trap condition is not ignored. Arming a trap is required so that, on a trap condition, a user-written routine is invoked and can take appropriate recovery actions.
HPERRDEPTH HPERRDEPTH NM callable only. Returns the current depth of the process error stack. Syntax I32 I32 HPERRDEPTH( depth,status); Parameters depth 32-bit signed integer by reference (required) status Returns the current number of entries on the process error stack. 32-bit signed integer by reference (optional) Returns the status of the HPERRDEPTH call. If no errors or warnings are encountered, status returns 32-bits of zero.
HPERRDEPTH Related Information Intrinsics Commands Manuals 4-320 HPERRMSG, HPERRREAD'' None Getting System Information Programmer's Guide (32650-90018) and MPE/iX Error Message Manual Volumes 1, 2 and 3 (32650-90066, 32650-90152, and 32650-90368) Command Definitions
HPERRMSG HPERRMSG NM callable only. Obtains or displays error messages from the system catalog. Syntax I32V I32V I16 I32V HPERRMSG(displaycode,depth,errorproc,errornum, CA I16 I32 bu er,bu ength,status); Parameters displaycode 32-bit signed integer by value (required) Speci es the operation to be performed: Value 1 2 3 4 5 6 Meaning Dump the error stack to $STDLIST and display any errors that are detected by HPERRMSG (returned in status ).
HPERRMSG Value 7 8 depth Meaning Get messages for the number of stack errors speci ed in depth and place them in the bu er speci ed by bu er . The contents of bu er contains the same information as if the user had speci ed displaycode 4, including errors that are detected by HPERRMSG. All messages are separated by carriage return/line feed characters. Dump the error stack to the bu er speci ed by bu er .
HPERRMSG bu ength 16-bit signed integer by reference (optional) Passes the length of the bu er input: As an input parameter, the length of the bu er where the error messages are to be placed. If the resulting messages are longer than this length, they are truncated. This procedure does not verify that the bu er parameter has enough storage to hold the number of bytes speci ed by bu ength . If there is not enough storage, the caller's stack may be corrupted.
HPERRMSG Operation Notes Allows the user to obtain or display error messages from the system catalog by supplying the corresponding error statuses. The caller can supply a status whose corresponding message is to be displayed, or specify that the messages corresponding to one or more errors in the process error stack be displayed. The caller can optionally provide a bu er and ask that the error messages be placed in that bu er rather than be displayed to the user.
HPERRREAD HPERRREAD NM callable only. Reads any speci ed error from the process stack. Syntax I32V I32 I32 I32 HPERRREAD(depth,errornum,procnum,status Parameters depth 32-bit signed integer by value (required) errornum Passes the index of the stack entry to read from. A 1 (one) implies the last entry that was pushed. Speci cation of depth equal to that of the actual stack depth implies the oldest entry on the stack.
HPERRREAD Bits (0:16) comprise status.info . A negative value indicates an error condition, and a positive value indicates a warning condition. Refer to the MPE/iX Error Message Manual Volumes 1, 2 and 3 (32650-90066, 32650-90152, and 32650-90368) for a description of its value. Bits (16:16) comprise status.subsys . The value represented by these bits de nes the subsystem that set the status information. The subsystem identi er for HPERRREAD is 187. If not speci ed, defaults to NIL.
HPFDUPLICATE HPFDUPLICATE NM callable only. Creates duplicate le descriptors for les opened for MULTI, SHARED, or EXCLUSIVE access. Syntax I16 I32 I32V * lenum:=HPFDUPLICATE(source,status,target); Functional Return lenum 16-bit signed integer (assigned functional return) Returns the actual le number used to duplicate the source le. This le number can be di erent than the le number requested in the target parameter. If an error occurs during the duplication process, a -1 value is returned.
HPFDUPLICATE Related Information Intrinsics Commands Manuals 4-328 FOPEN, HPFOPEN None None Command Definitions
HPFIRSTLIBRARY HPFIRSTLIBRARY NM callable only. Returns the le name of the rst executable library (XL) in the binding sequence of the calling process. Syntax CA I32 I32 CA HPFIRSTLIBRARY(formaldesig,status,length, rstlib, I32 I32 rstlib length, rstlib syntax); Parameters formaldesig character array (required) Returns the fully quali ed MPE syntax le name of the rst XL in the binding sequence of the calling process.
HPFIRSTLIBRARY speci ed, HPFIRSTLIBRARY determines if the rstlib parameter is long enough to hold the rst library name to be returned. Note that a value is not returned in rstlib length if the rstlib parameter is not speci ed. rstlib syntax 32-bit signed integer by reference (optional) On input, the rstlib syntax parameter speci es the syntax that will be used when HPFIRSTLIBRARY returns a name in the rstlib parameter. On output, the rstlib syntax parameter returns the syntax that is actually used.
HPFOPEN HPFOPEN NM callable only. Creates le objects and supports FIFO les. Syntax HPFOPEN( Note I32 I32 I32V * lenum,status[,itemnum,item] [...]); Up to 41 itemnum /item pairs can be speci ed. Parameters lenum 32-bit signed integer by reference (required) Returns a le descriptor for a FIFO le. status Can be used safely with all le system intrinsics that require a 16-bit le number to be passed in the intrinsic call (for example, FREAD, FWRITE, FCLOSE).
HPFOPEN itemnum 32-bit signed integer by value (optional) item Passes the item number. Refer to Table 4-20. type varies by reference (optional) Passes and/or returns the option indicated by the corresponding itemnum parameter. Refer to Table 4-20. Note 4-332 An itemnum takes precedence over any previously speci ed duplicate itemnum . Any duplicated itemnum is agged as a warning.
HPFOPEN Table 4-20. HPFOPEN Itemnum/Item Values Itemnum Mnemonic 0 Item Description End of option list: There is no corresponding item . The absence of an itemnum after the last itemnum ,item pair is equivalent to specifying this option. 2 CA Formal designator: Passes a formal le designator that is interpreted according to MPE-escaped semantics (unless another syntax has been chosen via item 41). The le name must be terminated by a nonalphanumeric character other than a period (.
HPFOPEN Table 4-20. HPFOPEN Itemnum/Item Values (continued) Itemnum Mnemonic 2 cont'd Item Description The following are examples of valid formal le designators: &file/lock.group.account:node.dest.level& &filename& &!myfile& &!afile/![FINFO("!afile",33)]& The following are examples of invalid formal le designators: "filename.group (missing delimiter (")) file.group" ( 'f' is used as delimiter, missing at end) (ASC) It is recommended that this itemnum , item pair be used for asynchronous devices.
HPFOPEN Table 4-20. HPFOPEN Itemnum/Item Values (continued) Itemnum Mnemonic 5 I32 Item Description Designator: Passes a value indicating a special le opening. Any of the following special les can be speci ed with the itemnum =2. For example, a le name of $STDLIST opens the standard list device. The following values are valid: 0 Allows all other options to specify the le. 1 The actual le designator is $STDLIST . 2 The actual le designator is $NEWPASS . 3 The actual le designator is $OLDPASS .
HPFOPEN Table 4-20. HPFOPEN Itemnum/Item Values (continued) Itemnum Mnemonic Item Description Byte stream record format may be speci ed only for standard disk les (itemnum 10 equal to 0). Hierarchical directory record format is the the default record format when creatinng a directory (itemnum 10 equal to 9). Itemnum 10 equal to 9 is the only record format which may be speci ed when creating a directory. Hierarchical record format is only speci ed for the directory le type.
HPFOPEN Table 4-20. HPFOPEN Itemnum/Item Values (continued) Itemnum Mnemonic 7 cont'd Item Description For computing record size, the le system considers carriage-control information as part of the data record. Therefore, specifying the carriage-control option adds one byte to the record size when the le is originally created. For example, a speci cation of REC=-132,1,F,ASCII;CCTL results in a recsize of 133 bytes. Generally, the entire record can be read.
HPFOPEN Table 4-20. HPFOPEN Itemnum/Item Values (continued) Itemnum Mnemonic 10 I32 Item Description File type: Passes a value indicating the internal record structure used to access records in the le. If the le is old, this option is ignored. Specifying an itemnum =5 value other than zero overrides this option. This option is applicable only at le creation.
HPFOPEN Table 4-20. HPFOPEN Itemnum/Item Values (continued) Itemnum Mnemonic 11 cont'd Item Description 3 Append access only, if the le's security provisions allow either append or write access. FREAD, FREADDIR, FREADSEEK, FUPDATE, FSPACE, FPOINT, and FWRITEDIR intrinsic calls cannot reference this le. The record pointer is set to EOF prior to each FWRITE. For disk les, the EOF is updated after each FWRITE call. Therefore, data cannot be overwritten.
HPFOPEN Table 4-20. HPFOPEN Itemnum/Item Values (continued) Itemnum Mnemonic 12 I32 Item Description Dynamic locking: Passes a value enabling/disabling le locking for the le. When speci ed, the FLOCK and FUNLOCK intrinsics can be used to dynamically permit/restrict concurrent access to a disk le by other processes at speci ed times.
HPFOPEN Table 4-20. HPFOPEN Itemnum/Item Values (continued) Itemnum Mnemonic 13 I32 Item Description Exclusive: Passes a value indicating continuous exclusive access to the le, from open to close. Use this option when performing a critical operation (for example, updating the le). The following values are valid: 0 If itemnum =11 speci es read only access, read-share access takes e ect. Otherwise, exclusive access takes e ect. Regardless of which access option was selected, FFILEINFO reports zero.
HPFOPEN Table 4-20. HPFOPEN Itemnum/Item Values (continued) Itemnum Mnemonic 14 I32 Item Description Multiaccess: Passes a value indicating how the le's record pointer is to be shared. This option is useful for sharing standard input devices where there is some natural sequence of access to the le. This option permits processes located in di erent jobs or sessions to open the same le and share that le's record pointer. The following values are valid: 0 No multiple process access allowed.
HPFOPEN Table 4-20. HPFOPEN Itemnum/Item Values (continued) Itemnum Mnemonic 16 I32 Item Description Nowait I/O: Allows the accessor to initiate an I/O request and to have control returned before the completion of the I/O. This option implies the inhibit bu ering option; if NOBUF is not speci ed, the le system does it. Multirecord access is not available. This option is not available if the le is located on a remote computer.
HPFOPEN Table 4-20. HPFOPEN Itemnum/Item Values (continued) Itemnum Mnemonic 18 @32 Item Description Short-mapped: Returns a short pointer to the beginning of the data area of the le. This option maps the le into short pointer space. A short-mapped le can be 4 megabytes in length. The calling process can have up to 6 megabytes of short-mapped les open at a time. Use the pointer as a large array of any type to e ciently access the le.
HPFOPEN Table 4-20. HPFOPEN Itemnum/Item Values (continued) Itemnum Mnemonic 20 CA Item Description Device name: Passes the logical device number, in ASCII form, of a speci c device. The le is assumed to be permanent. If the device name option is speci ed, the nonshareable device should be ready prior to the HPFOPEN call (otherwise, an error results).
HPFOPEN Table 4-20. HPFOPEN Itemnum/Item Values (continued) Itemnum Mnemonic 22 CA Item Description Volume class: Passes a character array representing a volume class name where the le space is to be restricted. This option is applicable only at le creation. A volume class is a subset of volumes within a volume set. The volume class name must be a valid volume class name residing on the volume set bound to the volume (the volume set is an attribute of the group in which the le resides).
HPFOPEN Table 4-20. HPFOPEN Itemnum/Item Values (continued) Itemnum Mnemonic 25 CA Item Description Printer environment: Passes the name of a le that contains a printer environment. This option is valid only for speci ed printer devices. If opening an Hewlett-Packard 268x page printer le, specify an optional printing environment for the job.
HPFOPEN Table 4-20. HPFOPEN Itemnum/Item Values (continued) Itemnum Mnemonic 28 CA Item Description Spooled message: Passes a spooler message associated with a spool le. For example, a message is passed that can be used for telling the system operator what type of paper to use in the line printer. This message must be displayed to the system operator and veri ed before the le can be printed on a line printer. The number of characters allowed <=48; any quantity > 48 characters is truncated.
HPFOPEN Table 4-20. HPFOPEN Itemnum/Item Values (continued) Itemnum Mnemonic 31 CA Item Description Labeled tape expiration: Passes the date of the expiration of the le or the date after which the information in the le is no longer useful, in the format MM/DD/YY . The le can be overwritten after this date. If the default is speci ed, the le can be overwritten immediately. In a volume set, le expiration dates must always be equal to or earlier than the date on the previous le.
HPFOPEN Table 4-20. HPFOPEN Itemnum/Item Values (continued) Itemnum Mnemonic 34 I32 Item Description Spooler copies: Passes a value in the range 1..127 indicating the number of copies of the entire le to be produced by the spooling facility. This option is applicable to spooled devices only. This option can be speci ed for a le already opened (for example, $STDLIST ), where the highest value supplied before the last FCLOSE takes e ect.
HPFOPEN Table 4-20. HPFOPEN Itemnum/Item Values (continued) Itemnum Mnemonic 37 I32 Item Description File code: Passes a value that can be used as a le code to identify the type of le. This code is recorded in the le label and is accessible through the FFILEINFO intrinsic. This option is applicable only at le creation (except when opening an old le that has a negative le code). If the program is running in user mode, specify a le code in the range 0..32,767 to indicate the le type being created.
HPFOPEN Table 4-20. HPFOPEN Itemnum/Item Values (continued) Itemnum Mnemonic 39 I32 Item Description Access type: Passes a value indicating how to use the le, either sequentially or randomly. The le system uses this information to determine the most e cient prefetching algorithm to improve the performance of the le access. The following values are valid: 0 Access the le sequentially 1 Access the le randomly Default: 0 (ASC) Not used for asynchronous devices.
HPFOPEN Table 4-20. HPFOPEN Itemnum/Item Values (continued) Itemnum Mnemonic 42 CA Item Description Device class: Passes a device class where the le resides. The le system uses the device class name to select a nonshareable device from a con gured list of available devices. The name can have a length of up to eight alphanumeric characters, beginning with a letter (for example, TAPE). If a device class is speci ed, the le is allocated to any available device in that class.
HPFOPEN Table 4-20. HPFOPEN Itemnum/Item Values (continued) Itemnum Mnemonic 44 I32 Item Description Numbu ers: Passes the number of bu ers to allocate to the le. Ignored for standard disk les. This option is useful only for slow devices (such as tapes) used in a bu ered mode. Not applicable for les representing interactive terminals; a system-managed bu ering method is always used. The valid range for this option is dependent upon the le type: For standard and KSAM les, the valid range is 1..31.
HPFOPEN Table 4-20. HPFOPEN Itemnum/Item Values (continued) Itemnum Mnemonic 46 I32 Item Description Inhibit bu ering: Passes a value enabling/disabling automatic operataing systembu ering. If NOBUF is speci ed, I/O is allowed to take place directly between the data area and the applicable hardware device. The following values are valid: 0 Allow normal bu ering (BUF) 1 Inhibit bu ering (NOBUF) Default: 0 NOBUF access is oriented to physical block transfer rather than logical record transfer.
HPFOPEN Table 4-20. HPFOPEN Itemnum/Item Values (continued) Itemnum Mnemonic 47 I32 Item Description Numextents: Passes a value in the range 1..32 that determines the number of extents for the le. If a value of 1 is speci ed, the le is created as one contiguous extent of disk space. If a value greater than 1 is speci ed, a variable number of extents (with varying extent sizes) is allocated on a need basis. This option is applicable only at le creation. (ASC) Not used for asynchronous devices.
HPFOPEN Table 4-20. HPFOPEN Itemnum/Item Values (continued) Itemnum Mnemonic 50 I32 Item Description Final disposition: Passes a value indicating the nal disposition of the le at close time (signi cant only for les on disk and magnetic tape). A corresponding parameter in a FILE command can override this option, unless le equations are disallowed with itemnum =9. The following values are valid: 0 No change. The disposition remains as it was before the le was opened.
HPFOPEN Table 4-20. HPFOPEN Itemnum/Item Values (continued) Itemnum Mnemonic 51 String Item Description Pascal XL string: Passes a formal le designator that follows MPE/iX le naming conventions, using the Pascal XL STRING type format. This option is identical to itemnum =2 except for the type of item. No delimiters are needed. Default: No string passed When you use HPFOPEN to open a le, you may use either itemnum =2 or you may use itemnum =51; you may not use both.
HPFOPEN Table 4-20. HPFOPEN Itemnum/Item Values (continued) Itemnum Mnemonic 53 I32 Item Description ASCII/binary: Passes a value indicating whether ASCII or binary code is to be used for a new le when it is written to a device that supports both codes. For disk les, this a ects padding that can occur when issuing a direct-write intrinsic call (FWRITEDIR) to a record that lies beyond the current logical end-of- le indicator. By default, magnetic tape and les are treated as ASCII les.
HPFOPEN Table 4-20. HPFOPEN Itemnum/Item Values (continued) Itemnum Mnemonic Item Description 58 Reserved for the operating system 59 Reserved for the operating system 60 Reserved for the operating system 61 Reserved for the operating system 64 BA Access Control De nition: Passes a byte array de ning the access control de nition (ACD) to be attached to a new le. The byte array has a length of 1 to 279 bytes.
HPFOPEN Table 4-20. HPFOPEN Itemnum/Item Values (continued) Itemnum Mnemonic 77 I32 Item Description Data format Allows the caller to select a di erent format to view the data in the le. The current valid values for this item are: 0 Use the standard record based view of accessing the le. This is the default value for all opens. For conventional les, the le is record based. For directories, the standard non-privileged directory information is returned when the HPDIRREAD intrinsic is called.
HPFOPEN Table 4-20. HPFOPEN Itemnum/Item Values (continued) Itemnum Mnemonic Item Description 80 I32 Reserved for the operating system. 81 I32 Symbolic link option: This itemnum allows the caller to specify di erent options when traversing through or opening a symbolic link. The valid values for this itemnum are described below: 0 Follow symbolic links. This is the default value for this option. When a symbolic link is encountered it is traversed according to the path speci ed in the symbolic link.
HPFOPEN Operation Notes Enables creation of a new le on a shareable device and de nes the physical characteristics of that le prior to access. Enables access to existing les. Returns a le number to the calling process that uniquely identi es the le. Use the le number to reference the le in calls to other intrinsics.
HPFPCONVERT NM and CM callable. Converts data between binary oating-point formats. Syntax * * I16V I16V HPFPCONVERT( source,destination,sformat,dformat, I32 I16 I16V status,exceptions,roundmode) Parameters source any supported real type by reference (required) destination Passes the oating-point number to be converted. Constants are not acceptable. You can specify a reference parameter of any supported real type in the intrinsic call statement. The format is identi ed by sformat .
HPFPCONVERT dformat 16-bit signed integer by value (required) The destination oating-point format. This is the looking forward to some leisure and alternative nursing choices.format of the converted number. Valid formats are: Value 1 2 3 4 5 status Meaning Hewlett-Packard 3000 32-bit Hewlett-Packard 3000 64-bit IEEE 32-bit IEEE 64-bit IEEE 128-bit 32-bit signed integer by reference (optional) Returns the status of the HPFPCONVERT intrinsic call.
HPFPCONVERT exceptions 16-bit signed integer by reference (optional) Returns any exception conditions that occurred during the conversion. If status.info is less than zero, then exceptions is not modi ed because no conversion is done. If this parameter is not present, the value is returned in status.info .
HPFPCONVERT Related Information Intrinsics Commands Manuals None None Data Types Conversion Programmer's Guide (32650-90015).
HPGETPROCPLABEL NM callable only. Dynamically loads a native mode (NM) executable library procedure. Syntax CA U32 I32 CA HPGETPROCPLABEL(procname,plabel,status, rst le, B casesensitive); Parameters procname character array (required) plabel Passes the name of the procedure being searched for. The rst character of procname designates the terminating character that HPGETPROCPLABEL uses to search for the end of the name.
HPGETPROCPLABEL rst le character array (optional) Passes the name of the program le or XL at which to begin searching. The rst le parameter can be either in MPE syntax or HFS syntax. If the name of the program le or XL is in HFS syntax, you must use an absolute pathname. The rst character that HPGETPROCPLABEL uses to search for the end of the le name. That delimiter can appear again only following the last valid character of the name.
HPGETPROCPLABEL A plabel returned by HPGETPROCPLABEL is valid only for the duration of the calling process. Related Information Intrinsics Commands Manuals 4-370 None None Resource Management Programmer's Guide (32650-90024).
HPLOADCMPROCEDURE HPLOADCMPROCEDURE NM callable only. Obtains CM procedure plabel in preparation for Switch to CM through plabel. Syntax U16 CA U16V I32 plabel:=HPLOADCMPROCEDURE(procname,library,status); Functional Return plabel 16-bit unsigned integer (assigned functional return) Plabel of the target CM procedure. Parameters procname character array (required) library Passes an ASCII procedure name, left-justi ed and blank-padded. The name can have a maximum of 16 characters.
HPLOADCMPROCEDURE status 32-bit signed integer by reference (optional) Returns the status of the HPLOADCMPROCEDURE intrinsic call. If no errors or warnings are encountered, status returns 32 bits of zero. If errors or warnings are encountered, status is interpreted as two 16-bit elds. Bits (0:16) comprise status.info . A negative value indicates an error condition, and a positive value indicates a warning condition.
HPLOADNMPROC HPLOADNMPROC CM callable only. Returns the plabel of an NM procedure. Syntax U32 CA I16V CA plabel:=HPLOADNMPROC(procname,proclen,libname, I16V liblen) Functional Return plabel 32-bit unsigned integer (assigned functional return) Plabel of the target NM procedure. Parameters procname character array by reference (required) proclen Passes the target procedure name. The target procedure must be contained in an executable library (XL).
HPLOADNMPROC Related Information Intrinsics Commands Manuals 4-374 HPSWITCHTOCMPROCEDURE None Switch Programming Guide (32650-90014) Command Definitions
HPMERGEEND HPMERGEEND NM callable only. Releases the MERGE/XL work area and ends the merging operation. Syntax I32 I32A HPMERGEEND( status,statistics); Parameters status 32-bit signed integer by reference (optional) Returns the status of the HPMERGEEND call. If no errors or warnings are encountered, status returns 32 bits of zero. If errors or warnings are encountered, status is interpreted as two 16-bit elds. Bits (0:16) comprise status.info .
HPMERGEERRORMESS NM callable only. Accepts Hewlett-Packard MERGE intrinsic error code values and returns the error messages associated with them. Syntax I32 CA I32 HPMERGEERRORMESS(status,message,length); Parameters status 32-bit signed integer by reference Passes the status of a previous Hewlett-Packard MERGE intrinsic call that failed. The status value passed in is used to locate the appropriate message catalog entry associated with the status value.
HPMERGEERRORMESS Related Information Intrinsics Commands Manuals Hewlett-Packard SORT, Hewlett-Packard MERGE None SORT-MERGE/XL Programmer's Guide (32650-90080) Command Definitions 4-377
HPMERGEINIT NM callable only. Initializes the MERGE/XL subsystem. Syntax I32 I32A PROC I32A HPMERGEINIT( status,input les,preprocessor,output les, PROC 32V I32V postprocessor,keysonly,numkeys, I32A CA PROC PROC keys,altseq,keycompare,errorproc, I32A I32V I32A statistics,memsize,charseq); Parameters status 32-bit signed integer by reference (optional) Returns the status of the HPMERGEINIT call. If no errors or warnings are encountered, status returns 32 bits of zero.
HPMERGEINIT output les 32-bit signed integer array (optional) Passes the le identi cation number of the output le in the rst array element. If the le is opened with either the NOBUF or MR (multirecord) access option (aoption ), MERGE/XL performs the bu ering and blocking/deblocking. postprocessor If you do not specify this parameter, you must call the HPMERGEOUTPUT intrinsic to retrieve merged records. procedure (reserved) keysonly Do not specify this parameter, but maintain parameter position.
HPMERGEINIT For each key, there are four entries in the array. The rst element gives the position of the rst byte of the key within the input record. The second element gives the number of bytes in the key.
HPMERGEINIT altseq character array (optional) Passes an alternate collating sequence. The rst element is speci ed according to the following table, where the sequence comprises the columns and the data comprises the rows: excess space above nonumber table|> ASCII ASCII chr(255) EBCDIC chr(1) EBCDIC ALTSEQ chr(2) chr(0) chr(255) unde ned The second element speci es one fewer than the total number of characters in the collating sequence.
HPMERGEINIT memsize 32-bit signed integer by value (reserved) charseq Do not specify, but maintain parameter position. 32-bit signed integer array (optional) Passes language information. Set the rst element to 1 and the second element to the language ID of the native language collating sequence to be used for keys of type character (keys parameter equal to 10).
HPMERGEOUTPUT HPMERGEOUTPUT NM callable only. Retrieves records, one at a time, from MERGE/XL. Syntax I32 CA I32 HPMERGEOUTPUT(status,bu er,length); Parameters status 32-bit signed integer by reference (optional) Returns the status of the HPMERGEOUTPUT call. If no errors or warnings are encountered, status returns 32 bits of zero. If errors or warnings are encountered, status is interpreted as two 16-bit elds. Bits (0:16) comprise status.info .
HPMERGESTAT NM callable only. Prints MERGE/XL statistics on $STDLIST. Syntax I32 I32A HPMERGESTAT( status,statistics); Parameters status 32-bit signed integer by reference (optional) Returns the status of the HPMERGESTAT call. If no errors or warnings are encountered, status returns 32 bits of zero. If errors or warnings are encountered, status is interpreted as two 16-bit elds. Bits (0:16) comprise status.info .
HPMERGESTAT Operation Notes Call HPMERGESTAT after you have called the HPMERGEEND intrinsic. A call to HPMERGESTAT is valid only if you supplied the statistics parameter in the calls to the HPMERGEINIT and HPMERGEEND intrinsics. The same array is then supplied to HPMERGESTAT .
HPMERGETITLE NM callable only. Prints the version number and title information for MERGE/XL on $STDLIST. Syntax I32 HPMERGETITLE(status); Parameters status 32-bit signed integer by reference (optional) Returns the status of the HPMERGETITLE call. If no errors or warnings are encountered, status returns 32 bits of zero. If errors or warnings are encountered, status is interpreted as two 16-bit elds. Bits (0:16) comprise status.info .
HPMYFILE HPMYFILE NM callable only. Returns the le name of the native mode program or executable library (XL) that called the HPMYFILE intrinsic. Syntax CA CA HPMYFILE(formaldesig,status,length,my le I32 I32 I32 I32 my le length, my le syntax); Parameters formaldesig character array (required) Returns the fully quali ed MPE syntax le name of the program or XL that called HPMYFILE.
HPMYFILE Returns the length (in bytes) of the le name returned in the formaldesig parameter (including the two blanks that act as delimiters). A zero returned indicates that no le name is returned. character array (optional) my le Returns the absolute pathname or fully quali ed MPE syntax name of the program or XL that called HPMYFILE. my le length The my le parameter contains the name with delimiters. The rst and last characters of the returned value are blanks that act as delimiters.
HPMYPROGRAM HPMYPROGRAM NM callable only. Returns the le name of the program being executed by the calling process. Syntax CA I32 I32 HPMYPROGRAM(formaldesig,status,length CA I32 I32 myprogram,myprogram length,myprogram syntax); Parameters formaldesig character array (required) Returns the fully quali ed MPE syntax name of the program being executed by the calling process.
HPMYPROGRAM length 32-bit signed integer by reference (optional) myprogram Returns the length (in bytes) of the le name returned in the formaldesig parameter (including the two blanks that act as delimiters). A zero returned indicates that no le name is returned. character array (optional) Returns the absolute pathname or fully quali ed MPE syntax name of the program being executed by the calling process. myprogram length The myprogram parameter contains the name with delimiters.
HPMYPROGRAM Related Information Intrinsics Commands Manuals None None Resource Management Programmer's Guide (32650-90024) Command Definitions 4-391
HPMYPROGRAM Related Information Intrinsics Commands Manuals None None Resource Management Programmer's Guide (32650-90024) Command Definitions 4-391
HPMYPROGRAM Related Information Intrinsics Commands Manuals None None Resource Management Programmer's Guide (32650-90024) Command Definitions 4-391
HPRESETDUMP NM callable only. Disarms the system debugger call from a process abort. Syntax I32 HPRESETDUMP( status); Parameters status 32-bit signed integer by reference (optional) Returns the status of the HPRESETDUMP call. If no errors or warnings are encountered, status returns 32 bits of zero. If errors or warnings are encountered, status is interpreted as two 16-bit elds. Bits (0:16) comprise status.info .
HPSELECT HPSELECT Determine whether a le or group of les is ready to perform reads, writes, or if it has an exception condition, and whether to block on one or more of these events if the condition is not currently true. Syntax I16 IV numselect:=HPSELECT(num CA CA les,readmask,writemask, CA R I32 exceptionmask,timeout,status) Functional Return numselect 16-bit signed integer (assigned functional return) Returns a value representing the number of les that have selected true.
HPSELECT readmask character array by reference (optional) Speci es which le numbers will be examined to see if the le that is ready for reading should be passed. The least signi cant bit of each 32-bit word represents the lowest le number in the word. The rst word contains the bits for the rst 32 les. Subsequent words contain the bits for additional groups of 32 les.
HPSELECT exceptionmask character array by reference (optional) Speci es which le numbers are to be examined to see if the le has detected an exception condition. The last signi cant bit of each 32-bit word represents the lowest le number in the word. The rst word contains the bits for the rst 32 les. Subsequent words contain the bits for additional groups of 32 les.
HPSELECT status 32-bit integer by reference (optional) Returns the status of the HPSELECT call. If no errors or warnings are encountered, status returns 32 bits of zero. If errors or warnings are encountered, status is interpreted as two 16-bit elds. Bits (0:16) comprise status.info . A negative value indicates an error condition, and a positive value indicates a warning condition.
HPSETCCODE HPSETCCODE NM callable only. Sets the condition code for the calling process. Syntax I32V HPSETCCODE( ccodevalue); Parameters ccodevalue 32-bit signed integer by value (required) Sets the condition code for the calling process. The valid values are: Value 0 1 2 Meaning Condition Code Greater Than (CCG). A special condition occurred but may not have a ected the execution of the request. Condition Code Less Than (CCL). The request was not granted because an error condition occurred.
HPSETCCODE Related Information Intrinsics Commands Manuals 4-400 None None Switch Programming Guide (32650-90014) Command Definitions
HPSETDUMP HPSETDUMP NM callable only. Arms the system debugger call from a process abort. Syntax I32 CA HPSETDUMP(status,cmdstr); Parameters status 32-bit signed integer (optional) Returns the status of the HPSETDUMP call. If no errors or warnings are encountered, status returns 32 bits of zero. If errors or warnings are encountered, status is interpreted as two 16-bit elds. Bits (0:16) comprise status.info .
HPSETDUMP Operation Notes The process enabling the system debugger can be the current process or any child of the current process created after the intrinsic call. The commands are contained in a character array, left-justi ed, with a delimiting character as the rst and last character of the command string. Before a process aborts, Debug is called to execute the commands in cmdstr . Any command that attempts to obtain user input causes an error when executed by Debug.
HPSORTEND HPSORTEND NM callable only. Releases the SORT/XL work area and ends the sorting operation. Syntax I32 I32A HPSORTEND(status,statistics); Note HPSORTEND must be called to terminate SORT/XL and release the work space. Parameters status 32-bit signed integer by reference (optional) Returns the status of the HPSORTEND call. If no errors or warnings are encountered, status returns 32 bits of zero. If errors or warnings are encountered, status is interpreted as two 16-bit elds.
HPSORTEND Operation Notes HPSORTEND initiates the merge phase of the Hewlett-Packard SORT program and writes to the output le if the HPSORTOUTPUT intrinsic is not used. HPSORTEND is required if you called HPSORTINIT. Call HPSORTEND either after all calls to the output le are completed by the HPSORTINIT intrinsic, or after all calls to the HPSORTOUTPUT intrinsic are completed. HPSORTEND must be called in the same process as the HPSORTINIT intrinsic.
HPSORTERRORMESS HPSORTERRORMESS NM callable only. Retrieves an error message if a fatal error occurs in SORT/XL. Syntax I32 CA I32 HPSORTERRORMESS(status,message,length); Parameters status 32-bit signed integer by reference (optional) Passes the status of a previous HPSORT intrinsic call that failed. The status value passed in is used to locate the appropriate message catalog entry associated with the status value.
HPSORTINIT NM callable only. Initializes the SORT/XL subsystem. Syntax I32 I32A I32A I32 HPSORTINIT( status,input les,output les,outputoption, I32V I32V I32V I32A reclength,numrecs,numkeys,keys CA PROC PROC I32A altseq,keycompare,errorproc,statistics, I32V I32A memsize,charseq); Parameters status 32-bit signed integer by reference (optional) Returns the status of the HPSORTINIT call. If no errors or warnings are encountered, status returns 32 bits of zero.
HPSORTINIT output les 32-bit signed integer array (optional) Passes the le identi cation number of the output le. The second array element must be a zero, indicating the end of the array. If the les are opened with either the NOBUF or MR (multirecord) access option (aoption ), the SORT/XL program performs the bu ering and blockingndeblocking. outputoption If you do not supply this parameter, you must call HPSORTOUTPUT to retrieve the sorted records.
HPSORTINIT Passes information about the keys used during the comparison of records. If you specify the keys parameter, you must specify the numkeys parameter. Together, keys and numkeys describe the way records are sorted. For each key, there are four entries in the array. The rst element gives the position of the rst byte of the key within the input record. The second element gives the number of bytes in the key.
HPSORTINIT The fourth element gives the ordering sequence of the records: Value 0 1 Meaning Ascending Descending Note The integrity of the keys array must be maintained throughout the SORT/XL operation. Do not change it until after you have called the HPSORTEND intrinsic. altseq character array (optional) Passes an alternate collating sequence.
HPSORTINIT statistics 32-bit signed integer array (optional) Returns information on the SORT/XL operation: Value 1 2 3 4 5 6 memsize Meaning Number of records sorted Number of intermediate passes Number of bytes in the SORT/XL program work area Number of compares CPU time used in milliseconds Elapsed time in milliseconds 32-bit signed integer by value (reserved) Do not specify, but maintain parameter position. charseq 32-bit signed integer array (optional) Passes language information.
HPSORTINPUT HPSORTINPUT NM callable only. Passes records, one at a time, to SORT/XL. Syntax I32 CA I32V HPSORTINPUT(status,bu er,length); Parameters status 32-bit signed integer by reference (optional) Returns the status of the HPSORTINPUT call. If no errors or warnings are encountered, status returns 32 bits of zero. If errors or warnings are encountered, status is interpreted as two 16-bit elds. Bits (0:16) comprise status.info .
HPSORTOUTPUT NM callable only. Retrieves records, one at a time, from SORT/XL program. Syntax I32 CA I32 HPSORTOUTPUT(status,bu er,length); Parameters status 32-bit signed integer by reference (optional) Returns the status of the HPSORTOUTPUT call. If no errors or warnings are encountered, status returns 32 bits of zero. If errors or warnings are encountered, status is interpreted as two 16-bit elds. Bits (0:16) comprise status.info .
HPSORTOUTPUT Related Information Intrinsics Commands Manuals HPSORT, HPMERGE None SORT-MERGE/XL Programmer's Guide (32650-90080).
HPSORTSTAT NM callable only. Prints the SORT/XL statistics on $STDLIST. Syntax I32 I32A HPSORTSTAT( status,statistics); Parameters status 32-bit signed integer by reference (optional) Returns the status of the HPSORTSTAT call. If no errors or warnings are encountered, status returns 32 bits of zero. If errors or warnings are encountered, status is interpreted as two 16-bit elds. Bits (0:16) comprise status.info .
HPSORTSTAT Operation Notes Call HPSORTSTAT after you have called the HPSORTEND intrinsic. A call to HPSORTSTAT is valid only if the statistics parameter is speci ed to the HPSORTINIT and HPSORTEND intrinsics. The same array is supplied to HPSORTSTAT. Related Information Intrinsics Commands Manuals HPSORT, HPMERGE None SORT-MERGE/XL Programmer's Guide (32650-90080).
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. Syntax I32 HPSORTTITLE( status); Parameters status 32-bit signed integer by reference (optional) Returns the status of the HPSORTTITLE call. If no errors or warnings are encountered, status returns 32 bits of zero. If errors or warnings are encountered, status is interpreted as two 16-bit elds. Bits (0:16) comprise status.info .
HPSWITCHTOCM HPSWITCHTOCM NM callable only. Makes native mode (NM) to compatibility mode (CM) mixed-mode procedure calls possible. Syntax REC I32V I32V RECA HPSWITCHTOCM(proc,method,numparms,parms, I32V RECV I16 I32 fretlen,fretval,condcode,status); Parameters proc record (required) Passes the target CM procedure identi er, which you can specify either by a library to search and an ASCII name of up to 16 characters or by a CM plabel (obtained from the HPLOADCMPROCEDURE or LOADPROC intrinsic).
HPSWITCHTOCM numparms 32-bit signed integer by value (required) parms The number of parameters you are passing to the CM target procedure. array of records (required) fretlen Passes descriptions of each parameter being passed to the CM target procedure. Each parameter is located and described by a record in this array. 32-bit signed integer by value (optional) fretval The length in bytes of the optional functional return value.
HPSWTONMNAME 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 speci ed by the CM caller.
HPSWTONMNAME arglist Passes the number of parameters to be passed to the target NM procedure. It speci es the length of the argdesc array. Account for any hidden parameters (for example, parameters, an extensible parameter list, and so forth). For more information on hidden parameters, refer to the Hewlett-Packard Pascal/XL Reference Manual (31502-90002). 16-bit signed integer array by reference (required) argdesc Passes the actual parameters to be passed in the NM procedure.
HPSWTONMPLABEL 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 speci ed by the CM caller. Syntax U32V I16V I16 I16 status:=HPSWTONMPLABEL(proc,nparms,arglist,argdesc, I16V functype); Functional Return status I32 (assigned functional return) Returns a 32-bit integer indicating the status of the call.
HPSWTONMPLABEL Refer to the Switch Programming Guide (32650-90014) for supported function types. Operation Notes Do not use HPSWTONMPLABEL to invoke a native mode (NM) system supplied intrinsic. The result of the call may be unpredictable. NM code can address the entire CM stack, so there is no copying of reference parameters. The length of each parameter is not required because lengths are implied in the descriptor list.
HPUNLOADCMPROCEDURE HPUNLOADCMPROCEDURE NM callable only. Unloads a target CM procedure whose plabel is obtained through the HPLOADCMPROCEDURE intrinsic. Syntax CA U8V I32 HPUNLOADCMPROCEDURE(procname,library,status); Parameters procname character array (required) library Passes as ASCII procedure name, left-justi ed and padded with blanks. The name can have a maximum of 16 characters. 8-bit unsigned integer by value (required) Passes indicator of the CM segmented library to be searched.
HPUNLOADCMPROCEDURE status 32-bit signed integer by reference (optional) Returns the status of the HPUNLOADCMPROCEDURE intrinsic call. If no errors or warnings are encountered, status returns 32 bits of zero. If errors or warnings are encountered, status is interpreted as two 16-bit elds. Bits (0:16) comprise status.info . A negative value indicates an error condition, and a positive value indicates a warning condition.
HPVOLINFO HPVOLINFO Returns volume information. Up to six items of information can be retrieved. They must be speci ed in pairs (,itemnum, item ) and separated by commas Syntax I32 I16 * HPVOLINFO(status, volspeci ernum, volspeci er I16 * [,itemnum, item][...]); Parameters status 32-bit integer (optional) Returns the status of the HPVOLINFO call. If no errors or warnings are encountered, status returns 32 bits of zero. If errors or warnings are encountered, status is interpreted as two 16-bit elds.
HPVOLINFO The error (negative) / warning (positive) values of status.info that can be returned from a call to HPVOLINFO are given here. Values marked with an asterisk (*) are returned by the MPE/iX version of HPVOLINFO only. Value 0 150 151 152 * -150 -151 -152 -153 -154 -155 -156 -157 -158 -159 -160 -161 -162 -163 -164 -165 -166 -167 -168 4-426 Command Definitions Meaning No errors or warnings (successful call). Array passed in cannot hold all names|list truncated. File label is unreadable.
HPVOLINFO Value -169 -170 -171 -172 -173 -174 -175 -176 -177 -178 -179 -180 * -181 * -182 * -183 * -184 * -185 * -186 * -187 * Meaning Disk I/O error. Virtual memory is only valid on system volumes. Directory size is not valid for speci ed volume. Spool les are valid only on system volumes. Item number is valid only on MPE/iX systems. Item number is valid only on MPE V systems. List length speci ed is invalid. Item number / volume speci er number combination is illegal. Item is not yet implemented.
HPVOLINFO volspeci ernum 16-bit signed integer by value (optional) A 16-bit integer indicating which volume speci er is to be used to obtain information from HPVOLINFO. The default value for volspeci ernum is 0 (zero) if it is not included by the caller. This parameter is used in conjunction with the volspeci er parameter. The following are the valid volume speci er numbers: Value 0 1 2 3 4 5 volspeci er Meaning Volume speci er is ignored.
HPVOLINFO Operation Notes For volspeci ernum of 3 or 4, the volume set name and the volume class or volume name must be separated by a colon: %SET:CLASS% A colon cannot be used as a delimiter. Since a volume set or class can be fully quali ed on MPE V, periods are allowed in the name . Because periods and underscores are allowed in an MPE/iX name, these characters cannot be used as delimiters.
HPVOLINFO For volspeci ernum 4 on MPE/iX, the volume name consists of any string of one to 16 alphanumeric characters, including the underscore and the period. The rst character must be a letter. On MPE V, there is no volume class for the system volume set. In order to access a subset of the system volume set, devices classes are used. On MPE/iX, volume classes exist for both system and nonsystem volume sets. Volume classes take the place of device classes.
HPVOLINFO ON MPE V, a set or class is considered to be logically mounted if all of its members are logically mounted (that is, the LMOUNT or MOUNT command was used). On MPE/iX, if the volume speci er is a set or class, then at least the master volume must be logically mounted (that is, the volume must be in a master or member state).
HPVOLINFO Information Returned INFORMATION RETURNED Disk space used by permanent les, in sectors Disk space used by temporary les, in sectors Drive type File label overhead, in sectors MPE/iX Free space area, largest contiguous, in sectors Free space distribution array Free space distribution, in sectors per range Free space, total, in sectors Logical device number Member volume names, list Member volumes, number of Overhead, directory space, in sectors Overhead, MPE total, in sectors Overhead, transactio
HPVOLINFO Item and Itemnum Pairs All item parameters are passed by reference. 2 Number of volume sets Function = MPE/iX, MPE V: DSTAT Returns the number of system and nonsystem volume sets that are con gured on the system. It returns a 32-bit signed integer containing the number of volumes sets. Zero (0) is the only valid volspeci ernum . May be used with Item =3.
HPVOLINFO 5 List of volume class names Function = MPE/iX:VOLUTIL Returns a list of volume class names. On MPE/iX, the list includes only the names of classes whose members are all logically mounted. The item must be a character array where the list of class names is returned. The rst four bytes of the array are interpreted as a 32-bit integer describing the length of the array. The caller must set this value equal to the maximum number of names that ts into the array being passed.
HPVOLINFO The item must be a character array where the list of member volumes is returned. The rst four bytes of the array are interpreted as a 32-bit integer describing the length of the array. The caller must set this value equal to the maximum number of names that ts into the array being passed. On return, the value has been modi ed to re ect the actual number of names returned. The remaining bytes will be mapped to a list of 32-byte names.
HPVOLINFO 8 Drive type Function = MPE/iX, MPE V: DSTAT Returns the type of the drive speci ed. The drive type refers to the name of the drive (for example: HP7935, HP7937). The character array that is used must be large enough to contain the longest type string, currently 13 characters. 9 Drive sector size Returns the logical sector size of the speci ed drive. This item returns a 32-bit signed integer containing the drive's local sector size in bytes. Currently, this logical size is 256 bytes.
HPVOLINFO When the speci er is 1 or 4, the volume capacity consists of the capacity of the volume whose LDEV or volume name was speci ed. 16 & 17 When the speci er is 2 or 3, the capacity of the volumes that make up the volume set or class are totalled. This total value is returned. Total MPE overhead Returns the total MPE overhead, which consists of everything on a volume that is not set aside for le space use. This is the volume space used for operating system purposes.
HPVOLINFO 20 & 21 When the speci er is 2 or 3, the transient space on the volumes that make up the set or class is returned. Con gured maximum MPE/iX transient space Function = MPE/iX: VOLUTIL command Returns the con gured maximum MPE/iX transient space. These are subsets of items 16 and 17. Item 20 returns a 64-bit signed integer containing the maximum transient space overhead in sectors. Item 21 returns this overhead as a 64-bit real. This is volume overhead that is con gured for transient space use.
HPVOLINFO These are subsets of items 16 and 17. Directory space is area on system and nonsystem volumes reserved for accounting information. It consists of the directory space used for permanent les. When the speci er is 1 or 4, the directory space overhead consists of the directory space on the volume whose LDEV or volume name was speci ed. When the speci er is 2 or 3, the directory space overhead on the volumes that make up the volume set or class is returned.
HPVOLINFO 30 & 31 Spool le disk space usage Function = MPE/iX, MPE V: SHOWOUT Returns the MPE spool le disk space usage. Item 31 returns a 64-bit signed integer containing the spool le disk space usage in sectors. Item 32 returns this usage as a 64-bit real. Spool le space consists of the volume space that is used by hidden spool les. Hidden spool les are not part of the permanent le space. This space can be found only on system volumes that are con gured with the device class SPOOL.
HPVOLINFO The rst value is the number of ranges (minimum 2, maximum 16). The remaining values are the lower bounds for the ranges, in ascending order. On return the rst element is the number of free areas whose size is smaller than the smallest bound speci ed. Each remaining element is the number of free space areas whose size is greater than or equal to the bound, and less than the next larger bound.
HPVOLINFO 42 & 43 When the speci er is 2 or 3, the total free space on the volumes that make up the volume set or class is returned. Largest contiguous free space area Function = MPE/iX: DISCFREE , MPE V: FREE5 Returns the largest contiguous free space area on a volume or a group of volumes. Item 42 returns a 64-bit signed integer containing the largest contiguous free space area in sectors. Item 43 returns a 64-bit real.
HPVOLINFO Variable Conventions Convention Meaning I16 I32 I64 R64 CA I64A R64A ITEM# 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 16-bit signed integer 32-bit signed integer 64-bit signed integer 64-bit signed real Character array 64-bit signed integer array 64-bit signed real array ITEM Number of volume sets List of volume set names Number of volume classnames List of volume class names Number of member volumes List of member volume names Drive type Sector size in bytes Volume type Volume name Volume s
HPVOLINFO ITEM# ITEM TYPE APPLICABLE VOLUME SPECIFIERS 19 MPE/iX transient space overhead in sectors Con gured maximum MPE/iX transient space in sectors Con gured maximum MPE/iX transient space in sectors MPE V virtual memory overhead in sectors MPE V virtual memory overhead in sectors Directory space overhead in sectors Directory space overhead in sectors MPE/iX le label overhead in sectors MPE/iX le label overhead in sectors MPE/iX transaction management overhead MPE/iX transaction management overhe
HPVOLINFO ITEM# ITEM TYPE 39 40 41 42 Free space distribution sectors per range Total free space in sectors Total free space in sectors Largest contiguous free space area in sectors Largest contiguous free space area in sectors R64A I64 R64 I64 43 R64 APPLICABLE VOLUME SPECIFIERS 1, 2, 1, 2, 1, 2, 1, 2, 3, 4 3, 4 3, 4 3, 4 1, 2, 3, 4 Command Definitions 4-445
INITUSLF NM and CM callable. Initializes a bu er corresponding to record 0 of a USL le to the empty state. A USL contains CM object code and is meaningful only in the CM program development process. Note Syntax I16 I16V I16A uslferror:=INITUSLF(uslfnum,record); Functional Return uslferror 16-bit signed integer (assigned functional return) Returns error information. If no error occurs, no value is returned.
INITUSLF Condition Codes CCE (2) CCG (0) CCL (1) Request granted. Not returned. Request denied. An error number is returned to uslferror .
IODONTWAIT NM and CM callable. Initiates completion operations for an I/O request. Syntax I16 I16V UDS I16 U16 fnum:=IODONTWAIT(filenum,bu er,length,cstation) Functional Return fnum 16-bit signed integer (assigned functional return) The le number for which the completion occurred. If no completion occurred, zero is returned. Parameters lenum 16-bit signed integer by value (required) bu er The le number for which there is a pending I/O request.
IODONTWAIT Operation Notes The IODONTWAIT intrinsic operates the same as IOWAIT with one exception: if you call IOWAIT and no I/O has completed, then the calling process is suspended until some I/O completes; if you call IODONTWAIT and no I/O has completed, then control is returned to the calling process. (CCE (2) is returned and the result of IODONTWAIT is zero.) Condition Codes CCE (2) CCG (0) CCL (1) Request granted. If the functional return is not zero, then I/O completion occurred with no errors.
IOWAIT NM and CM callable. Initiates completion operations for an I/O request. Syntax I16 fnum:=IOWAIT( I16V UDS I16 U16 lenum,bu er,length,cstation); Functional Return fnum 16-bit signed integer (assigned functional return) The le number for which the completion occurred. If no completion occurred, zero is returned. Parameters lenum 16-bit signed integer by value (required) bu er The le number for which there is a pending I/O request.
IOWAIT Operation Notes The IOWAIT intrinsic initiates completion operations for an I/O request. If you opened a le with the nowait I/O mode aoption of the FOPEN/HPFOPEN intrinsic (aoption bit (4:1) = 1), calls to either the IOWAIT or IODONTWAIT intrinsic must follow all read and write requests. This intrinsic initiates completion operations for the associated I/O request, including data transfer into your bu er area if necessary.
JOBINFO NM and CM callable. Returns information about any current job or session under your user name and account. If you have su cient capabilities, it returns information about jobs or sessions running under other users and accounts. Syntax I16V I32 U16A JOBINFO(jsind,jsnum,jsstatus I16V * I16 [,itemnum,item,itemerror] [...]); You can specify up to ve itemnum /item /itemerror triples.
JOBINFO jsstatus 16-bit unsigned integer array (required) Returns indicator of the success or failure of the call in a two-element array. The rst element contains the error indicator. The second element should be ignored. Value 0 1 2 3 4 5 Meaning Successful call. All itemerrors equal zero. Partially successful call. One or more itemerror(s) returned with nonzero values. Unsuccessful call. All itemerrors returned with nonzero values. Unsuccessful call. Syntax error in calling sequence.
JOBINFO itemerror 16-bit signed integer by reference (optional) Returns the success or failure of the retrieval of each item. The returned values are: Value 0 1 2 3 4 Meaning Successful Invalid itemnum Information requested not valid for speci ed jsnum Insu cient capability Information not available Table 4-22. JOBINFO Itemnum/Item Values Itemnum Mnemonic 1 CA Item Description [jsname,]user.account.
JOBINFO Table 4-22. JOBINFO Itemnum/Item Values (continued) Itemnum Mnemonic 8 U16 Item Description The date/time that is displayed by the :SHOWJOB command. This date/time is updated whenever a job changes state (SCHED, WAIT, EXEC). Returns a 16-bit unsigned integer to be used by the FMTCALENDAR intrinsic. For a job, this is the date when it enters the WAIT state. 9 CA8 Input LDEV/class name. An ASCII output parameter.
JOBINFO Table 4-22. JOBINFO Itemnum/Item Values (continued) Itemnum Mnemonic 24 U16 Item Description RESTART option. Returns the values: 0 1 25 U16 No Yes Sequenced job. Returns the values: 0 1 26 U16 No Yes Term code. Returns the values: 0 1 Regular terminal Regular terminal with special logon 27 U16 CPU limit 28 U16 Session/job state. Returns the values: 2 4 32 48 56 Executing Suspending Wait Initialization Scheduled 29 U32 User's local attributes 30 I16 $STDIN spool le number.
JOBINFO Table 4-22. JOBINFO Itemnum/Item Values (continued) Itemnum Mnemonic 33 I16 Item Description $STDLIST spool le status. Returns data for current jobs and sessions only. Returns the values: 0 1 2 3 Active Ready Open Reserved 34 I16 Length of itemnum =11 (current job step) 35 U16 SET STDLIST=DELETE invoked. Returns the values: 0 1 $STDLIST is saved SET STDLIST=DELETE is invoked 36 U16 Job information table data segment number 37 N/A Not allowed.
JOBINFO Table 4-22. JOBINFO Itemnum/Item Values (continued) Itemnum Mnemonic 46 U16 Item Description The date/time that the STREAM command was submitted by the job submitter. For jobs, this is the date that the job was streamed (and is the same date that appears in the job submitter banner.) For sessions, this is the date that the session was started via either the STARTSESS command, the STARTSESS intrinsic, or by the default automatic logon at boot time.
KILL KILL NM and CM callable. Deletes a child process of the calling process and all of its descendants. Process handling (PH) capability is required. Syntax I16V KILL(pin); Parameters pin 16-bit signed integer by value (required) Passes the process identi cation number (PIN) of the child process to be deleted. Operation Notes All resources held by the deleted processes are released. Any remaining les opened by the deleted processes are closed and assigned the same disposition they had when opened.
LOADPROC NM and CM callable. Dynamically loads a compatibility mode (CM) segmented library (SL) procedure and any external procedures it has referenced. Syntax I16 CA I16V I16 idnum:=LOADPROC(procname,library,plabel); Functional Return idnum 16-bit signed integer (assigned functional return) Returns an identity number required by the UNLOADPROC intrinsic to unload the CM SL procedure dynamically.
LOADPROC Condition Codes CCE (2) CCG (0) CCL (1) Request granted. Not returned. Request denied. The value returned to idnum is a CM loader error code.
LOCKGLORIN NM and CM callable. Locks a global resource identi cation number (RIN). Multiple RIN (MR) capability is required to lock more than one global RIN simultaneously. Syntax I16V U16 LOCKGLORIN( rinnum,lock CA ag,rinpassword); Parameters rinnum 16-bit signed integer by value (required) lock ag Passes the RIN of the resource to be locked. This is the RIN furnished in the GETRIN command.
LOCKGLORIN The following condition codes are possible if lock ag bit (15:1)=0: CCE (2) Request granted. If the calling process has already locked the RIN, lock ag bit (15:1) is set to 0. If the RIN is free, lock ag bit (15:1) is set to 1. CCG (0) Request denied. The RIN was locked by another job. CCL (1) Request denied because of invalid RIN. Either rinnum is not a global RIN, or the value is out of bounds for the RIN table.
LOCKLOCRIN NM and CM callable. Locks a local resource identi cation number (RIN). Syntax I16V U16 LOCKLOCRIN( rinnum,lock ag); Parameters rinnum 16-bit signed integer by value (required) lock ag A previously allocated local RIN; valid values range from 1 to the value speci ed in the rincount parameter of the GETLOCRIN intrinsic. 16-bit unsigned integer by reference (required) Passes and returns conditional or unconditional RIN locking speci cation through bit (15:1).
LOCKLOCRIN Condition Codes The following condition codes are possible if lock ag bit (15:1)=1: CCE (2) Request granted. If the calling process has already locked the RIN, lock ag bit (15:1) is set to 1. If the RIN is free, lock ag bit (15:1) is set to 0. CCG (0) Not returned. CCL (1) Request denied. The RIN is invalid; the rinnum was too large, no local RIN was allocated, or rinnum speci ed a number less than or equal to zero.
LOCRINOWNER NM and CM callable. Determines process identi cation number (PIN) of the process that locked a local resource identi cation number (RIN). Syntax I16 I16V pin:=LOCRINOWNER(rinnum); Functional Return pin 16-bit signed integer (assigned functional return) If the RIN is locked by the parent of the calling process, LOCRINOWNER returns 0. If the RIN is locked by any other process in your process structure, LOCRINOWNER returns the PIN of that process.
LOCRINOWNER Related Information Intrinsics Commands Manuals None None Resource Management Programmer's Guide (32650-90024).
LOGINFO NM and CM callable. Provides information about an opened user logging le (whole le set). User logging (LG) or system supervisor (OP) capability is required. Syntax I32V I16 I16V * LOGINFO (index,logstatus [,itemnum,item] [...]; You can specify up to four itemnum/item pairs. Note Parameters index 32-bit signed integer by value (required) logstatus Passes your access to the user logging system. This is the value returned in the index parameter of the OPENLOG intrinsic.
LOGINFO Table 4-23.
LOGSTATUS NM and CM callable. Provides information about a currently opened user logging le. User logging (LG) or system supervisor (OP) capability is required. Syntax I32 U16A I16 LOGSTATUS(index,loginfo,logstatus); Parameters index 32-bit signed integer by reference (required) loginfo Passes your access to the user logging system. This is the value returned in the index parameter of the OPENLOG intrinsic.
LOGSTATUS Related Information Intrinsics Commands Manuals None SHOWLOGSTATUS User Logging Programmer's Guide (32650-90027) Command Definitions 4-471
MAIL NM and CM callable. Determines the status of the mailbox used by its parent or child. Process handling (PH) capability is required. Syntax U16 I16V I16 mailstatus:=MAIL(pin,length); Functional Return mailstatus 16-bit unsigned integer (assigned functional return) Returns the status of the mailbox: Value 0 1 2 3 4 Meaning Mailbox empty. Contains previous outgoing mail from this calling process that the destination process has not yet collected.
MAIL Operation Notes If the mailbox contains mail that is awaiting collection by this process, the length of this message (in half words) is returned to the calling process in the length parameter. This enables the calling process to initialize its stack in preparation for receipt of the message. Condition Codes CCE (2) CCG (0) CCL (1) Request granted. The mailbox mailstatus was tested. Request denied. An illegal pin parameter was speci ed.
MERGEEND NM and CM callable. Restores the data stack to its original state and ends the merging operation. Syntax MERGEEND; Condition Codes CCE (2) CCG (0) CCL (1) Request granted. No error occurred during the MERGE program. Not returned. Request denied. An error occurred during the MERGE program. Operation Notes Call this intrinsic only if the MERGEINIT intrinsic was called.
MERGEERRORMESS 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. Syntax I16V CA I16 MERGEERRORMESS(errorcode,message,length); Parameters errorcode 16-bit signed integer by value message Returns the error number from the MERGEINIT errorparm parameter. character array length Returns the text of the error message. This parameter must be at least 80 characters long.
MERGEINIT NM and CM callable. Initializes the MERGE/XL subsystem and the merging of two or more sorted les. Syntax I16A PROC I16A MERGEINIT(input les,preprocessor,output les, PROC I16V I16V I16A postprocessor,keysonly,numkeys,keys, I16A PROC PROC I16A I16 altseq,keycompare,errorproc,statistics,failure, I16 I16 I16A errorparm,spaceallocation,charseq); Parameters input les 16-bit signed integer array (optional) preprocessor Passes the le identi cation numbers of the input les to be merged.
MERGEINIT keysonly 16-bit signed integer by value (optional) Passes a ag that determines if only keys are sent as output. If true, the key elds are concatenated together with the major key on the left and the remaining keys following. If false, the entire record is sent as output. numkeys Default: false. 16-bit signed integer (optional) keys Passes the number of keys used during the comparison of records. This parameter can be either equal to or greater than one.
MERGEINIT Value 7 8 9 11 12 Meaning Display leading sign separate Display trailing sign separate Character (using the collating sequence of charseq ) Short oating-point decimal Floating-point decimal Note The integrity of the keys array must be maintained throughout the MERGE operation. Do not change it until after you have called the MERGEEND intrinsic. altseq 16-bit signed integer array (optional) Passes an alternate collating sequence.
MERGEINIT statistics 16-bit signed integer array (optional) Returns information on the MERGE operation, as follows: Value 1 2,3 4 5,6 7,8 9,10 Meaning Number of input les Number of merged records (32-bit integer) Space available for merging Number of comparisons (32-bit integer) CPU time in milliseconds (32-bit integer) Elapsed time in milliseconds (32-bit integer) failure 16-bit signed integer (optional) errorparm Returns a true value (-1) if a fatal error occurs; otherwise failure returns a fals
MERGEINIT Condition Codes CCE (2) CCG (0) CCL (1) Request granted. No error occurred during the MERGE program. The value of the failure parameter of the MERGEINIT intrinsic is set to false. Not returned. Request denied. An error occurred during the MERGE program. The value of the failure parameter of the MERGEINIT intrinsic is set to true.
MERGEOUTPUT MERGEOUTPUT NM and CM callable. Provides an alternative method of specifying how records are output from the MERGE program. Syntax CA I16 MERGEOUTPUT(record,length); Parameters record 16-bit character array length Returns the next output record. 16-bit signed integer Returns the length of the record parameter value. Operation Notes MERGEOUTPUT requests records from MERGEINIT, one at a time, if the output les parameter in the call to the MERGEINIT intrinsic was not speci ed.
MERGESTAT NM and CM callable. Prints the MERGE program statistics on $STDLIST. Syntax I16A MERGESTAT(statistics); Parameters statistics 16-bit signed integer array Returns MERGE program statistics, such as the number of input les, the number of records, the space available, the number of compares, the CPU time in minutes, and the elapsed time in minutes. Operation Notes Call MERGESTAT after you have called the MERGEEND intrinsic.
MERGETITLE 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. Syntax MERGETITLE; Operation Notes MERGETITLE can be called from a program any time after the system intrinsics have been declared. Related Information Intrinsics Commands Manuals HPSORT, HPMERGE None SORT-MERGE/XL Programmer's Guide (32650-90080).
MYCOMMAND NM and CM callable (di erence noted below). Parses (delineates and de nes) parameters for a user-de ned command image. Syntax I16 CA CA entrynum:=MYCOMMAND(cmdimage,delimiters, I16V I16 CA @* I32A maxparms,numparms,params, dictionar,de nition); Functional Return entrynum 16-bit signed integer (assigned functional return) Returns the command entry number. If the dictionary parameter is not speci ed, 0 is returned.
MYCOMMAND numparms params Passes the maximum number of parameters expected in cmdimage. Accepts values from 0 to 8192. 16-bit signed integer by reference (required) Returns the number of parameters found in cmdimage. 32-bit signed integer array (required) Returns an array of maxparms entries. Numparms entries are returned that delineate the parameters. Each entry consists of two 32-bit words.
MYCOMMAND Bits Value/Meaning 25:1 Numeric character indicator: 24:1 0 The parameter does not contain numeric characters. 1 The parameter contains numeric characters. Alphabetic characters indicator: 16:8 0:16 dictionary 0 The parameter does not contain alphabetic characters. 1 The parameter contains alphabetic characters. The length of the parameter in bytes. This value is zero if you omit the parameter. Always zero.
MYCOMMAND Operation Notes The MYCOMMAND intrinsic analyzes the command string, identifying the location and characteristics of each parameter. If the dictionary is speci ed, the rst parameter is considered a command name. The array speci ed in dictionary is searched for the command name. This dictionary is specially formatted as a SEARCH intrinsic array. (Refer to the SEARCH intrinsic for the format of the array.) The entry number for the match is returned in entrynum .
NLAPPEND NM and CM callable. Appends a language ID number to a le name that allows an application to designate which language-dependent le to use. Syntax CA I16V U16A NLAPPEND(formaldesig,langnum,error); Parameters formaldesig character array (required) langnum Passes and returns a formal le designator. When passed, the le name must end with three blanks. When returned, the language ID has been appended to the name.
NLCOLLATE NLCOLLATE NM and CM callable. Collates two character strings according to the speci ed language collating sequence and determines a lexical ordering. Syntax CA CA I16V I16 NLCOLLATE(bu er1,bu er2,bu erlength,result, I16V U16A U16A langnum,error,collseq); Parameters bu er1 character array (required) bu er2 Passes the rst character string to be collated. character array (required) bu erlength Passes the second character string to be collated.
NLCOLLATE error 16-bit unsigned integer array (required) Returns two elements: the rst element is the error number; the second element is reserved and always returns 0. The possible error number values are: Value 0 1 2 3 4 5 6 Meaning Successful *NLS not installed *Speci ed language not con gured Invalid collating table entry Invalid bu erlength parameter *NLS internal error *NLS internal error * Do not apply to calls with a langnum equal to 0 (NATIVE3000/XL).
NLCOLLATE2 NLCOLLATE2 NM callable. Collates two character strings according to the speci ed language collating sequence and determines a lexical ordering. Designed to be used with a COBOL program.
NLCOLLATE2 error 16-bit unsigned integer array (required) Returns two elements: the rst element is the error number; the second element is reserved and always returns 0. The possible error number values are: Value 0 1 2 3 4 5 6 Meaning Successful *NLS not installed *Speci ed language not con gured Invalid collating table entry Invalid bu erlength parameter *NLS internal error *NLS internal error * Do not apply to calls with a langnum equal to 0 (NATIVE3000/XL).
NLCONVCLOCK 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.
NLCONVCLOCK error 16-bit unsigned integer array (required) Returns two elements: the rst element is the error number; the second element is reserved and always returns 0. The possible error number values are: Value 0 1 2 3 4 5 6 Meaning Successful *NLS not installed *Speci ed language not con gured Invalid time string Invalid length *NLS internal error *NLS internal error * Do not apply to calls with a langnum equal to 0 (NATIVE3000/XL).
NLCONVCUSTDATE 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.
NLCONVCUSTDATE error 16-bit unsigned integer array (required) Returns two elements: the rst element is the error number; the second element is reserved and always returns 0.
NLCONVNUM 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.
NLCONVNUM error 16-bit unsigned integer by value (required) Returns two elements: the rst element is the error number; the second element is reserved and always returns 0.
NLCONVNUM fmtmask 16-bit unsigned integer by value (optional) Speci es how to format the number. The default value is 0 and indicates substitution only.
NLFINDSTR NM and CM callable. Searches string1 for string2, and returns an integer value indicating the o set in string1 where string2 was found. Syntax I16 I16V CA I16V CA o set:=NLFINDSTR(langnum,string1,length1,string2, I16V U16A U16A length2,error,charset); Functional Return o set 16-bit signed integer (assigned functional return) Returns a -1 if string2 is not found in string1. Parameters langnum 16-bit signed integer by value (required) string1 Contains the language ID number.
NLFINDSTR error 16-bit unsigned integer array (required) Returns two elements: the rst element is the error number; the second element is reserved and always returns 0. The possible error number values are: Value 0 1 2 3 4 5 6 charset Meaning Successful *NLS not installed *Speci ed language not con gured Invalid length1 parameter Invalid length2 parameter *NLS internal error *NLS internal error * Do not apply to calls with langnum equal to 0 (NATIVE3000/XL).
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.
NLFMTCALENDAR error 16-bit unsigned integer array (required) Returns two elements: the rst element is the error number; the second element is reserved and always returns 0. The possible error number values are: Value 0 1 2 3 5 6 Meaning Successful *NLS not installed *Speci ed language not con gured Invalid date value *NLS internal error *NLS internal error * Do not apply to calls with a langnum equal to 0 (NATIVE3000/XL).
NLFMTCLOCK NM and CM callable. Formats the time of day, in the speci ed language, obtained with the CLOCK intrinsic. Syntax I32V CA I16V U16A NLFMTCLOCK( time,bu er,langnum,error); Parameters time 32-bit signed integer by value (required) Contains the time format returned by the CLOCK intrinsic: Bits 24:8 16:8 8:8 0:8 Value/Meaning Tenths of seconds Seconds Minute of hour Hour of day bu er character array (required) langnum Returns the formatted time of day in an 8-character array.
NLFMTCLOCK error 16-bit unsigned integer array (required) Returns two elements: the rst element is the error number; the second element is reserved and always returns 0. The possible error number values are: Value 0 1 2 3 4 5 6 Meaning Successful *NLS not installed *Speci ed language not con gured Invalid time format *NLS internal error *NLS internal error *NLS internal error * Do not apply to calls with a langnum equal to 0 (NATIVE3000/XL).
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.
NLFMTCUSTDATE error 16-bit unsigned integer array (required) Returns two elements: the rst element is the error number; the second element is reserved and always returns 0. The possible error number values are: Value 0 1 2 3 5 6 Meaning Successful *NLS not installed *Speci ed language not con gured Invalid date value *NLS internal error *NLS internal error * Do not apply to calls with a langnum equal to 0 (NATIVE3000/XL).
NLFMTDATE NM and CM callable. Formats the date and time according to language-dependent templates returned by itemnum s 1 and 3 of the NLINFO intrinsic.
NLFMTDATE error 16-bit unsigned integer array (required) Returns two elements: the rst element is the error number; the second element is reserved and always returns 0. The possible error number values are: Value 0 1 2 3 4 5 6 Meaning Successful *NLS not installed *Speci ed language not con gured Invalid date value Invalid time value *NLS internal error *NLS internal error * Do not apply to calls with a langnum equal to 0 (NATIVE3000/XL).
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.
NLFMTLONGCAL error logical array (required) Returns two elements: the rst element is the error number; the second element is reserved and always returns 0. The possible error number values are: Value 0 1 2 3 4 5 6 Meaning Successful *NLS not installed *Speci ed language not con gured Invalid date format *NLS internal error *NLS internal error *NLS internal error * Do not apply to calls with a langnum equal to 0 (NATIVE3000/XL). Operation Notes Split-stack calls are not permitted.
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-speci c format using the decimal separator, thousands separator, and currency symbol/name de ned for the native language.
NLFMTNUM error 16-bit unsigned integer array (required) Returns two elements: the rst element is the error number; the second element is reserved and always returns 0.
NLFMTNUM fmtmask 16-bit unsigned integer by value (optional) Contains formatting speci cations for the input. The default value is 0, a simple substitution.
NLFMTNUM Operation Notes Split-stack calls are not permitted. This intrinsic operates in substitution mode and formatting mode: Substitution If fmtmask is omitted or has all bits set to zero, the substitution mode substitutes the native equivalent for "." and ","; for ARABIC, it substitutes mode the alternative set of digits for ASCII digits. The input is not validated as a number and can contain several numbers.
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 con guration. Syntax I16 I16V U16A langnum:=NLGETLANG(langtype,error); Functional Return langnum 16-bit signed integer (assigned functional return) Returns the language ID number of the current user, data, or system. If an error occurs, langnum returns a value of 0 (NATIVE3000/XL).
NLGETLANG error 16-bit unsigned integer array (required) Returns two elements: the rst element is the error number; the second element is reserved and always returns 0.
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 Syntax I16V * I16 U16A NLINFO(itemnum,item,langnum,error); Parameters itemnum 16-bit signed integer by value (required) item Contains the item to be returned. type of variable depends on itemnum (required) langnum Returns information requested or the language name or number requested.
NLINFO error 16-bit unsigned integer array (required) Returns two elements: the rst element is the error number; the second element is reserved and always returns 0.
NLINFO Table 4-24. NLINFO Itemnum/Item Values Itemnum Mnemonic 1 CA Item Description Returns the calendar format in an 18 byte array. The 18 bytes of the string for this de nition are interpreted as the format description for that language.
NLINFO Table 4-24. NLINFO Itemnum/Item Values (continued) Itemnum Mnemonic 2 CA Item Description Returns the custom date format in a 13 byte array. The 13 bytes of the string for this de nition are interpreted as the custom date format description.
NLINFO Table 4-24. NLINFO Itemnum/Item Values (continued) Itemnum Mnemonic Item Description 7 CA Returns the table containing the day of the week in an 84 byte array. Each day is 12 bytes long (with blank padding as needed). The table starts with Sunday. For example, the day name table is: "SUNDAY MONDAY TUESDAY . . . SATURDAY" 8 CA Returns the YES/NO responses in a 12 byte array; the rst 6 bytes contain the (upshifted) YES response; the second 6 bytes contain the (upshifted) NO response.
NLINFO Table 4-24. NLINFO Itemnum/Item Values (continued) Itemnum Mnemonic Item Description 17 U16A Returns the language numbers of all con gured languages. The rst element of this array contains the number of con gured languages. The second element contains the language number of the rst con gured language. The third element contains the language number of the second con gured language, and so forth. (The langnum parameter is disregarded.
NLINFO Table 4-24. NLINFO Itemnum/Item Values (continued) Itemnum Mnemonic 30 CA Item Description A 36 byte array where the long calendar format is returned. It can contain arbitrary text and the following descriptors: D 1-3 of these are replaced by an equal number of bytes from the day abbreviation. W 1-12 of these are replaced by an equal number of bytes from the day of week. dd Numeric day of month. M 1-4 of these are replaced by an equal number of bytes from the month abbreviation.
NLINFO Table 4-24. NLINFO Itemnum/Item Values (continued) Itemnum Mnemonic 33 34 35 36 CA U16 U16 U16 Item Description A 4 byte array containing information about the direction of the language. 0-1 Language direction (integer) 0 - Direction is left-to-right 1 - Direction is right-to-left 2 The right-to-left space 3 Unde ned A logical value that returns the data ordering of the language.
NLJUDGE NM and CM callable. Judges whether a character is a 1 byte or 2 byte Asian character. Syntax I16V I16V CA I16V n2bytes:=NLJUDGE(langnum,instring,stringlength, CA U16A U16A ags,error,charset); Functional Return n2bytes 16-bit signed integer (assigned functional return) Contains the number of 2 byte Asian characters in a 16-bit signed integer value that can be used to check a string of characters for Asian characters.
NLJUDGE error 16-bit unsigned integer array (required) Returns two elements: the rst element is the error number; the second element is reserved and always returns 0. The possible error number values are: Value 0 1 2 3 4 5 6 7 Meaning Successful *NLS not installed *Speci ed language is not con gured Invalid string length Not returned *NLS internal error *NLS internal error *Invalid characters found in instring * Do not apply to calls with langnum equal to 0 (NATIVE-3000).
NLKEYCOMPARE NM and CM callable. Compares two strings of di erent length (for use with KSAM generic key searching). Syntax CA I16V CA I16V NLKEYCOMPARE(generickey,length1,key,length2, I16 I16V U16A U16A result,langnum,error,collseq); Parameters generickey character array (required) length1 Passes the generic key to be compared to the keys contained in the record read by FREAD.
NLKEYCOMPARE Value 0 1 2 3 Meaning The retrieved key matches the generic key exactly for a length of length . The retrieved key does not match the generic key; it is di erent only because of priority (for example, uppercase versus lowercase characters or accent). The FREAD key is still in range; records can follow whichever key matches the generic key exactly. The retrieved key is less than the generic key (its collating order precedes the key speci ed). It does not match generickey .
NLKEYCOMPARE Operation Notes Use NLKEYCOMPARE when reading a KSAM le in key sequential order in combination with FREAD, and after a FFINDBYKEY call. The NLKEYCOMPARE intrinsic lets a program determine whether a generic key search found an exact match (that is, the generic key is exactly equal to the beginning of the key), or whether the keys are di erent only because of priority (for example, uppercase versus lowercase or accent).
NLMATCH NLMATCH Compares a string against a pattern which has previously been compiled with the NLMATCHINIT intrinsic. Syntax I result := NLMATCH(comp BA BA IV pattern,string,length); Functional Return Zero is returned in result if the string matches the compiled comp match, the mismatch location is returned. result pattern.
NLMATCHINIT Compiles a pattern into a form for use with the NLMATCH intrinsic. Syntax I BA I := NLMATCHINIT( pattern,pattern IV BA I langid,comp pattern,comp buf size); result len, Functional Return Zero is returned if the compilation of pattern is successful. Otherwise theresult contains the error code.
NLMATCHINIT Other metacharacter indicate choice, grouping, and ranges: Char ! , : fg [] + * Operation Transparency Choice Range Grouping Optional Repetition (one or more) Repetition (zero or more) Pattern operators are evaluated in the following order, where x and y are any character for the language: Char Example ! Transparency !x : Range x:y Repetition (1/0 or more) x+ or x* Concatenation xy Choice x,y +/* , pattern len langid comp Operation The repetition, concatenation, and choice
NLMATCHINIT Operation Notes NLMATCHINIT converts the regular expression in pattern to a reduced, nite state machine and places it in comp pattern, wherepattern len is the expression's length in bytes, andcomp buf size is the maximum size of the comp pattern in bytes. If comp buf size is 0 (zero), only a syntax check of pattern is performed and no comp pattern will be generated. If NLMATCHINIT returns 0 (zero), the compilation of pattern succeeded.
NLNUMSPEC 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.
NLNUMSPEC Byte(s) Meaning error 16-17 Currency place (integer) 18-19 20-37 38-59 0 Currency symbol 1 Currency symbol succeeds the number 2 Currency symbol replaces the decimal separator 3 Currency symbol precedes the sign Length of currency symbol (integer), includes spaces Currency symbol, includes spaces Reserved for the operating system 16-bit unsigned integer array (required) Returns two elements: the rst element is the error number; the second element is reserved and always returns 0.
NLREPCHAR NLREPCHAR NM and CM callable. Replaces all nondisplayable control characters in the string with the replacement character. Nondisplayable characters are those with attribute 3 (unde ned graphic character) or 5 (control code), as returned by itemnum =12 of the NLINFO intrinsic.
NLREPCHAR error 16-bit unsigned integer array (required) Returns two elements: the rst element is the error number; the second element is reserved and always returns 0.
NLSCANMOVE NLSCANMOVE NM and CM callable. Scans and moves character strings according to character attributes. This function is handled in a language-dependent manner. Syntax I16 CA numchar:=NLSCANMOVE( inbu CA U16V er,outbu er, ags, I16V I16V U16A bu erlength,langnum,error, U16A CA charset,shiftinfo); Functional Return numchar 16-bit signed integer (assigned functional return) Contains the number of characters acted upon in the scan or move function.
NLSCANMOVE ags 16-bit unsigned integer by value (required) Contains the ag de ning the options for calling the intrinsic and de nes the condition for terminating the scan or move function.
NLSCANMOVE error 16-bit unsigned integer array (required) Returns two elements: the rst element is the error number; the second element is reserved and always returns 0.
NLSUBSTR NM and CM callable. Extracts movelength bytes from the instring to the outstring. Syntax CA I16V CA I16 NLSUBSTR(instring,inlength,outstring,outlength, I16V 16V I16V startposition,movelength,langnum, I16V U16A U16A ags,error,charset); Parameters instring character array (required) inlength Contains the string from which the substring is extracted. The string can contain both 1 byte and 2 byte Asian characters.
NLSUBSTR ags 16-bit signed integer by value (required) Contains the ag word, and is used primarily with Asian languages. It is meaningless with 1 byte languages.
NLSUBSTR error 16-bit unsigned integer array (required) Returns two elements: the rst element is the error number; the second element is reserved and always returns 0.
NLSWITCHBUF NLSWITCHBUF NM and CM callable. Converts a string of characters from phonetic order to screen order or from screen order to phonetic order. Syntax I16V CA CA NLSWITCHBUF(langnum,instring,outstring, I16V U16V U16A stringlength,left-to-right,error); Parameters langnum 16-bit signed integer by value (required) instring Contains the language ID number. character array (required) outstring Contains the string, in phonetic order, to be converted to screen order.
NLSWITCHBUF error 16-bit unsigned integer array (required) Returns two elements: the rst element is the error number; the second element is reserved and always returns 0. The possible error number values are: Value 0 1 2 3 4 5 6 Meaning Successful *NLS not installed *Speci ed language not installed Invalid string length Not returned *NLS internal error *NLS internal error * Do not apply to calls with langnum equal to 0 (NATIVE3000/XL).
NLSWITCHBUF Related Information Intrinsics Commands Manuals NLCOLLATE, NLKEYCOMPARE, NLREPCHAR, NLSTRANSLATE, NLSUBSTR None Native Language Programmer's Guide (32650-90022) Command Definitions 4-547
NLTRANSLATE NM and CM callable. Translates a string of characters from EBCDIC-to-ASCII or ASCII-to-EBCDIC using the appropriate native language table.
NLTRANSLATE error 16-bit unsigned integer array (required) Returns two elements: the rst element is the error number; the second element is reserved and always returns 0. The possible error number values are: Value 0 1 2 3 4 5 6 Meaning Successful *NLS not installed *Speci ed language not con gured Invalid transcode speci ed Invalid length parameter *NLS internal error *NLS internal error * Do not apply to calls with a langnum equal to 0 (NATIVE3000/XL).
NLTRANSLATE OPENLOG NM and CM callable. Provides access to the user logging facility. User logging (LG) or system supervisor (OP) capability is required. Syntax I32 CA CA I16 I16 OPENLOG(index,logid,pass,mode,logstatus); Parameters index 32-bit signed integer by reference (required) logid Returns the user logging access. The User Logging facility uses the value of the index parameter to check the validity of subsequent calls to the other user logging intrinsics.
OPENLOG logstatus 16-bit signed integer by reference (required) Returns one of the following values, indicating the success/failure of the call: Value 0 1 2 3 5 6 7 8 9 12 13 15 16 Meaning Successful Nowait mode requested; user logging process busy Parameter out of bounds Request to open or write to a user logging process not running Incorrect mode parameter passed Request denied; user logging process suspended Illegal capability; user logging (LG) or system supervisor (OP) capability required Incorrec
PAUSE NM and CM callable. Suspends the calling process for a speci ed number of seconds. Syntax 32R PAUSE(interval); Parameters interval 32-bit real by reference (required) Passes the amount of time, in seconds, that the process pauses. The value of interval must be positive. The maximum time allowed is approximately 2,147,484 seconds (almost 25 days). Operation Notes BREAK or RESUME takes place without a ecting the time countdown process. Y causes the timer to countdown to restart at the beginning.
PRINT PRINT NM and CM callable. Prints character string on job/session listing device. Syntax CA I16V I16V PRINT(message,length,controlcode); Parameters message character array (required) length Passes the string of ASCII characters to $STDLIST. 16-bit signed integer by value (required) controlcode Returns the length of the character string to be passed in message. If length is positive, the length is in half words; if negative, the length is in bytes.
PRINTFILEINFO NM and CM callable. Prints a le information display on the job/session list device. Syntax PRINTFILEINFO( I16V lenum); Parameters lenum 16-bit signed integer by value (required) Passes the le number of the le to be displayed. Operation Notes Hierarchical directories and les can be opened using FOPEN or HPOPEN intrinsic. PRINTFILEINFO is used to display le information for any type of directory or le.
PRINTOP PRINTOP NM and CM callable. Prints a character string on the system console. Syntax CA I16V I16V PRINTOP(message,length,controlcode); Parameters message character array (required) length Passes the character string to be output. The string is limited to 72 characters, additional characters are ignored. Nonvideo-enhancing escape sequences are stripped out. 16-bit signed integer by value (required) controlcode Passes the length of the output string to be transmitted.
PRINTOP Related Information Intrinsics Commands Manuals 4-556 None None Accessing Files Programmer's Guide (32650-90017) Command Definitions
PRINTOPREPLY PRINTOPREPLY NM and CM callable. Prints a character string on the system console and solicits a reply. Syntax I16 CA I16V I16V length:=PRINTOPREPLY(message,length,zero, CA I16V reply,maxlength); Functional Return length 16-bit signed integer (assigned functional return) Passes the length of the reply from the system operator. This length represents a half word count if maxlength is positive or a byte count if maxlength is negative.
PRINTOPREPLY maxlength 16-bit signed integer by value (required) The maximum length of the message to be read into the reply parameter. If the expected length is positive, it speci es a half word count; if negative, it speci es a byte count. Do not specify a length of >31 bytes. Condition Codes CCE (2) CCG (0) CCL (1) Request granted. Not returned. Request denied. A physical I/O error occurred. Further error analysis through the FCHECK intrinsic is not possible.
PROCINFO PROCINFO NM and CM callable. Provides access to process information. Syntax I16 I16 I16V PROCINFO(infoerror1,infoerror2,pin I16V * [,itemnum1,item1] [...] [,itemnum6,item6]); Note You can specify up to six itemnum,item pairs. Parameters error1 16-bit signed integer by reference (required) error2 Returns a value indicating the success or failure of the intrinsic call. Refer to Table 4-25.
PROCINFO Table 4-25.
PROCINFO Table 4-26. PROCINFO Itemnum/Item Values Itemnum Mnemonic Item Description 1 I16 Process identi cation number (PIN) of calling process 2 I16 Process identi cation number (PIN) of the parent of the process speci ed by pin . If the calling process is executing in privileged mode, requests for information are honored for any process. Otherwise, requests are honored as follows: 1. Complete information is returned for children of the calling process. 2.
PROCINFO Table 4-26. PROCINFO Itemnum/Item Values (continued) Itemnum Mnemonic 6 I16A Item Description Process identi cation numbers (PINs) of all children of the process speci ed by pin . A variable number of PINs are returned; item must be a 16-bit signed integer array. The rst element of the array must be set by the calling process to indicate the array size. The array size should include the array size element (for example, for four PINs, the rst entry that contains the array size should be 5).
PROCINFO Table 4-26. PROCINFO Itemnum/Item Values (continued) Itemnum Mnemonic 10 CA Item Description Program name that the process speci ed by pin is currently executing. The character array for the program name must be a minimum of 28 bytes long. The name is returned in the form le.group.account , where le is the local le name, group is the group name, and account is the account name of the le containing the program that the speci ed process is currently executing.
PROCINFO Condition Codes CCE (2) CCG (0) CCL (1) Request granted. Error1 and error2 return zero. Not returned. Request denied. Error codes set and returned in error1 and error2.
PROCTIME PROCTIME NM and CM callable. Returns the accumulated CPU time for a process. Syntax I32 time:=PROCTIME; Functional Return time 32-bit signed integer (assigned functional return) Returns the number of milliseconds that the process has been running.
PUTJCW NM and CM callable. Assigns the value of a particular job control word (JCW) in the job control word table. Syntax CA U16 I16 PUTJCW(jcwname,jcwvalue,jcwstatus); Parameters jcwname character array (required) jcwvalue Passes the name of the JCW. This array can contain up to 255 characters, beginning with a letter and ending with a nonalphanumeric character, such as a blank. An @ causes all executing JCWs to be set to jcwvalue.
PUTJCW An attempt to assign a value to a system-reserved JCW results in an error.
QUIT NM and CM callable. Aborts the calling process. Syntax I16V QUIT(num); Parameters num 16-bit signed integer by value (required) Passes any integer value in the range -32767 to 32768. When executed, num is output as part of the abort message, as follows: ABORT: PIN = pin: by QUIT; PARM = num PROGRAM TERMINATED IN AN ERROR STATE Operation Notes Aborts the calling process by: Transmitting an abort message to the list device of the calling process.
QUITPROG QUITPROG NM and CM callable. Aborts the entire user process structure. Syntax I16V QUITPROG(num); Parameters num 16-bit signed integer by value (required) Passes any integer value in the range 0..16383. When executed, num is output as part of the abort message. Operation Notes Aborts the entire user process structure (all children of the job/session main process) by: Transmitting an abort message to the list device of the job/session main process.
READ NM and CM callable. Reads an ASCII string from $STDIN into an array. Syntax I16 CA I16V length:=READ(message,msglength); Functional Return length 16-bit signed integer (assigned functional return) The length of the ASCII string that was read. If msglength is positive, the length speci ed is in half words; if negative, the length speci ed is in bytes. Parameters message character array (required) msglength Returns the ASCII characters that were read.
READ READ interprets the following to be end-of- le (EOF) markers when they begin in the st column of a record: For sessions, a colon (:). For jobs, a colon (:) or the actual EOF. When one of these indicators are encountered, CCG (0) is returned and no transfer occurs. If $STDIN is redirected, only the le's actual EOF is interpreted as the valid EOF indicator. Condition Codes CCE (2) CCG (0) CCL (1) Request granted. Request granted.
READX NM and CM callable. Reads an ASCII string from $STDINX into an array. Syntax I16 CA I16V length:=READX(message,msglength); Functional Return length 16-bit signed integer (assigned functional return) The length of the ASCII string that was read. If msglength is positive, the length speci ed is in half words; if negative, the length speci ed is in bytes. Parameters message character array (required) msglength Returns the ASCII characters that were read.
READX Operation Notes The READX intrinsic reads an ASCII string from $STDINX into an array. This is similar to calling the FREAD intrinsic against the le $STDINX. However, the READX intrinsic is limited in its usefulness in that the full capability of the le system is not available to you. For example, FILE commands are not allowed.
RECEIVEMAIL NM and CM callable. Receives mail from another process. Process handling (PH) capability is required. Syntax U16 I16V UDS U16V mailstatus:=RECEIVEMAIL(pin,location,wait ag); Functional Return mailstatus 16-bit unsigned integer (assigned functional return) Returns one of the following values: Value 0 1 2 3 4 Meaning Mailbox empty and wait ag bit (15:1)=0. No message collected, the mailbox contained outgoing mail from the receiving process. Message collected successfully.
RECEIVEMAIL wait ag 16-bit unsigned integer by value (required) The action to be taken if the mailbox is empty. This is determined by the setting of bit (15:1), which has the following settings: Value 0 1 Meaning Return immediately to the calling process. Wait until incoming mail is ready for collection. Operation Notes The RECEIVEMAIL intrinsic lets a process collect mail transmitted to it by its parent or a child.
RESETCONTROL NM and CM callable. Reenables the subsystem break trap which allows a process to accept other subsystem break signals. Syntax RESETCONTROL; Operation Notes RESETCONTROL must be called to reenable the subsystem break trap after a user-written subsystem break trap handler, previously armed by XCONTRAP, has been invoked. It is recommended that RESETCONTROL be called from outside the user-written trap handler to eliminate recursive trap handler calls, due to multiple subsystem break signals.
RESETDUMP RESETDUMP NM and CM callable. Disables the abort stack analysis facility. Only the current process is a ected. Syntax RESETDUMP; Condition Codes CCE (2) CCG (0) CCL (1) Request granted. The abort stack analysis facility was disabled prior to the RESETDUMP call and remains disabled. Not returned.
SEARCH NM and CM callable (di erences noted below). Searches a specially-formatted array for a speci ed entry or name. Syntax I16 CA entrynum:=SEARCH(bu I16V CA er,length,dictionary, @* de nition); Functional Return entrynum 16-bit signed integer (assigned functional return) Returns the entry number of the name in dictionary that matches bu the name speci ed in bu er is not found, a zero is returned. er.
SEARCH The last entry in the array is a zero, specifying the end of the array as an entry of zero length. The following model creates an array to expand abbreviated input (name) to its appropriate command (de nition). 5,1,"I","IN", 6,1,"O","OUT", 7,1,"S","SKIP", 7,1,"E","EXIT", 0; In this model, the rst entry speci es that the entry's length is ve bytes. The name (\I") is one byte and its de nition is \IN". A 1 is returned in the entrynum signifying that the matching name was the rst entry in the array.
SENDMAIL NM and CM callable. Sends mail to another process. Process handling (PH) capability is required. Syntax U16 I16V I16V UDS U16V mailstatus:=SENDMAIL(pin,length,location,wait ag); Functional Return mailstatus 16-bit unsigned integer (assigned functional return) Returns one of the following values: Value 0 1 2 3 4 5 6 Meaning Mail transmitted successfully and mailbox contained no previous mail.
SENDMAIL length 16-bit signed integer by value (required) location The length of the message, in half words, transmitted from the stack of the sending process. If 0 is speci ed, the mailbox is emptied of any incoming or outgoing mail. user-de ned structure (required) wait ag The bu er containing the message.
SETDUMP NM and CM callable. Arms a call to the system debugger from a process abort. Syntax SETDUMP( I16V ags); Parameters ags 16-bit unsigned integer (required) This parameter is for backward compatibility with MPE V/E systems only. Any value passed in this parameter is ignored, but a full stack trace is always generated. Operation Notes If the process aborts, Debug is called with a command string that results in a full stack trace of the CM and NM data stacks and a dump of the NM registers.
SETDUMP Related Information Intrinsics Commands Manuals HPRESETDUMP, HPSETDUMP, RESETDUMP, STACKDUMP SETDUMP MPE/iX System Debug Reference Manual (32650-90013) Command Definitions 4-583
SETJCW NM and CM callable. Sets bits in the system job control word (JCW). Syntax U16V SETJCW(jcword); Parameters jcword 16-bit unsigned integer by value (required) The user-de ned bit contents of the system JCW for interprocess communication.
SORTEND SORTEND NM and CM callable. Closes the scratch le and restores the data stack to its original state. Syntax SORTEND; Operation Notes Signals the beginning of the SORT program if the SORTOUTPUT intrinsic is not called. Required if SORTINIT is called. Call SORTEND either after all calls to the output le are completed by the SORTINIT intrinsic, or after all calls to the SORTOUTPUT intrinsic are completed.
SORTERRORMESS NM and CM callable. Retrieves and prints a message if a fatal error occurs during the SORT program. Syntax I16V CA I16 SORTERRORMESS(errorcode,message,length); Parameters errorcode 16-bit signed integer by value message Returns the error number from SORTINIT in the errorparm parameter. character array length Returns the text of the error message. This parameter must be at least 80 characters long. 16-bit signed integer Returns the length of the message parameter.
SORTINIT SORTINIT NM and CM callable. Initiates the SORT program. Syntax I16A I16A I16V SORTINIT(input les,output les,outputoption, I16V I32V I16V I16A reclength,numrecs,numkeys,keys, I16A PROC PROC I16A altseq,keycompare,errorproc,statistics, I16 I16 I16 I16A failure,errorparm,spaceallocation,charseq); Parameters input les 16-bit signed integer array (optional) output les Passes the le identi cation numbers of the input les to be sorted. The last element of this array should be set to zero.
SORTINIT outputoption 16-bit signed integer by value (optional) Passes a value that determines the format of the output records: Value 0 1 2 3 Meaning Output record is the same as the input record (default). Output record is a 32-bit integer whose value is the logical (relative) record number of the record. Output record contains only the key elds, concatenated together with the major keys on the left, followed by the remaining keys. Output record is the logical record number followed by the key elds.
SORTINIT keys 16-bit integer array (optional) Passes information about the keys used during comparison of records. If you specify the keys parameter, you must specify the numkeys parameter and must not specify keycompare . Together, keys and numkeys describe the way records are merged. The rst element gives the position of the rst character of the key within the record. The second element gives the number of characters in the key.
SORTINIT altseq 16-bit signed integer array (optional) Passes an alternate collating sequence.
SORTINIT failure 16-bit signed integer (optional) errorparm Returns a true value (-1) if a fatal error occurs; otherwise returns a false value (0). The value is set after each call to SORTINPUT and SORTOUTPUT. Refer to the discussion of condition codes. 16-bit signed integer (optional) Returns the SORTLIB error number if an error occurs. Use the SORTERRORMESS intrinsic to obtain the error message text.
SORTINPUT NM and CM callable. Provides an alternative method of specifying how records are supplied to the SORT program. Syntax CA I16V SORTINPUT(record,length); Parameters record 16-bit character array length Passes the next input data record. 16-bit signed integer Passes the length of the record parameter value. This value should be long enough to contain all speci ed keys, but not longer than the record size speci ed in the reclen parameter of the SORTINIT intrinsic.
SORTOUTPUT SORTOUTPUT NM and CM callable. Provides an alternative method of specifying how records are output from the SORT program. Syntax CA I16 SORTOUTPUT( record,length); Parameters record 16-bit character array length Returns the next output record. The format of this record is speci ed in the outputoption parameter of the SORTINIT intrinsic. 16-bit signed integer Returns the length of the record parameter value. When no more records remain, the value of this parameter is set to -1.
SORTOUTPUT Related Information Intrinsics Commands Manuals 4-594 HPSORT, HPMERGE None SORT-MERGE/XL Programmer's Guide (32650-90080) Command Definitions
SORTSTAT SORTSTAT NM and CM callable. Prints the SORT program statistics on $STDLIST. Call SORTSTAT after you have called the SORTEND intrinsic. Syntax I16A SORTSTAT(statistics); Parameters statistics 16-bit signed integer array Returns MERGE program statistics, such as the number of records, the number of intermediate passes, the space available in words, the number of compares, the number of scratch le I/O operations, the CPU time in minutes, and the elapsed time in minutes.
SORTTITLE NM and CM callable. Prints the version number and title of the SORTLIB segment on $STDLIST. Syntax SORTTITLE; Operation Notes SORTTITLE prints the date and time from the DATELINE intrinsic. SORTTITLE can be called any time after the system intrinsics are declared.
STACKDUMP STACKDUMP NM and CM callable (di erences noted below). Calls the system debugger to send a stack trace to $STDLIST or to the le speci ed in the formaldesig parameter. Control then returns to the calling procedure. Syntax (NM and CM) CA I16V I16V I32 STACKDUMP(formaldesig,idnumber, ags,selec); (CM: SPL language only) CA I16V I16V I32 STACKDUMP'( formaldesig,idnumber, ags,selec); Parameters formaldesig character array (optional) Passes the le name of a new output le to be opened.
STACKDUMP ags 16-bit unsigned integer by value (optional) This parameter is provided for compatibility with MPE V/E. If it is present, it is ignored and has no e ect. 32-bit integer array by reference (optional) selec This parameter is provided for compatibility with MPE V/E. If it is present in the intrinsic call, it is ignored and has no e ect. Condition Codes CCE (2) CCG (0) CCL (1) Request granted. Request denied. An invalid address for the location of the formaldesig parameter was detected.
STARTSESS STARTSESS NM and CM callable. Initiates a session on the speci ed terminal. Programmatic sessions (PS) capability is required. Syntax I16V CA I16 I32 I16A STARTSESS(ldev,logonstring,jsid,jsnum,jsstatus); Parameters ldev 16-bit signed integer by value (required) The logical device number of the target terminal (the terminal on which the session is to be created). The target terminal must be a real physical device, free and available to the system, job-accepting, and hardwired.
STARTSESS jsnum 32-bit signed integer by reference (required) jsstatus Returns a number uniquely identifying the session that was created on the target terminal. 16-bit signed integer array (required) Returns a two-element array containing status information. The second element is reserved for the operating system. The rst element returns the status information, refer to Table 4-27. Table 4-27.
STARTSESS Table 4-27.
STARTSESS Table 4-27. STARTSESS Status Returns (continued) Status Value Meaning 7025 Unknown error occurred.
STARTSESS Operation Notes The terminal on which the session is to be created must be available; no other user may be logged on. The target terminal is not speed-sensed, so it must be set at the con gured baud rate. When the session is created, nothing is printed to the terminal until you press the 4Return5 key on the selected terminal (unless you specify nowait). To override the need for a 4Return5, you can enter the NOWAIT keyword parameter with the logon string when invoking the STARTSESS intrinsic.
SUSPEND NM and CM callable. Suspends a process. Process handling (PH) capability is required.
SUSPEND Operation Notes When SUSPEND is executed, the calling process relinquishes its access to the CPU until reactivated by an ACTIVATE intrinsic call. The calling process must specify the anticipated source of the ACTIVATE call (its parent or a child process). When the process is reactivated, it begins execution with the instruction immediately following the SUSPEND call. Condition Codes CCE (2) CCG (0) CCL (1) Request granted. Not returned. Request denied.
SWITCHDB CM callable only. Switches the DB register pointer. Privileged mode (PM) capability is required. Syntax U16 O-P U16V logindex:=SWITCHDB(index) Functional Return logindex 16-bit unsigned integer (assigned functional return) Returns the logical index of the data segment indicated by the previous DB register setting, allowing this setting to be restored later. If the previous DB setting indicated the stack, a zero is returned.
TERMINATE TERMINATE NM and CM callable. Releases all resources held by the process and its descendants are released. All remaining les, opened by the process and its descendants, are closed and assigned the same disposition they had when opened.
TIMER NM and CM callable. Returns system timer information. Syntax I32 count:=TIMER; Functional Return count 32-bit signed integer (assigned functional return) The actual millisecond count since the midnight preceding the last system coldload. Operation Notes The resolution of the system timer is one millisecond; readings taken within a one-millisecond period can be identical. The system timer is reset to zero every 24-days at 12:00 midnight.
UNLOADPROC UNLOADPROC NM and CM callable. Dynamically unloads a compatibility mode (CM) segmented library (SL) procedure. Syntax I16V UNLOADPROC( procid); Parameters procid 16-bit signed integer by value (required) Passes the procedure's identity number, which was obtained from the LOADPROC call. Condition Codes CCE (2) CCG (0) CCL (1) Request granted. Not returned. Request denied. An invalid procid was speci ed.
UNLOCKGLORIN NM and CM callable. The UNLOCKGLORIN intrinsic unlocks a global resource identi cation number (RIN) that was locked with the LOCKGLORIN intrinsic. Syntax I16V UNLOCKGLORIN(rinnum); Parameters rinnum 16-bit signed integer by value (required) Passes the number of any RIN locked by the calling process. If rinnum does not specify a RIN locked by the calling process, no action is taken. Condition Codes CCE (2) CCG (0) CCL (1) Request granted. Request denied.
UNLOCKLOCRIN UNLOCKLOCRIN NM and CM callable. The UNLOCKLOCRIN intrinsic unlocks a local resource identi cation number (RIN) that was locked by the LOCKLOCRIN intrinsic. Syntax I16V UNLOCKLOCRIN(rinnum); Parameters rinnum 16-bit signed integer by value (required) Passes the locked RIN, designated by an integer from 1 to the value speci ed in the rincount parameter of the GETLOCRIN intrinsic call. Condition Codes CCE (2) CCG (0) CCL (1) Request granted. Request denied.
WHO NM and CM callable. Returns the access mode and attributes of the user calling the intrinsic. Syntax U16 I32 I32 CA WHO(mode,capability,localattr,username, CA CA CA U16 groupname,acctname,homename,term); Parameters mode 16-bit unsigned integer by reference (optional) Returns the current user's access mode.
WHO capability 32-bit signed integer by reference (optional) Returns the user's le access attributes, user attributes, and capability class attributes if the appropriate bit = 1. The high-order half word indicates le access attributes and user attributes; the low-order half word indicates possession of capability-class attributes.
WHO localattr 32-bit signed integer by reference (optional) username Returns the local attributes of the user, as de ned by a user with the account manager attribute. character array (optional) groupname Returns the user's name in an 8-character array. character array (optional) acctname Returns the name of the user's logon group in an 8-character array. character array (optional) homename Returns the name of the user's logon account in an 8-character array.
WRITELOG WRITELOG NM and CM callable. Writes database and subsystem le records to the user logging le. User logging (LG) or system supervisor (OP) capability is required. Syntax I32 U16A I16 I16 I16 WRITELOG(index,data,length,mode,logstatus); Parameters index 32-bit signed integer by reference (required) data Passes your access to the user logging system. This is the value returned in the index parameter of the OPENLOG intrinsic.
WRITELOG logstatus 16-bit signed integer by reference (required) Returns one of the following values, indicating the success/failure of the call: Value 0 1 2 4 5 9 12 14 15 Meaning Successful Nowait requested, user logging process busy Parameter out of bounds Incorrect index parameter passed Incorrect mode parameter passed Error occurred while writing System out of disk space; user logging cannot proceed Invalid access End-of- le on user log le Related Information Intrinsics Commands Manuals 4-616
XARITRAP XARITRAP NM and CM callable (di erences noted below). Arms or disarms the user-written arithmetic trap handling procedure. Syntax I*V I32V I32 I32 XARITRAP(mask,plabel,oldmask,oldplabel); Note By default, all traps except IEEE oating-point exceptions are enabled, and the system trap handler is armed. Many oating-point operations result in an inexact result. Most compiler libraries doing oating-point operations result in an inexact trap if the IEEE inexact result trap is enabled.
XARITRAP 4-618 Bits Value/Meaning 31:1 30:1 29:1 28:1 27:1 26:1 25:1 24:1 23:1 22:1 21:1 3000 mode oating-point divide by zero Integer divide by zero 3000 mode oating-point under ow 3000 mode oating-point over ow Integer over ow 3000 mode double-precision over ow 3000 mode double-precision under ow 3000 mode double-precision divide by zero Decimal over ow Invalid ASCII digit Invalid decimal digit Command Definitions
XARITRAP Bits Value/Meaning 19:2 18:1 17:1 16:1 15:1 14:1 13:1 12:1 11:1 10:1 9:1 8:1 7:1 1:6 0:1 Reserved for the operating system Decimal divide by zero IEEE oating-point inexact result IEEE oating-point under ow IEEE oating-point over ow IEEE oating-point divide by zero IEEE oating-point invalid operation Range errors Software-detected NIL pointer reference Software-detected misaligned result of pointer arithmetic or error in conversion from long pointer to short pointer Unimplemented condition traps
XARITRAP Note The following apply to the preceding trap conditions represented in the mask: NM supports IEEE and 3000 mode formats. Both execute in NM, but 3000 mode performs Hewlett-Packard 3000 type manipulations. Since it is possible to use both formats during program execution, there are separate bits in the mask for enabling/disabling traps of these formats. Some error conditions speci ed here are not strictly arithmetic traps (for example, range errors, nil pointers, and paragraph stack over ow).
XARITRAP Operation Notes This trap can be armed for any combination of events; at any given time, there is only one user-written trap handler for all armed traps. There is a di erence between arming and enabling traps: Enabling a trap means that the occurrence of a trap condition is not ignored. Arming a trap is required so that, on a trap condition, a user-written routine is invoked and can take appropriate recovery actions.
XCONTRAP NM and CM callable (di erence noted below). Arms or disarms user-written subsystem break trap handling procedure. Syntax I*V I* XCONTRAP(plabel,oldplabel); Any user trap handler cannot perform a GOTO out of that procedure. Performing an ESCAPE (Pascal) or completing the trap handling procedure are the only valid ways to return. The state of the process and the program results are not predictable after a non-local GOTO statement.
XCONTRAP (CM) Bits 0:16 oldplabel Value/Meaning 16-bit external CM plabel (NM) 32-bit signed integer passed by reference (required) (CM) 16-bit signed integer passed by reference (required) Returns the plabel of the process's previous subsystem break trap handler. It can be either a CM or NM plabel, as described above. If no plabel was previously con gured, oldplabel returns 0. Operation Notes Call XCONTRAP to arm a user-written subsystem break trap handling procedure.
XLIBTRAP NM and CM callable (di erences noted below). Enables or disables a user-written software library trap handling procedure. Syntax I*V I* XLIBTRAP(plabel,oldplabel); Any user trap handler cannot perform a GOTO out of that procedure. Performing an ESCAPE (Pascal) or completing the trap handling procedure are the only valid ways to return. The state of the process and the program results are not predictable after a non-local GOTO statement.
XLIBTRAP Related Information Intrinsics Commands Manuals None None Trap Handling Programmer's Guide (32650-90026) Command Definitions 4-625
XSYSTRAP NM and CM callable (di erences noted below). Enables or disables a user-written system trap handling procedure. Syntax I*V I* XSYSTRAP(plabel,oldplabel); Any user trap handler cannot perform a GOTO out of that procedure. Performing an ESCAPE (Pascal) or completing the trap handling procedure are the only valid ways to return. The state of the process and the program results are not predictable after a non-local GOTO statement.
XSYSTRAP Related Information Intrinsics Commands Manuals None None Trap Handling Programmer's Guide (32650-90026) Command Definitions 4-627
ZSIZE NM and CM callable. Alters current DB to Z area of the compatibility mode (CM) stack. Syntax I16 I16V newsize:=ZSIZE(size); Functional Return newsize 16-bit signed integer (assigned functional return) Passes the size, in half words (CM words) actually granted. Parameters size 16-bit signed integer by value (required) Passes the desired register value of Z, relative to DB. This is the number of half words (CM words) from DB to Z. This value must be >=0.
ZSIZE Related Information Intrinsics Commands Manuals None None Programmer's Skills Migration Guide (30367-90005).
Index 3 32-bit binary, convert from ASCII string number DBINARY, 4-53 32-bit binary number, convert to ASCII string DASCII, 4-50 A Abort calling process QUIT, 4-568 Abort entire user process structure QUITPROG, 4-569 Abort errors, 2-12 ABORTSESS Abort speci ed job/session, 4-2 Intrinsic, 4-2 Abort speci ed job/session ABORTSESS, 4-2 Abort stack analysis facility, disable RESETDUMP, 4-577 Accept another CONTROL-Y signal RESETCONTROL, 4-576 Access, close user logging facility CLOSELOG, 4-32 Access, establis
Arm/disarm software library trap handling procedure XLIBTRAP, 4-624 Arm/disarm subsystem break trap handling procedure XCONTRAP, 4-622 Arm/disarm system trap handling procedure XSYSTRAP, 4-626 Arm system debugger call from process abort HPSETDUMP, 4-401 Arm system debugger from process abort SETDUMP, 4-582 Array, search for speci ed entry/name SEARCH, 4-578 ASCII Convert 16-bit binary to numeric ASCII string, 4-15 Intrinsic, 4-15 ASCII string conversion to EBCDIC CTRANSLATE, 4-48 ASCII string, convert from
EXPANDUSLF, 4-66 Change priority of process GETPRIORITY, 4-280 Character Handling NLFINDSTR, 4-500 NLJUDGE, 4-526 NLSUBSTR, 4-542 Characters of string, replace nondisplayable NLREPCHAR, 4-537 Character string, print on listing device PRINT, 4-553 Character string, print on system console PRINTOP, 4-555 Character string, print on system console/reply PRINTOPREPLY, 4-557 Character strings, compare NLCOLLATE, 4-489 NLCOLLATE2, 4-491 Character strings, scan and move NLSCANMOVE, 4-539 Child of calling process CR
Convert character string, screen to phonetic NLSWITCHBUF, 4-545 Convert data between binary oating-point formats HPFPCONVERT, 4-364 Convert date from character string to numeric NLCONVCUSTDATE, 4-495 Convert native language numbers NLCONVNUM, 4-497 Convert number from ASCII string to 16-bit binary BINARY, 4-19 Convert string from ASCII to EBCDIC CTRANSLATE, 4-48 Convert string from EBCDIC to ASCII CTRANSLATE, 4-48 Convert string from EBCDIK to JIS CTRANSLATE, 4-48 Convert string from JIS to EBCDIK CTRANSLAT
Return current date and time, 4-52 Date, return calendar CALENDAR, 4-21 Day, format time FMTCLOCK, 4-186 DBINARY Convert ASCII string number to 32-bit binary, 4-53 Intrinsic, 4-53 Deactivate a relative I/O record FDELETE, 4-107 DEBUG Intrinsic, 4-55 Invoke debug facility, 4-55 Debug commands, execute de ned system HPDEBUG, 4-308 Debug facility, invoke DEBUG, 4-55 Declaration Intrinsics, 2-1 System intrinsics, 2-1 Decrease length of USL le EXPANDUSLF, 4-66 Default parameters, 1-3 De ne Itemnum and item pair
Dynamically unload compatibility mode SL procedure UNLOADPROC, 4-609 Dynamically unlock le FUNLOCK, 4-252 E EBCDIC string conversion to ASCII CTRANSLATE, 4-48 EBCDIC, translate string from/to NLTRANSLATE, 4-548 EBCDIK string conversion to JIS CTRANSLATE, 4-48 Enable arithmetic trap ARITRAP, 4-12 Enable/disable software interrupts FINTSTATE, 4-169 Enables arithmetic traps HPENBLTRAP, 4-316 ENDLOG Intrinsic, 4-64 Mark end of user logging transaction, 4-64 End merge and release work area HPMERGEEND, 4-375 End
FCONTROL Intrinsic, 4-84 Perform control operation on a le or device, 4-84 FDELETE Deactivate a relative I/O record, 4-107 Intrinsic, 4-107 FDEVICECONTROL Control operations for printer or spooled device le, 4-108 Intrinsic, 4-108 FERRMSG Intrinsic, 4-130 Returns message corresponding to FCHECK error number, 4-130 FFILEINFO Intrinsic, 4-131 Returns information about a le, 4-131 FFINDBYKEY Intrinsic, 4-151 Position record pointer, 4-151 FFINDN Intrinsic, 4-153 Position record pointer, 4-153 FGETINFO Intrinsi
FOPEN De ne le and establish access, 4-189 Intrinsic, 4-189 Format Intrinsic syntax, 2-3 Format and conversion information, return NLNUMSPEC, 4-535 Format calendar date FMTCALENDAR, 4-185 Format calendar date and time of day FMTDATE, 4-187 Format date through language dependent template NLFMTCALENDAR, 4-502 Format date through long calendar format NLFMTLONGCAL, 4-510 Format date/time through language dependent template NLFMTDATE, 4-508 Format numeric date as character string NLFMTCUSTDATE, 4-506 Format nume
GETDSEG Create extra data segment, 4-272 Intrinsic, 4-272 GETINFO Intrinsic, 4-275 Return user-supplied information, 4-275 GETJCW Intrinsic, 4-277 Return system de ned JCW value, 4-277 GETLOCRIN acquire local RINs, 4-278 Intrinsic, 4-278 GETORIGIN Intrinsic, 4-279 Return source of activation call for process, 4-279 GETPRIORITY Change priority of process, 4-280 Intrinsic, 4-280 GETPRIVMODE Dynamically enter privileged mode, 4-282 Intrinsic, 4-282 GETPROCID Intrinsic, 4-283 Return PIN of child process, 4-283
Get CM plabel for switch to CM, 4-371 Intrinsic, 4-371 HPLOADNMPROC Intrinsic, 4-373 Return plabel, NM procedure, 4-373 HPMERGEEND Intrinsic, 4-375 Release work area and end merge, 4-375 HPMERGEERRORMESS Intrinsic, 4-376 Retrieve error message if fatal, 4-376 HPMERGEINIT Initialize MERGE subsystem, 4-378 Intrinsic, 4-378 HPMERGEOUTPUT Intrinsic, 4-383 Retrieve records from MERGE, 4-383 HPMERGESTAT Intrinsic, 4-384 Print MERGE statistics on $STDLIST, 4-384 HPMERGETITLE Intrinsic, 4-386 Print version and titl
INITUSLF, 4-446 Initiate completion for I/O request IODONTWAIT, 4-448 IOWAIT, 4-450 Initiate session on speci ed terminal STARTSESS, 4-599 Initiate SORT program SORTINIT, 4-587 INITUSLF Initialize USL le to empty state, 4-446 Intrinsic, 4-446 Interface Intrinsic, 1-3 Inter-Language calls, 1-3 Interrupt procedure, cause return from FINTEXIT, 4-168 Interrupts, enable/disable software FINTSTATE, 4-169 intrinsic HPFDUPLICATE, 4-327 Intrinsic ABORTSESS, 4-2 ACTIVATE, 4-4 ADJUSTUSLF, 4-6 ALMANAC, 4-8 ALTDSEG, 4-1
GETPROCID, 4-283 GETPROCINFO, 4-284 GETUSERMODE, 4-286 HP32208, 4-287 HPACDINFO, 4-288 HPACDPUT, 4-294 HPCICOMMAND, 4-298 HPCIDELETEVAR, 4-300 HPCIGETVAR, 4-301 HPCIPUTVAR, 4-305 HPDEBUG, 4-308 HPDEVCONTROL, 4-310 HPDEVCREATE, 4-312 HPENBLTRAP, 4-316 HPERRDEPTH, 4-319 HPERRMSG, 4-321 HPERRREAD, 4-325 HPFIRSTLIBRARY, 4-329 HPFOPEN, 4-331 HPFPCONVERT, 4-364 HPGETPROCPLABEL, 4-368 HPLOADCMPROCEDURE, 4-371 HPLOADNMPROC, 4-373 HPMERGEEND, 4-375 HPMERGEERRORMESS, 4-376 HPMERGEINIT, 4-378 HPMERGEOUTPUT, 4-383 HPME
READ, 4-570 READX, 4-572 RECEIVEMAIL, 4-574 RESETCONTROL, 4-576 RESETDUMP, 4-577 SEARCH, 4-578 SENDMAIL, 4-580 SETDUMP, 4-582 SETJCW, 4-584 SORTEND, 4-585 SORTERRORMESS, 4-586 SORTINIT, 4-587 SORTINPUT, 4-592 SORTOUTPUT, 4-593 SORTSTAT, 4-595 SORTTITLE, 4-596 STACKDUMP, 4-597 STARTSESS, 4-599 SUSPEND, 4-604 SWITCHDB, 4-606 TERMINATE, 4-607 TIMER, 4-608 UNLOADPROC, 4-609 UNLOCKGLORIN, 4-610 UNLOCKLOCRIN, 4-611 Using, 2-1 WHO, 4-612 WRITELOG, 4-615 XARITRAP, 4-617 XCONTRAP, 4-622 XLIBTRAP, 4-624 XSYSTRAP, 4-6
FLOCK, 4-182 Lock global RIN LOCKGLORIN, 4-462 LOCKGLORIN Intrinsic, 4-462 Lock global RIN, 4-462 Lock local RIN LOCKLOCRIN, 4-464 LOCKLOCRIN Intrinsic, 4-464 Lock local RIN, 4-464 LOCRINOWNER Determine process PIN that locked local RIN, 4-466 Intrinsic, 4-466 Logical record pointer for disk le, set FPOINT, 4-221 Logical record, read chronologically FREADC, 4-230 Logical record, read from current record pointer FREADBACKWARD, 4-226 Logical record, read from le to stack FREAD, 4-223 Logical record, read rand
Mnemonic, meaning, 2-3 mode Option Privileged, 2-3 Move and scan character strings NLSCANMOVE, 4-539 Move record from disk le to bu er FREADSEEK, 4-236 Move record pointer on tape/disk le FSPACE, 4-250 Multiple resource identi cation number (MR) Capability, 2-14 MYCOMMAND Intrinsic, 4-484 Parse user de ned command image, 4-484 N Name, search array for speci ed SEARCH, 4-578 Name translation Case-insensitive languages, 1-3 Native mode library procedure, load HPGETPROCPLABEL, 4-368 NLAPPEND Concatenate le na
Translate string from/to EBCDIC, 4-548 NM to CM, mixed-mode execution HPSWITCHTOCM, 4-417 NonPrivileged mode, return program GETUSERMODE, 4-286 Nonshareable device (ND) Capability, 2-14 Number, convert to native format NLFMTNUM, 4-512 Numbers, convert native language NLCONVNUM, 4-497 Numeric date information, returned ALMANAC, 4-8 O Open application message catalog CATOPEN, 4-23 OPENLOG Access to User Logging facility, 4-550 Intrinsic, 4-550 Open User Logging le, information LOGINFO, 4-468 LOGSTATUS, 4-470
GETPRIVMODE, 4-282 Procedure, arm/disarm system trap handling XSYSTRAP, 4-626 Procedure, arm/disarm trap handling XARITRAP, 4-617 XCONTRAP, 4-622 XLIBTRAP, 4-624 Procedure body Intrinsic, 1-1 Procedure header Intrinsic, 1-1 Procedure, invoke NM HPSWTONMNAME, 4-419 HPSWTONMPLABEL, 4-421 Procedure, unload HPUNLOADCMPROCEDURE, 4-423 Process abort, arm system debugger SETDUMP, 4-582 Process abort, arm system debugger call from HPSETDUMP, 4-401 Process abort, disarm system debugger HPRESETDUMP, 4-394 Process, ac
Read user le label FREADLABEL, 4-234 READX Intrinsic, 4-572 Read $STDINX ASCII string into array, 4-572 RECEIVEMAIL Intrinsic, 4-574 Receive mail from another process, 4-574 Receive mail from another process RECEIVEMAIL, 4-574 Record, move from disk le to bu er FREADSEEK, 4-236 Record output form MERGE program, specify MERGEOUTPUT, 4-481 Record pointer, move on tape/disk le FSPACE, 4-250 Record, retrieve from SORT HPSORTOUTPUT, 4-412 Records, how output from SORT program SORTOUTPUT, 4-593 Records, how suppl
HPMYFILE, 4-387 Return program to nonprivileged mode GETUSERMODE, 4-286 Returns information about a le FFILEINFO, 4-131 Returns message corresponding to FCHECK error number FERRMSG, 4-130 Return source of activation call for process GETORIGIN, 4-279 Return status for parent/child process GETPROCINFO, 4-284 Return system de ned JCW value GETJCW, 4-277 Return system time CLOCK, 4-31 Return system timer information TIMER, 4-608 Return user-supplied information GETINFO, 4-275 Return volume information HPVOLINFO
SORT operation end, release work area HPSORTEND, 4-403 SORTOUTPUT Intrinsic, 4-593 Specify how records are output from SORT program, 4-593 SORT, pass records to HPSORTINPUT, 4-411 SORT program, how records are output SORTOUTPUT, 4-593 SORT program, how records are supplied SORTINPUT, 4-592 SORT program, initiate SORTINIT, 4-587 SORT program, print statistics on $STDLIST SORTSTAT, 4-595 SORT, retrieve record from HPSORTOUTPUT, 4-412 SORTSTAT Intrinsic, 4-595 Print SORT program statistics on $STDLIST, 4-595 S
Declaration, 2-1 System resources, accessing, 1-1 System supervisor (OP) Capability, 2-14 System-supplied procedures, 1-1 System time, return CLOCK, 4-31 System timer information, return TIMER, 4-608 System trap handling procedure, arm/disarm XSYSTRAP, 4-626 T Table search, return JCW value FINDJCW, 4-166 Tape le, move record pointer FSPACE, 4-250 Tape, read logical record FREADBACKWARD, 4-226 Terminal, initiate speci ed session STARTSESS, 4-599 TERMINATE Delete calling process, 4-607 Intrinsic, 4-607 Term
GETINFO, 4-275 Using Itemnum and item pairs, 2-4 Using intrinsics, 2-1 USL le, change length EXPANDUSLF, 4-66 USL le, delete inactive entries CLEANUSL, 4-29 USL le, initialize to empty state INITUSLF, 4-446 Utility functions, request, 1-1 V Validate and parse le designator FPARSE, 4-218 Value of session-level variable, set HPCIPUTVAR, 4-305 Value, retrieve session-level HPCIGETVAR, 4-301 Value returned, search JCW table +INDJCW, 4-166 Value, return system de ned JCW GETJCW, 4-277 Variable, set value HPCIPU
