MPE/iX Intrinsics Reference Manual HP 3000 MPE/iX Computer Systems Edition 7 Manufacturing Part Number: 32650-90875 E0300 U.S.A.
Notice 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 fitness 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.
Contents 1. Introduction What Is an Intrinsic? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 What Is an Intrinsic Mechanism? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 2. Intrinsic Use Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 Functional Returns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents EXPANDUSLF. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . FATHER. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . FCHECK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . FCLOSE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents FSPACE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278 FUNLOCK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280 FUPDATE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281 FWRITE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents HPFMOVEDATALTOR. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . HPFMOVEDATARTOL. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . HPFIRSTLIBRARY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . HPFMTCALENDAR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . HPFOPEN . . . . . . . . . . . . . . . . .
Contents LOCKGLORIN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486 LOCKLOCRIN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 488 LOCRINOWNER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490 LOGINFO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents PRINT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PRINTFILEINFO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PRINTOP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . PRINTOPREPLY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents ZSIZE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents 10
Tables Table 2-1.. Mnemonic Descriptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 Table 2-2.. Data Type Mappings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Table 2-3.. Condition Code Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 Table 2-4.. Status.subsys Parameter Identifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 Table 2-5..
Tables Table 7-8.. Supported Date Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332 Table 7-9.. Format Specification Strings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335 Table 7-10.. Valid Characters for Punctuation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336 Table 7-11.. HPDEBUG Itemnum/Item Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341 Table 7-12..
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.
Introduction 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.
Introduction What Is an Intrinsic? What Is an Intrinsic? The term intrinsic refers to any external system or subsystem. However, under MPE/iX this term has a more specific 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.
Introduction What Is an Intrinsic Mechanism? What Is an Intrinsic Mechanism? The MPE/iX intrinsics mechanism provides flexible 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.
Introduction What Is an Intrinsic Mechanism? 18 Chapter 1
Intrinsic Use 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.
Intrinsic Use Parameters Parameters Intrinsic parameters can be input, output, or input/output (I/O) parameters: • Input parameters pass values into the intrinsic routine. • Output parameters return values from the intrinsic routine to the calling routine. • I/O parameters pass values into and return values from the intrinsic routine. Parameter Declarations Parameters are passed to an intrinsic either by value or by reference, depending on how the parameter is declared.
Intrinsic Use Parameters Parameter Bit Settings In some intrinsic calls, a process passes input parameters to the intrinsic as words whose individual bits or fields of bits signify functions or options. In cases where bits within a word are described as reserved for the operating system, set those bits to zero. This ensures the compatibility of your current program with future releases of the operating system.
Intrinsic Use Parameters Table 2-1. Mnemonic Descriptions Mnemonic Meaning R64 64-bit real number UDS User-defined structure U16 16-bit unsigned integer U32 32-bit unsigned integer U64 64-bit unsigned integer Passed by value V @32 32-bit address @64 64-bit address @* 32-bit address (NM) or 16-bit address (CM) * Type varies Itemnum and Item Pair Options Some intrinsics allow multiple itemnum,item pairs to be passed to define one or more options.
Intrinsic Use Parameters Table 2-2. Data Type Mappings Generic Type COBOL II/XL FORTRAN 77/XL Pascal/XL C & C/XL 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 LONGINT N/A 16-bit unsigned integer (U16) PIC S9(1) - S9(4) BINARY SYNC Integer*2 0..
Intrinsic Use Functional Returns Functional Returns Certain intrinsics return a value to the calling program in functional returns. These routines return a specified 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".
Intrinsic Use Error Handling 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.
Intrinsic Use Error Handling NOTE It is good programming practice to specify the status parameter and check its value after an intrinsic call. If an error or warning condition is encountered and the status parameter was not specified, the intrinsic causes the calling process to abort. The status parameter is read in two 16-bit fields: Biots Value/Meaning 16:16 status.subsys: identifies the subsystem that initiated the error or warning. 0:16 status.info: identifies the type of error or warning.
Intrinsic Use Error Handling Table 2-4. Status.
Intrinsic Use Error Handling Table 2-5. Status.info Parameter Identifiers Value 0 Description Normal <0 Indicates an error condition >0 Indicates a warning condition Abort Errors Software traps are interrupts generated by software events in which the operating system interrupts the normal flow 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.
Intrinsic Use Additional Capabilities Required 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.
Intrinsic Use Additional Capabilities Required The operating system optional capabilities, and what they allow you to do, are explained below. DS Capability The data segment management (DS) capability allows you to create and access extra data segments from processes during a job or session. LG Capability The user logging (LG) capability provides a flexible transaction-logging capability that allows you to record additions and modifications to your database and subsystem files on either tape or disk.
Intrinsic Use Additional Capabilities Required • If the routine should always run in privileged mode, use the execution-privilege option of the appropriate compiler and designate the execution level as 2. (Refer to your programming language reference manual for more details.) • If the routine requires privileged mode only on a selective basis, it is safer to obtain an execution level of 2 only where necessary. To do this, invoke the GETPRIVMODE intrinsic.
Intrinsic Use Additional Capabilities Required 32 Chapter 2
Intrinsic Tasks 3 Intrinsic Tasks This chapter is a quick reference for locating intrinsics that perform designated tasks. Table 3-1. through Table 3-18. 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 specifically, refer to the later chapters of this manual.
Intrinsic Tasks Table 3-1.
Intrinsic Tasks Table 3-1. Accessing Files Function Intrinsic Manual Error Checking HPERRDEPTH HPERRREAD HPERRMSG PRINTFILEINFO Accessing Files Programmer's Guide Accessing an RIO file FOPEN FDELETE FREAD FWRITE HPFOPEN Accessing Files Programmer's Guide Table 3-2.
Intrinsic Tasks Table 3-3. Managing Processes Function Intrinsic Manual Creating a Process CREATE CREATEPROCESS Interprocess Communication Programmer's Guide Obtaining Process Information FATHER GETINFO GETORIGIN GETPRIORITY GETPROCID GETPROCINFO JOBINFO Interprocess Communication Programmer's Guide Obtaining Mail Information MAIL RECEIVEMAIL SENDMAIL Interprocess Communication Programmer's Guide Table 3-4.
Intrinsic Tasks Table 3-5.
Intrinsic Tasks Table 3-7. Converting Data Types Function Intrinsic Manual Converting binary numbers ASCII DASCII Data Types Conversion Programmer's Guide Converting numeric ASCII strings BINARY DBINARY Data Types Conversion Programmer's Guide Translating ASCII/EBCDIC or JISCII/EBCDIK CTRANSLATE Data Types Conversion Programmer's Guide Converting floating-point formats HPFPCONVERT Data Types Conversion Programmer's Guide Table 3-8.
Intrinsic Tasks Table 3-9. Handling Traps Function Intrinsic Manual Trap Handling Programmer's Guide ARITRAP FINTEXIT FINSTATE HPENABLTRAP RESETCONTROL XARITRAP XCONTRAP XLIBTRAP XSYSTRAP Table 3-10.
Intrinsic Tasks Table 3-13. Programming in Privileged mode Function Intrinsic Manual Starting privileged mode GETPRIVMODE Introduction to MPE XL for MPE V Programmers Ending privileged mode GETUSERMODE Introduction to MPE XL for MPE V Programmers Table 3-14.
Intrinsic Tasks Table 3-17. Programming Switch Function Intrinsic Switching from NM to CM Manual Switch Programming Guide HPSWITCHTOCM HPSETCCODE Table 3-18.
Intrinsic Tasks 42 Chapter 3
4 Command Definitions (ABORTSESS FCLOSE) 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 files only. (ASC) For use with asynchronous serial communications only. (SPL) For use with SPL programming language only.
Command Definitions (ABORTSESS - FCLOSE) ABORTSESS ABORTSESS NM and CM callable. Enables a program to abort a specified job or session from the system.
Command Definitions (ABORTSESS - FCLOSE) ABORTSESS 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. If the spooler input file ($STDIN) for a batch job has been created and has not yet been opened, the entire file is deleted.
Command Definitions (ABORTSESS - FCLOSE) ACTIVATE 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) 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 identification number (PIN) of the process.
Command Definitions (ABORTSESS - FCLOSE) 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 specified in the allow parameter of the ACTIVATE and SUSPEND intrinsics. When a process is activated, it runs until it is either suspended or deleted.
Command Definitions (ABORTSESS - FCLOSE) ADJUSTUSLF ADJUSTUSLF NM and CM callable. Adjusts directory space in a USL file by moving the start of the information block forward (or backward) on a user subprogram library (USL) file, thereby increasing (or decreasing) the space available for the file directory block. The overall length of the file does not change. This intrinsic is intended for programmers writing compilers.
Command Definitions (ABORTSESS - FCLOSE) ADJUSTUSLF • If a negative value, the information block is moved toward the start of the USL file, decreasing the directory block and increasing the information block. Condition Codes CCE (2) Request granted. CCG (0) Not returned. CCL (1) Request denied. An error number was returned to uslferror indicating the reason for this failure.
Command Definitions (ABORTSESS - FCLOSE) ALMANAC 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.
Command Definitions (ABORTSESS - FCLOSE) ALMANAC Related Information Intrinsics CALENDAR, CLOCK, FMTCALENDAR, FMTCLOCK, FMTDATE Manuals Native Language Programmer's Guide Chapter 4 51
Command Definitions (ABORTSESS - FCLOSE) ALTDSEG ALTDSEG NM and CM callable. Reduces the storage required by the extra data segment when moved into main memory and expands storage as required, allowing for a more efficient use of memory. Data segment management (DS) capability is required. NOTE 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.
Command Definitions (ABORTSESS - FCLOSE) ALTDSEG 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. For example, creation of an extra data segment with a length of 600 half words results in the allocation of 1024 half words of virtual space.
Command Definitions (ABORTSESS - FCLOSE) ARITRAP ARITRAP NM and CM callable (differences noted below). Collectively enables all arithmetic traps (except the IEEE inexact result trap) or disables all arithmetic traps.
Command Definitions (ABORTSESS - FCLOSE) ARITRAP (NM) The possible interrupts listed below are collectively called the arithmetic traps: • 3000 mode double-precision divide by zero • 3000 mode double-precision overflow • 3000 mode double-precision underflow • 3000 mode floating-point divide by zero • 3000 mode floating-point overflow • 3000 mode floating-point underflow • 3000 mode packed decimal error • Decimal divide by zero • Decimal overflow • IEEE floating-point divide by zero • IEEE floating-point un
Command Definitions (ABORTSESS - FCLOSE) ARITRAP • Decimal divide by zero • Decimal overflow • Integer divide by zero • Integer overflow • Invalid ASCII digit • Invalid decimal digit • Invalid decimal operand length • Invalid source word count Condition Codes CCE (2) Request granted. All arithmetic traps were originally disabled. CCG (0) Request granted. At least one arithmetic trap was originally enabled. CCL (1) Not returned.
Command Definitions (ABORTSESS - FCLOSE) ASCII ASCII NM and CM callable. Converts a 16-bit binary number to a specified 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.
Command Definitions (ABORTSESS - FCLOSE) 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.
Command Definitions (ABORTSESS - FCLOSE) BEGINLOG BEGINLOG NM and CM callable. Posts a special record to the user logging file to mark the beginning of a logical transaction. When BEGINLOG is called, the logging memory buffer is flushed to ensure that the record gets to the logging file. User logging (LG) or system supervisor (OP) capability is required.
Command Definitions (ABORTSESS - FCLOSE) BEGINLOG 2 Parameter out of bounds 4 Incorrect index parameter passed 5 Incorrect mode parameter passed 9 Error occurred while writing 12 System out of disk space, user logging cannot proceed 14 Invalid access 15 End-of-file Operation Notes Use the data parameter of this intrinsic to post user data to the logging file. This use of BEGINLOG is similar to using the WRITELOG intrinsic, but also denotes the beginning of a logical transaction.
Command Definitions (ABORTSESS - FCLOSE) 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) Passes the octal or signed-decimal number (in ASCII characters) to be converted.
Command Definitions (ABORTSESS - FCLOSE) BINARY Commands None Manuals Data Types Conversion Programmer's Guide 62 Chapter 4
Command Definitions (ABORTSESS - FCLOSE) CALENDAR CALENDAR NM and CM callable. Returns the calendar date, including the day of year and the year since 1900.
Command Definitions (ABORTSESS - FCLOSE) CATCLOSE 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) Passes the catalog index returned by the CATOPEN intrinsic. catstatus 16-bit unsigned integer array (required) Returns two elements; the first element is the error number, the second element is reserved and always returns 0.
Command Definitions (ABORTSESS - FCLOSE) CATOPEN CATOPEN NM and CM callable. Opens an application message catalog that was formatted with the GENCAT utility. CATOPEN returns a value that identifies the catalog and is used by CATREAD and CATCLOSE. Syntax I32 CA U16A catindex:=CATOPEN(formaldesig,catstatus); Functional Return 32-bit signed integer (assigned functional return) catindex An internal value recognized by the CATREAD and CATCLOSE intrinsics. NOTE The functional return is not a file number.
Command Definitions (ABORTSESS - FCLOSE) CATOPEN Related Information Intrinsics CATCLOSE, CATREAD Manual Message Catalogs Programmer's Guide 66 Chapter 4
Command Definitions (ABORTSESS - FCLOSE) 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.
Command Definitions (ABORTSESS - FCLOSE) CATREAD buffer 4 Message number not found 6 User buffer overflow 7 Write to msgdest file failed 14 setnum <= 0 specified 15 setnum > 255 specified 16 msgnum < 0 specified 17 msgnum > 32,766 specified 18 buffersize <= 0 specified 19 msgdest <= -2 specified 100 Internal message facility error character array (optional) Returns the assembled message.
Command Definitions (ABORTSESS - FCLOSE) CAUSEBREAK CAUSEBREAK NM and CM callable. Interrupts the program (the entire process structure). The CAUSEBREAK intrinsic is the programmatic equivalent to pressing Break in a session, 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) Request granted.
Command Definitions (ABORTSESS - FCLOSE) CLEANUSL CLEANUSL NM and CM callable. Deletes all inactive entries from currently managed USL files and returns the file number of the new USL file. Therefore, you must test the condition code immediately upon return from the intrinsic. Unpredictable results occur if an error number is used as a file number. NOTE A USL contains CM object code and is meaningful in the CM program development process only.
Command Definitions (ABORTSESS - FCLOSE) CLEANUSL Related Information Intrinsics ADJUSTUSLF, EXPANDUSLF, INITUSLF Manual MPE Segmenter Reference Manual Chapter 4 71
Command Definitions (ABORTSESS - FCLOSE) CLOCK CLOCK NM and CM callable. Returns the time (hours, minutes, seconds, and tenths of seconds) according to the system timer.
Command Definitions (ABORTSESS - FCLOSE) CLOSELOG 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) Passes access capabilities to the user logging system. This is the value returned in the index parameter of the OPENLOG intrinsic.
Command Definitions (ABORTSESS - FCLOSE) 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 buffer (LOGBUFF) entry and increments the user count only at the first 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 Definitions (ABORTSESS - FCLOSE) COMMAND COMMAND NM and CM callable. Programmatically executes a command. Syntax CA I16 I16 COMMAND(cmdimage,cmderror,parmnum); Parameters cmdimage character array (required) Passes an ASCII string of <=511 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 Definitions (ABORTSESS - FCLOSE) COMMAND NOTE The cmderror is the correct parameter to check to verify if cmdimage succeeded. The parmnum may provide additional information. Operation Notes User-defined 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 files and the implied RUN are not allowed.
Command Definitions (ABORTSESS - FCLOSE) CREATE CREATE NM and CM callable (differences 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,loadflags, I16V I16V I16V U16V I16V stacksize,dlsize,maxdata,priorityclass,rank); Parameters formaldesig character array (required) The name of the program to be created, specified either in MPE or HFS syntax.
Command Definitions (ABORTSESS - FCLOSE) CREATE loadflags 16-bit unsigned integer by value (optional) Specifies the loading options as follows: Bits VaIue/Meaning 15:1 Active 14:1 13:1 12:1 10:2 0 Calling process not activated when the new process terminates 1 The system reactivates the calling process (parent) when the new process terminates 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
Command Definitions (ABORTSESS - FCLOSE) CREATE (CM) Search the account public library (SL.PUB.accountname) in the account where formaldesig is located, then search the system libraries. 10 (NM) Search the group library (XL.groupname.accountname) in the account where formaldesig is located, then the account public library, and then the system libraries. (CM) Search the group library (SL.groupname.
Command Definitions (ABORTSESS - FCLOSE) CREATE MPE V/E mode default values. (Equivalent to the stack= parameter of the RUN command.) (CM) Passes the number of words assigned to the local stack area bounded by the initial Q and Z registers. A value of -1 indicates that the Segmenter will assign the default values (equivalent to omitting this parameter).
Command Definitions (ABORTSESS - FCLOSE) CREATE CPU voluntarily; it could loop infinitely and prevent other processes from accessing the CPU. (Equivalent to the PRI= parameter of the RUN command.) Default: The calling process priority. rank 16-bit signed integer by value (optional) For backward-compatibility with MPE V/E-based systems only. Operation Notes The CREATE intrinsic does the following: 1. Loads the program to be run by the new process into virtual memory. 2.
Command Definitions (ABORTSESS - FCLOSE) CREATE Related Information Intrinsics ACTIVATE, SUSPEND Commands RUN Manual Process Management Programmer's Guide 82 Chapter 4
Command Definitions (ABORTSESS - FCLOSE) CREATEPROCESS CREATEPROCESS NM and CM callable (differences noted below). Creates a process and allows you to assign $STDIN and $STDLIST to any file. 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.
Command Definitions (ABORTSESS - FCLOSE) CREATEPROCESS 17 Process not created; illegal value specified for itemnum=7 18 Process not created; specified $STDIN could not be opened 19 Process not created; specified $STDLIST could not be opened 20 Process not created; string to be passed to new process invalid (pointer without length, length without pointer, or length exceeds stack size of calling process) pin 16-bit signed integer by reference (required) Returns the process identification number (PIN
Command Definitions (ABORTSESS - FCLOSE) CREATEPROCESS 3 The load options for loading the program file of the new process, designated as: (NM) Bits (0:16) Zeros Bits (16:16) Load options (CM) Bits (0:16) Load options Item 3 has the same definition as the loadflag parameter of the CREATE intrinsic. If both itemnums 3 and 19 are specified, the LIBSEARCH option is ignored or if LIBSEARCH is set to a value other than its default (00), a warning is returned indicating the LIBSEARCH option was ignored.
Command Definitions (ABORTSESS - FCLOSE) CREATEPROCESS parameter of ACTIVATE, except bit (31:1) is the parent activation bit and bit (30:1) is the child activation bit. 11 The address must be a byte address (type-coerced) containing information to be passed to the new process. The length of the string must be specified in itemnum=12 (equivalent to the INFO= parameter of the RUN command), accessible through the GETINFO intrinsic. 12 The length (in bytes) of the string referenced by itemnum=11.
Command Definitions (ABORTSESS - FCLOSE) CREATEPROCESS Condition Codes CCE (2) Request granted. CCG (0) Request granted. Check the createstatus parameter to see if warning codes were returned. \CCL (1)\ Request denied. Check the createstatus parameter to determine why the request was denied.
Command Definitions (ABORTSESS - FCLOSE) CTRANSLATE CTRANSLATE NM and CM callable. Converts a string of characters between EBCDIC and ASCII, or between EBCDIK (HP-specific version of EBCDIC) and KANA8 (8-bit, Japanese International Standard (JIS) version of USASCII code).
Command Definitions (ABORTSESS - FCLOSE) CTRANSLATE transtable gives the code to be substituted for source bytes whose value is 0. Condition Codes CCE (2) Request granted. Translation performed successfully. CCG (0) Not returned. CCL (1) Request denied. An error occurred.
Command Definitions (ABORTSESS - FCLOSE) DASCII DASCII NM and CM callable. Converts a 32-bit binary number to a specified 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) Contains the binary number to be converted to an ASCII string.
Command Definitions (ABORTSESS - FCLOSE) DASCII the sign). For example, if binvalue=0, the length returned is 1. • For decimal right-justified conversions (base=-10), the result is right-justified in asciieqv; the least significant digit is in asciieqv(-1), the next least significant digit is in asciieqv(-2), and so on. • For right-justified conversions, the character array where the converted value is to be placed must specify the rightmost byte where data is placed.
Command Definitions (ABORTSESS - FCLOSE) DATELINE DATELINE NM and CM callable. Returns the current date and time, including the day of week, month, day, year, hours, and minutes.
Command Definitions (ABORTSESS - FCLOSE) 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) Passes the octal or signed decimal number (in ASCII characters) to be converted.
Command Definitions (ABORTSESS - FCLOSE) DBINARY Related Information Intrinsics BINARY Manual Data Types Conversion Programmer's Guide 94 Chapter 4
Command Definitions (ABORTSESS - FCLOSE) 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 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.
Command Definitions (ABORTSESS - FCLOSE) DLSIZE 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 16-bit signed integer (assigned functional return) dldbsize 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.
Command Definitions (ABORTSESS - FCLOSE) DLSIZE Condition Codes CCE (2) Request granted. The value returned is >= the value requested. CCG (0) Request denied. The requested size exceeded the maximum limit allowed. The maximum limit allowable is granted, and its size is returned. CCL (1) Request denied. An illegal size parameter was specified, the size requested is less than the initial DL size, or the size parameter was a positive integer.
Command Definitions (ABORTSESS - FCLOSE) DMOVIN DMOVIN NM and CM callable. Copies data from an extra data segment into a data area. 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 an NM program's performance.
Command Definitions (ABORTSESS - FCLOSE) DMOVIN transferring the data is the address of ARA[10]. If ARA is an array of half words, the four half words are moved to ARA[10] through ARA[13], as shown in . Figure 4-1. DMOVIN Data Movement. ARA[1..
Command Definitions (ABORTSESS - FCLOSE) 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.
Command Definitions (ABORTSESS - FCLOSE) DMOVOUT ARA[13], are moved to half word offset 201 through 204 of the data segment, as shown in . Figure 4-2. DMOVOUT Data Movement. ARA[1..n] 1 +--------------+ 2 |--------------| 3 |--------------| 4 |--------------| 5 |--------------| 6 |--------------| 7 |--------------| 8 |--------------| 9 |--------------| 10 |--------------| 11 |--------------| 12 |--------------| 13 |--------------| 14 +--------------+ +--------------+ . .
Command Definitions (ABORTSESS - FCLOSE) ENDLOG ENDLOG NM and CM callable. Posts a record to the logging file marking the end of a logical transaction. When the record is posted, ENDLOG flushes the user logging memory buffer to ensure that the record gets to the logging file. User logging (LG) or system supervisor (OP) capability is required.
Command Definitions (ABORTSESS - FCLOSE) ENDLOG 0 Successful 1 Nowait mode requested, and the user logging process is busy 2 Parameter out of bounds 4 Incorrect index parameter passed 5 Incorrect mode parameter passed 9 Error occurred while writing 12 System out of disk space; user logging cannot proceed 14 Invalid access 15 End-of-file encountered Operation Notes Use the data parameter of this intrinsic to post user data to the logging file.
Command Definitions (ABORTSESS - FCLOSE) EXPANDUSLF EXPANDUSLF NM and CM callable. Changes length of a USL file by creating a USL file with the increment length longer or shorter than the USL file specified by uslfnum. The old USL file is copied to the new file with the same file name; the old USL file is then deleted. NOTE A USL contains CM object code and is meaningful only in the CM program development process.
Command Definitions (ABORTSESS - FCLOSE) EXPANDUSLF increment 16-bit signed integer by value (required) Passes the number of records the length of the USL file is to be changed: • If a positive value, the new USL file is longer than the old USL. • If a negative value, the new USL file is shorter than the old USL. Condition Codes CCE (2) Request granted. The new file number is returned. CCG (0) Not returned. CCL (1) Request denied. An error number was returned to filenum.
Command Definitions (ABORTSESS - FCLOSE) FATHER FATHER NM and CM callable. Returns the process identification 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 identification number (PIN) of the parent process. Condition Codes CCE (2) Request granted. The parent is a user process. CCG (0) Request granted.
Command Definitions (ABORTSESS - FCLOSE) FCHECK FCHECK NM and CM callable. Returns specific details about error conditions that occurred when a file system intrinsic returns a condition code indicating an I/O error. FCHECK applies to files on any device. Syntax I16V I16 I16 I32 I16 FCHECK(filenum,fserrorcode,translog,blocknum,numrecs); Parameters filenum 16-bit signed integer by value (optional) Passes the file number of the file for which error information is to be returned.
Command Definitions (ABORTSESS - FCLOSE) FCHECK 4 Disk space allocation disabled on all domain disks 5 DRT number >511 6 Device has no spare blocks available 7 Unformatted or uninitialized media on device 8 Illegal parameter value 9 Invalid file type specified in foption 10 Invalid record size specification 11 Invalid resultant block size 12 Record number out of range 13 Cannot open file multiaccess 15 Exceeded maximum file opens for write access 16 More than 255 opens of a file 17
Command Definitions (ABORTSESS - FCLOSE) FCHECK 36 Invalid disk address 37 Invalid memory address 38 Tape parity error 39 Recovered tape error 40 Operation inconsistent with access type 41 Operation inconsistent with record type 42 Operation inconsistent with device type (for example, attempted to set an invalid line speed through FCONTROL itemnum=11) 43 Write exceeds record size 44 Update at record zero 45 Privileged file violation 46 Out of disk space 47 I/O error on a file label
Command Definitions (ABORTSESS - FCLOSE) FCHECK 71 Too many files open 72 Invalid file number 73 Bounds violation 74 No room in stack for file entry 77 Nowait I/O operation pending 78 No nowait I/O pending for any file 79 No nowait I/O pending for any special file 80 Spoolfile size exceeds configuration 81 No spool class defined in system 82 Insufficient space in spool class for I/O request 83 I/O error on spoolfile 84 Device unavailable for spoolfile 85 Operation inconsistent with
Command Definitions (ABORTSESS - FCLOSE) FCHECK 104 Temporary directory overflow 105 Bad variable block structure 106 Extent size exceeds maximum 107 Insufficient space for user labels 108 Invalid file label 109 Invalid carriage control 110 Attempt to save permanent file as temporary 111 No save files (SF) capability 112 No mountable volumes (UV) capability 113 Volume set not mounted; mount problem 114 Volume set not dismounted; dismount problem 115 Attempted rename across volume set
Command Definitions (ABORTSESS - FCLOSE) FCHECK 148 Inactive RIO record 149 Missing item number or return variable 150 Invalid itemnum 151 Undefined file type 152 Unrecognized option in FOPEN/HPFOPEN device parameter 153 Expecting semicolon (;) or carriage return in FOPEN/HPFOPEN device parameter 154 Environment file open error 155 File not environment file; check file code or record size 156 Header record incorrect 157 Uncompiled environment file 158 Error reading environment file 15
Command Definitions (ABORTSESS - FCLOSE) FCHECK 181 (KSAM) Invalid key starting position 182 (KSAM) File empty 183 (KSAM) Record does not contain all keys 184 (KSAM) Invalid record number 185 (KSAM) Sequence error in primary key 186 (KSAM) Invalid key length 187 (KSAM) Invalid key specification 188 (KSAM) Invalid device specification 189 (KSAM) Invalid record format 190 (KSAM) Invalid key blocking factor value 191 (KSAM) Record does not contain search key for deletion; specified key va
Command Definitions (ABORTSESS - FCLOSE) FCHECK 255 Communications interface error; connection lost 302 Invalid item number for FDEVICECONTROL 303 Invalid access for item number to FDEVICECONTROL 304 Attempt to change terminal parity in 8-bit mode 305 Invalid format in terminal configuration file 306 Checksum error in terminal configuration file 307 Passed value to FDEVICECONTROL less than minimum 308 Passed value to FDEVICECONTROL greater than maximum 309 Passed value to FDEVICECONTROL is
Command Definitions (ABORTSESS - FCLOSE) FCHECK 404 Backreferenced file is not allowed 405 System files are not allowed 406 Remote environment specification is not allowed 407 Invalid usage of a character class 408 Missing file name component 409 File name did not start with an alphabetic characte 410 Specified file name is too long 411 Lockword in backreferenced file name is not allowed 412 Lockword in wildcarded file name is illegal 413 Lockword is missing 414 Lockword did not start
Command Definitions (ABORTSESS - FCLOSE) FCHECK 452 File privilege level is invalid in this context 453 The specified file is write protected 454 The specified record type is invalid 455 The file type specified is invalid 456 File type specified is only supported in MPE namespace 457 Component of path does not exist 458 Trying to read/write to a pipe or FIFO and O_NONBLOCK is set 459 Trying to write to a pipe but it was not opened for read 460 Specified file domain not supported in the giv
Command Definitions (ABORTSESS - FCLOSE) FCHECK 486 Invalid file type 487 Lock type and file access incompatible 488 Conflicting read format 489 Tthe file type is not a symbolic link file 490 Tried to reply to waiters and none were found 491 Trying to deallocate a PLFD that is locked by another thread 492 Trying to deallocate a PLFD that isn't locked by your thread 493 An invalid operation for threads 494 A read or write operation was interrupted by a signal 495 Exec call failed because
Command Definitions (ABORTSESS - FCLOSE) FCLOSE FCLOSE NM and CM callable. Terminates access to a file on any device. Syntax I16V I16V I16V FCLOSE(filenum,disposition,securitycode); Parameters filenum 16-bit signed integer by value (required) Passes the file number of the file to be closed. disposition 16-bit signed integer by value (required) Passes the disposition of the file, significant only for files on disk and magnetic tape; ignored for spooled and hot printers.
Command Definitions (ABORTSESS - FCLOSE) FCLOSE tape is rewound. If the file resides on labeled magnetic tape, the tape is backspaced to the beginning of the opened file.. 11:2 10.1 011 Close as a temporary job file (not rewound). This option has the same effect as domain disposition 010, except that tape files are not rewound. In the case of unlabeled magnetic tape, if this FCLOSE is the last done on the device (with no other FOPEN/HPFOPEN calls outstanding), the tape is rewound and unloaded.
Command Definitions (ABORTSESS - FCLOSE) FCLOSE the saved disposition is the smallest nonzero disposition parameter specified for all FCLOSE calls issued against the file. For example, the file XYZ is opened three successive times by a process. The first FCLOSE disposition is 1, the second is 2, and third is 3. On the last FCLOSE, a disposition of 1 will occur.
Command Definitions (ABORTSESS - FCLOSE) FCLOSE • A disposition code of 1 (rewind and unload) implies the close of an entire volume set. • If unlabeled magnetic tape is closed with a disposition code of 0, 1, or 4, and the tape was written to while open, FCLOSE writes three EOFs at the end of the tape before performing a rewind or rewind/unload. This ensures that all tapes have an acceptable number of EOF marks at the end.
Command Definitions (ABORTSESS - FCLOSE) FCLOSE specified or another file with the same name and disposition exists. Any outstanding write I/Os that failed (for example, buffered writes that are done in background) or an illegal disposition.
5 Command Definitions (FCONTROL FLOCK) 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 files only. (ASC) For use with asynchronous serial communications only. (SPL) For use with SPL programming language only.
Command Definitions (FCONTROL - FLOCK) FCONTROL FCONTROL NM and CM callable. Performs various control operations on a file or on the device where the file resides, including: • Supplying a printer or terminal carriage control directive. • Verifying I/O. • Reading the hardware status word for the device where the file resides. • Setting a terminal's timeout interval. • Repositioning a file at its beginning. • Writing an end-of-file marker. • Skipping forward or backward to a tape mark.
Command Definitions (FCONTROL - FLOCK) FCONTROL the FWRITE intrinsic for these directives.) If item passes either the prespacing (%101 or %401) or postspacing (%100 or %400) carriage control directives, one of the following values is returned in item, indicating the setting of the device prior to the FCONTROL call: 0 Postspacing 1 Prespacing If both a mode control directive and a carriage control directive need to be specified, an additional call to FWRITE or FCONTROL must be made.
Command Definitions (FCONTROL - FLOCK) FCONTROL Only valid for terminal and message files. Only affects the next read if the file is being read from the terminal; it must be reissued for each read. If this code is applied to a message file, item specifies the length of time that a process waits when reading from an empty file or writing to a full one and the timeout remains enabled until it is explicitly cancelled. During block mode reads, the timer halts when a DC2 character is received.
Command Definitions (FCONTROL - FLOCK) FCONTROL (KSAM) Not used for KSAM XL files. For KSAM/3000 files, it clears the key and data buffers of all information and reads the first 2 sectors of the key file from disk to buffer. 8/U16 Space backward to tape mark: On unlabeled tapes, moves a magnetic tape backward until a tape mark is encountered. If used on labeled tapes, the tape is positioned at the beginning of user header labels, if any. Rejected for spooled DATA tapes. Item is ignored.
Command Definitions (FCONTROL - FLOCK) FCONTROL Item is ignored. 11/U16 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 (300 bps) 120 (1200 bps) 240 (2400 bps) 960 (9600 bps) 1920 (19200 bps) Any setting other than those listed returns CCL (1).
Command Definitions (FCONTROL - FLOCK) FCONTROL automatically. For all other types of block mode, disable echo before the block mode read begins. Echo should be disabled if a terminal user is entering data that should not appear on the screen (for example, passwords or lockwords). Echo should be disabled when connecting some nonsupported devices to an asynchronous port. Reset in break mode; not reset after FCLOSE.
Command Definitions (FCONTROL - FLOCK) FCONTROL allow system break processing to occur. For example, disable system break when using block mode. This prevents data loss or corruption that could occur if BREAK is pressed during a block mode read. Reset after FCLOSE. If BREAK is pressed while system break is disabled, no action is taken by any level of software. System break has no effect on a device with no active session.
Command Definitions (FCONTROL - FLOCK) FCONTROL Subsystem break processing is summarized as follows: 1. A user-written procedure must be provided defining how the subsystem break trap handler will react upon receipt of a subsystem break. The user program must contain: • The user written procedure. • A call to XCONTRAP, specifying the external label of the procedure; this arms the subsystem break trap. • A call to FCONTROL Itemnum=17, enabling the subsystem break function.
Command Definitions (FCONTROL - FLOCK) FCONTROL function. • A call to RESETCONTROL when the program is ready to receive another subsystem break. 2. A new subsystem break character can be defined through FCONTROL itemnum=41 if the terminal is placed in transparent mode or through FDEVICECONTROL, which allows a subsystem break character to be defined without placing the device in the transparent mode. 3. At any time, FCONTROL can be called to disable the subsystem break.
Command Definitions (FCONTROL - FLOCK) FCONTROL to the program reading the data. 24/U16 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.
Command Definitions (FCONTROL - FLOCK) FCONTROL ASCII Characters Octal Hex Terminal Code Code Keys NUL (null) %0 $0 DC1 (XON) %21 $11 DC3 (XOFF) %23 $13 DEL (Rubout) %31 $19 Subsystem Break %177 $77F CTRL@ CTRLQ CTRLS DEL CTRLY (default) Note: Avoid using characters that have a special meaning specifically, carriage return, linefeed, cancel, backspace, DC2, or escape. These characters will be recognized and processed, but they can result in unpredictable and unsuccessful results.
Command Definitions (FCONTROL - FLOCK) FCONTROL 28/U16 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.
Command Definitions (FCONTROL - FLOCK) FCONTROL Use of timers during block mode is encouraged to eliminate port "hangs" due to a data overrun occurring when the last character is read. The standard block mode read timer is disabled when the user block mode protocol is enabled. Not reset in break mode; not reset after FCLOSE. Under default conditions, user block mode is disabled. 34/U16 Enable line deletion response: Item has no meaning; enter a value of 0 to satisfy internal requirements.
Command Definitions (FCONTROL - FLOCK) FCONTROL Parity cannot be used with 8-bit character sets. Ignored for devices connected through PAD. 37/U16 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).
Command Definitions (FCONTROL - FLOCK) FCONTROL Note: Do not confuse the current line speed returned with the default line speed specified during system configuration. Changing the line speed through system intrinsics can cause a difference from the configured setting. To reset the configured line speed, use itemnum=37 and item=0 or close the device. If used for a terminal connected through PAD, the value returned in item is meaningless. Condition code CCE (2) is returned. 41/.
Command Definitions (FCONTROL - FLOCK) FCONTROL character functions like a RETURN 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, defined through a previous call to FCONTROL itemnum=25. The read completes with an error condition and the AEOR character is passed with the input data and and included in the byte count. No carriage return or line feed is sent to the terminal.
Command Definitions (FCONTROL - FLOCK) FCONTROL writer's ID. Each record read has a two-word header. The first 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. Open and close records contain no more information. If the item value is 0, reading the writer's ID is disabled. Only data is read to the reader's target area.
Command Definitions (FCONTROL - FLOCK) FCONTROL FPOINT or FREADDIR when append mode is active. Append access prohibits logical record pointer operations. For example, call to FPOINT and FSPACE result in an access violation for files opened for append access. This itemnum is supported only for byte stream files. If the file referenced by filenum is not a byte stream file. FCONTROL will fail with a CCL condition code.
Command Definitions (FCONTROL - FLOCK) FCONTROL ioctl_parm_type request arg func_return = : : : record integer; localanyptr; localanyptr; end; The caller must correctly fill in the values of the structure before calling the FCONTROL intrinsic. The functions that are supported through this option are defined as standard documentation on the ioctl( ) function. NOTE Itemnums 10 through 41 are used in changing terminal characteristics.
Command Definitions (FCONTROL - FLOCK) FDELETE FDELETE NM and CM callable. Deactivates a specified logical record in an RIO file. Syntax I16V I32V FDELETE(filenum,lrecnum); Parameters filenum 16-bit signed integer by value (required) Passes the file number of the file to be modified. lrecnum 32-bit signed integer by value (optional) Passes the relative logical record to be deactivated. Operation Notes If a record is not specified or the lrecnum is negative, the next logical record becomes inactive.
Command Definitions (FCONTROL - FLOCK) FDEVICECONTROL FDEVICECONTROL NM and CM callable. Provides control operations to a printer, terminal, or a spooled device file and is used to: • Download character sets, forms, and internal or control tables used in printing. • Control the page size, pen positioning, form and use of character sets, the number of copies to be printed, and all other printing environment characteristics. • Perform control operations on a terminal, printer, or spooled device file.
Command Definitions (FCONTROL - FLOCK) FDEVICECONTROL (ASC) Passes the number of the operation to be performed. Controlcode 192 is used to apply control directives to a device file. Codes 0 through 64 call FCONTROL. Control passes to FCONTROL, and any errors returned will have originated with FCONTROL. parm1, parm2 16-bit unsigned integer by value (required) Passes the value specified in the corresponding controlcode; there are several values for parm1 and parm2 that define the operation in more detail.
Command Definitions (FCONTROL - FLOCK) FDEVICECONTROL activation or deactivation of those pages. Every physical page is composed of one or more logical pages. When the Hewlett-Packard 268x begins to print each physical page, it scans the logical page table (LPT) for the first logical page labeled as ACTIVE. The printer then continues searching the table sequentially for active pages and printing them until it has printed the last active page.
Command Definitions (FCONTROL - FLOCK) FDEVICECONTROL The following bits are ignored if set to zero: parm1 (0:1) 1 = Multicopy form overlay feature on parm1 (1:1) 1 = Multicopy form overlay feature off parm1 (2:1) 1 = Reserved for the operating system parm1 (3:1) 1 = Redefine physical page length parm1 (4:1) 1 = Redefine number of copies per page parm1 (5:1) 1 = Reserved for the operating system parm1 (6:1) 1 = Reserved for the operating system parm1 (7:1) 1 = Reserved for the operating sys
Command Definitions (FCONTROL - FLOCK) FDEVICECONTROL 1 = Continuation of previous record parm2 (8:8) Form set identifier; integer from 0 to 31 If attempting to download a form set having the same identifier as one existing in the printer, then the Hewlett-Packard 268x purges the existing form set and repacks the user area before loading the new form.
Command Definitions (FCONTROL - FLOCK) FDEVICECONTROL The VFC table is an ASCII file downloaded to the Hewlett-Packard 268x printer in order to give specific instructions on the print density, location of the top of the page, the bottom of the page, and other specifications of the printed page. The Hewlett-Packard 268x expresses the height of a printed line in dots and the system uses this value to compute line positions on the page.
Command Definitions (FCONTROL - FLOCK) FDEVICECONTROL 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 flushes all data currently in its buffers and then performs the indicated clears, if any.
Command Definitions (FCONTROL - FLOCK) FDEVICECONTROL does not see it. When enabled, device related I/O errors (if they occur) are not returned. The caller is notified that the device has status and another FDEVICECONTROL call has to be made to determine the status. When enabling status, the buffer returns the number of bytes occupied by the largest status block returned by the device.
Command Definitions (FCONTROL - FLOCK) FDEVICECONTROL parm2 150/I16V Upper half of the 32-bit integer Start silent run: Used to start printer recovery from specific error conditions on recoverable devices or to backup or skip forward a specified number of pages and resume printing. 151/I16V parm1 Start silent run physical page number parm2 Resume printing of physical page number Print standard header or trailer: Used to print standard headers/trailers.
Command Definitions (FCONTROL - FLOCK) FDEVICECONTROL through PAD, add enough time to compensate for delays caused by the network. 3 Set line speed for the device: Set the line speed for the device associated with filenum by entering a new line speed, representing characters per second, as the value of buffer. Supported speeds are 30, 120, 240, 480, 960, and 1920 characters per second. Input and output line speeds are the same.
Command Definitions (FCONTROL - FLOCK) FDEVICECONTROL 8 Obtain time used for completion of last read: Determine the time, in seconds, required for the last read to complete. Ensure that this call is placed immediately after the read to be timed, with no subsequent reads in between. Only read access is allowed for this request. All reads are timed, so there is no need to enable the timer.
Command Definitions (FCONTROL - FLOCK) FDEVICECONTROL a terminal: 0 Disable transmission 1 Enable transmission Line deletion characters are not output by PAD devices. If issued to a terminal connected through PAD, CCE (2) is returned, but no terminal control action occurs. 15 Set transparent editing mode: Enables or disables transparent (unedited) mode.
Command Definitions (FCONTROL - FLOCK) FDEVICECONTROL terminal immediately after the characters defined as the subsystem break or EOR character are typed. The terminal user has to press RETURN to cause data to be transmitted, or wait for the data forwarding timer to expire (if set). The host software recognizes and acts on the characters defined in this call. Disable transparent editing by passing NUL characters.
Command Definitions (FCONTROL - FLOCK) FDEVICECONTROL PAD terminal supporting page block mode 29 Block mode alert character: Specifies the character used to signal Hewlett-Packard block mode transfers. The standard alert character is DC2. This call only defines 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.
Command Definitions (FCONTROL - FLOCK) FDEVICECONTROL AEOR character. 41 Subsystem break character: Specifies the character is to be used as the subsystem break character. This value is passed in the high order byte (value * 256) of buffer. If issued to a terminal connected through PAD, the new subsystem break character is recognized by the host, but the terminal user has to press RETURN following the subsystem break to signal the PAD that data is ready to be transmitted.
Command Definitions (FCONTROL - FLOCK) FDEVICECONTROL 1 Remove character from input and back cursor up one space (default) 5 Remove character from input and erase character (backspace, space, backspace) If issued against a terminal connected through PAD, CCE (2) is returned, but the device control action does not occur. 56 Data bits per character: Specifies whether 7-bits or 8-bits are used for each character.
Command Definitions (FCONTROL - FLOCK) FDEVICECONTROL next read only. 0 Disable the request. This request is valid only if typeahead is enabled. If issued against a terminal connected through PAD, CCE (2) is returned, but the device control action does not occur. 62 Quiesce I/O: Valid values are: 1 The control will not complete until all previous I/O to the device has completed. If issued against a terminal connected through a PAD, control issues only previous I/O sent to PAD and not to the device.
Command Definitions (FCONTROL - FLOCK) FDEVICECONTROL If the Interbyte Timer is not set properly, performance of an application program could deteriorate. For example, a program could set the Interbyte Timer to a very small value, resulting in most reads completing with only one character of data. This essentially reduces the application to a character mode application.
Command Definitions (FCONTROL - FLOCK) FDEVICECONTROL 69 Suppress Echo of Read Terminator: Valid values are: 1 Enables functionality. Gives an application the ability to determine whether or not to include the read terminators with the data that is echoed back to the device. Once echo suppression is enabled, no read terminating characters will be echoed to the device until echo suppression is disabled. 0 Disables the functionality.
Command Definitions (FCONTROL - FLOCK) FDEVICECONTROL Table 5-1.
Command Definitions (FCONTROL - FLOCK) FDEVICECONTROL Communications Programmer's Reference Manual 164 Chapter 5
Command Definitions (FCONTROL - FLOCK) FERRMSG 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 I16 FERRMSG(fserrorcode,msgbuffer,msglength); Parameters fserrorcode 16-bit signed integer by reference (required) Passes an error code returned by the FCHECK intrinsic indicating which message to return in msgbuffer.
Command Definitions (FCONTROL - FLOCK) FFILEINFO FFILEINFO NM and CM callable. Returns information about a file. Syntax I16V I16V * FFILEINFO(filenum[,itemnum,item] [...]); NOTE Up to five itemnum/item pairs can be specified. Parameters 16-bit signed integer by value (required) filenum Passes the file number of the file for which information is requested. 16-bit signed integer by value (optional) itemnum Specifies which item value is to be returned. (Refer to Table 5-2. on page 166.
Command Definitions (FCONTROL - FLOCK) FFILEINFO Table 5-2. FFILEINFO Itemnum/Item Values Itemnu m Item Type 2 U16 Item Description File options: Returns file characteristics (refer to the foption figure). The record format extension bit is returned as the foption (1:1) bit. Byte stream record format is represented as a record format extension of one with a variable record format foption (8:2) bits equal to 01.
Command Definitions (FCONTROL - FLOCK) FFILEINFO Table 5-2. FFILEINFO Itemnum/Item Values Itemnu m Item Type 6 U16 Item Description Logical device number: Returns the logical device number of the device where the disk file label resides. • If the file is a disk file, the LDEV is the location of the file label. (File data can reside on the same device as the file label.) • If the file is spooled, the LDEV is a virtual device number that does not correspond to the system configuration I/O device list.
Command Definitions (FCONTROL - FLOCK) FFILEINFO Table 5-2. FFILEINFO Itemnum/Item Values Itemnu m Item Type 13 I32 Item Description Physical count: Returns the number of buffered physical I/O operations performed since the last FOPEN/HPFOPEN call (records). 14 I16 Block size: Returns the file block size: • If the file is binary, the value is positive and the size is in half words. • If the file is ASCII, the value is negative and the size is in bytes.
Command Definitions (FCONTROL - FLOCK) FFILEINFO Table 5-2. FFILEINFO Itemnum/Item Values Itemnu m Item Type 18 CA Item Description Creator: Returns the name of the file creator (at least 8 bytes). If the file does not reside on disk, blanks are returned. An unqualified form of the file owner's name is returned as the value of this itemnum. The file owner is not neccessarily the file's creator. File ownership may be changed using the :ALTFILE command.
Command Definitions (FCONTROL - FLOCK) FFILEINFO Table 5-2. FFILEINFO Itemnum/Item Values Itemnu m Item Type 38 U16 Item Description Spoolfile device file number: Bits (0:15) = Device file number Bit (0:1) = 1 Output spoolfile Bit (0:1) = 0 Input spoolfile If the spoolfile device number is larger than 32767, itemnum 38 returns 0 (zero). Use itemnum 78 instead for spoolfile numbers larger than 32767. 40 I32 Disk device status: Returns a zero. For compatibility with MPE V/E-based systems only.
Command Definitions (FCONTROL - FLOCK) FFILEINFO Table 5-2. FFILEINFO Itemnum/Item Values Itemnu m Item Type 54 U16 Item Description File creation date (CALENDAR format) Zero is returned as the modification time for root directories, accounts, and MPE groups created prior to release 4.5. 55 U16 Last access date (CALENDAR format) Zero is returned as the modification time for root directories, accounts, and MPE groups created prior to release 4.5.
Command Definitions (FCONTROL - FLOCK) FFILEINFO Table 5-2. FFILEINFO Itemnum/Item Values Itemnu m Item Type Item Description 66 @32 Virtual address of global unique file descriptor (GUFD): 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 file label: Applicable for standard disk files only.
Command Definitions (FCONTROL - FLOCK) FFILEINFO Table 5-2. FFILEINFO Itemnum/Item Values Itemnu m Item Type 80 CA Item Description HFS syntax filename. This itemnum returns a null-terminated POSIX-syntax system absolute pathname for the file or directory referenced by filenum. On input the first four bytes of this buffer are interpreted as a 32-bit unsigned integer specifying the maximum buffer size in bytes. This maximum buffer size does not include the four bytes used to represent this size.
Command Definitions (FCONTROL - FLOCK) FFILEINFO Table 5-2. FFILEINFO Itemnum/Item Values Itemnu m Item Type 84 U16 85 CA Item Description Date of last file status change in calendar format. The bit assignements are: Bits 0 - 7 Years since 1900 Bits 8 - 15 Day of the year File Owner The full file owner name. Unused characters are blank filled. A symbolic zero (ASCII 48 in decimal) is returned as the file owner for root directories, accounts, and MPE groups created prior to the POSIX release.
Command Definitions (FCONTROL - FLOCK) FFILEINFO Table 5-2.
Command Definitions (FCONTROL - FLOCK) FFILEINFO Table 5-2.
Command Definitions (FCONTROL - FLOCK) FFILEINFO Table 5-2. FFILEINFO Itemnum/Item Values Itemnu m Item Type 94 I32 Item Description 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 filenum is closed if one the POSIX.
Command Definitions (FCONTROL - FLOCK) FFILEINFO Table 5-2. FFILEINFO Itemnum/Item Values Itemnu m Item Type 99 I32 Item Description Setuid Flag This item returns a value indicating whether or not this file has the setuid flag turned on. When the setuid flag is on for a program file, the program will execute under the user who owns the file rather than under the user who invoked the program. A value of 1 indicates that the setuid flag is on; a value of 0 indicates the flag is off.
Command Definitions (FCONTROL - FLOCK) FFILEINFO Table 5-2. FFILEINFO Itemnum/Item Values Itemnu m Item Type 103 I32 Item Description MPE Tape labels flag 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 file designator type for this file.
Command Definitions (FCONTROL - FLOCK) FFILEINFO Table 5-2. FFILEINFO Itemnum/Item Values Itemnu m Item Type 108 I32 Item Description File migrated flag This item indicates if a file’s data has been migrated off to a n off-line storage device 109 I64 0 Data has not been migrated 1 Data has been migrated File limit in bytes This item returns the maximum file size of a file in a 64-bit, signed integer. This itme will return the correct value for files of all sizes.
Command Definitions (FCONTROL - FLOCK) FFILEINFO Table 5-3.
Command Definitions (FCONTROL - FLOCK) FFILEINFO Table 5-3.
Command Definitions (FCONTROL - FLOCK) FFILEINFO Table 5-3.
Command Definitions (FCONTROL - FLOCK) FFILEINFO Table 5-3. FFILEINFO File Codes Integer Mnemonic Description 1422 GAL Reserved 1425 TTX Reserved 1461 NMOBJ Native mode object file 1462 PASLB Pascal/XL source library Table 5-4.
Command Definitions (FCONTROL - FLOCK) FFILEINFO Table 5-4. Foption Bit Summary FOPEN FOPTIONS Bits Field Meaning 10:3 Default File Designator 000=FILENAME 001=$STDLIST 010=$NEWPASS 011=$OLDPASS 100=$STDIN 101=$STDINX 110=$NULL 13:1 14:2 ASCII BINARY 0=BINARY Domain 00=New File 1=ASCII 01=Old Permanent File 10=Old Temporary File 11=Old Permanent or Temporary File Table 5-5.
Command Definitions (FCONTROL - FLOCK) FFILEINFO Table 5-5. Aoption Bit Summary FOPEN AOPTIONS Bits Field Meaning 11:1 MultiRecord Access 0=No Multi-Record Access Type 0 000=Read only 0 001=Write only 0 010=Write (Save only) 0 011=Append only 0 100=Read/Write 0 101=Update 0 110=Execute 1 001=Directory Read Access 14:2 1=Multi-Record Condition Codes CCE (2) Request granted. CCG (0) Not returned. CCL (1) Request denied. Access or calling sequence error.
Command Definitions (FCONTROL - FLOCK) FFINDBYKEY FFINDBYKEY NM and CM callable. Positions the record pointer at the beginning of the first record matching the key value comparison. NOTE For KSAM files only. Syntax I16V CA I16V I16V I16V FFINDBYKEY(filenum,value,location,length,relop); Parameters filenum 16-bit integer by value (required) Identifies the file number of the file to be positioned. value character array (required) Contains a value that determines which record is read.
Command Definitions (FCONTROL - FLOCK) FFINDBYKEY 2 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. Can be used prior to a call to FREADC to position the chronological pointer to the record located by the specified key. To locate and read a single record, use the FREADBYKEY intrinsic. Condition Codes CCE (2) Request granted. CCG (0) Request denied.
Command Definitions (FCONTROL - FLOCK) FFINDN FFINDN NM and CM callable. Positions the logical record pointer to the relative record number according to the key sequence. NOTE For KSAM files only. Syntax I16V DV I16V FFINDN(filenum,number,location); Parameters filenum 16-bit signed integer (required) Passes the file number of the file to be positioned. number double by value (required) Specifies a record number relative to the first logical record in the file.
Command Definitions (FCONTROL - FLOCK) FFINDN Condition Codes CCE (2) Request granted. CCG (0) Request denied. The requested position was beyond the logical end-of-file. CCL (1) Request denied. An error occurred.
Command Definitions (FCONTROL - FLOCK) FGETINFO FGETINFO NM and CM callable. Returns access and status information about a file. NOTE FGETINFO is provided for compatibility with MPE V/E-based systems only. It is recommended that FFILEINFO be used to access data.
Command Definitions (FCONTROL - FLOCK) FGETINFO The file domain searched to locate the file: 00 New file 01 Old permanent file 10 Old temporary file 11 Old temporary or permanent file The record format extension bit is returned as the foption (1:1) bit. Byte stream record format is represented as a record format extension of one with a variable record format (foption (8:2) bits equal to 01. Directories, symbolic links, device links, pipes and FIFO's cannot be represented by foptions.
Command Definitions (FCONTROL - FLOCK) FGETINFO 0 Nonlabeled tape 1 Labeled tape (ASC) Not valid for asynchronous device files. May have been set if file redirection was anticipated. 5:1 Disallow FILE equation foption: This option ignores any corresponding FILE command, so the specifications in the call to FOPEN/HPFOPEN take effect (unless overridden by those in the file label).
Command Definitions (FCONTROL - FLOCK) FGETINFO 11:1 10:1 8:2 0110 Execute 0111 Execute-Read 1000 Reserved 1001 Directory read access Multirecord: 0 Nonmultirecord mode 1 Multirecord mode Dynamic locking: 0 Disallow dynamic locking/unlocking 1 Allow dynamic locking/unlocking Exclusive: Specifies the access, from the time it is opened to the time it is closed: 7:1 00 Default 01 Exclusive access 10 Semi-Exclusive access 11 Shared access Inhibit buffering: Inhibits automatic buffe
Command Definitions (FCONTROL - FLOCK) FGETINFO 0 Access in file's native mode 1 Access as standard sequential file 0:3 Reserved for the operating system. lrecsize 16-bit signed integer by reference (optional) Returns the logical record size associated with the file: • If the file was created as a binary file, this value is positive and expresses the size in half words. • If the file was created as an ASCII file, this value is negative and expresses the size in bytes.
Command Definitions (FCONTROL - FLOCK) FGETINFO are the remote environment of the connection. The right eight bits (8:8) are the LDEV of the device on the remote computer where the file label resides. • If the DS device for the RFA or the LDEV is 0, then ldevnum returns a 0. hdaddr 16-bit unsigned integer by reference (optional) Returns 2048. Maintained to provide backward compatibility with MPE V/E-based systems.
Command Definitions (FCONTROL - FLOCK) FGETINFO • If the file is ASCII, the value is negative and the size is in bytes. Maintained for backward compatibility with MPE V/E-based systems. MPE V/E block size limits are imposed when FGETINFO returns block size information on all file types (STD, KSAM, RIO, CIR, MSG). If the block size of the specified file exceeds MPE V/E limits, 0 is returned.
Command Definitions (FCONTROL - FLOCK) FGETINFO opened by the calling process at the time of the FGETINFO call. Condition Codes CCE (2) Request granted. CCG (0) Not returned. CCL (1) Request denied. An error occurred.
Command Definitions (FCONTROL - FLOCK) FGETKEYINFO FGETKEYINFO NM and CM callable. Requests access and status information about a KSAM file. NOTE For KSAM files only. Syntax I16V BA BA FGETKEYINFO(filenum,param,control) Parameters filenum 16-bit signed integer by value (required) Passes the file number of the file about which information is requested. param byte array (required) Returns information describing the key information for a KSAM file. The length depends on the number of keys in the file.
Command Definitions (FCONTROL - FLOCK) FGETKEYINFO is not set to the user stack.
Command Definitions (FCONTROL - FLOCK) FINDJCW FINDJCW NM and CM callable. Searches the job control word table for a specified job control word (JCW) and returns its value. Syntax CA U16 I16 FINDJCW(jcwname,jcwvalue,jcwstatus); Parameters jcwname character array (required) 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.
Command Definitions (FCONTROL - FLOCK) FINDJCW • HPMINUTE • HPMONTH • HPYEAR Related Information Intrinsics GETJCW, PUTJCW, SETJCW Commands SETJCW, SHOWJCW Manuals Interprocess Communication Programmer's Guide and Command Interpreter Access and Variables Programmer's Guide Chapter 5 203
Command Definitions (FCONTROL - FLOCK) FINTEXIT 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 Meaning 1 Enable software interrupts (Default) 0 Disable software interrupts Operation Notes Software interrupts are set on return, according to interruptstate.
Command Definitions (FCONTROL - FLOCK) 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.
Command Definitions (FCONTROL - FLOCK) FINTSTATE The first parameter of the software interrupt procedure is the file number of the file that caused the interrupt. It is necessary to issue a call to the IODONTWAIT intrinsic against the file in order to complete the request. When reading, the buffer parameter is ignored in the FREAD call. The data is moved to the array specified by the buffer parameter of IODONTWAIT.
Command Definitions (FCONTROL - FLOCK) FLABELINFO FLABELINFO NM and CM callable. Returns information from the file label of a disk file. Syntax CA I16V I16 FLABELINFO(formaldesig,mode,fserrorcode, I16A REC I16A itemnum,item,itemerror); Parameters formaldesig character array (required) Passes a formal file designator interpreted according to MPE-escaped semantics. The file name must be terminated by a nonalphanumeric character other than a period (.), a slash (/), a hyphen (-), and an underscore (_).
Command Definitions (FCONTROL - FLOCK) FLABELINFO mode 16-bit signed integer by value (required) Passes an option specifying the valid backreferencing to file equations for the file. 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 Allows the caller to pretend to be less privileged. The privilege level is passed in this field.
Command Definitions (FCONTROL - FLOCK) FLABELINFO (Refer to Table 5-6., “FLABELINFO Itemnum/Item Values,” on page 209.) Itemnum/items are paired such that the nth field of the item record corresponds to the nth element of the itemnum array. itemerror 16-bit signed integer array (required) Returns an error number corresponding to the items specified in the itemnum array.
Command Definitions (FCONTROL - FLOCK) FLABELINFO Table 5-6. FLABELINFO Itemnum/Item Values Item num Mnem onic 6 U16 Item Description File creation date: The date in CALENDAR intrinsic format. Either creator (C) or manager (AM if file is within account, otherwise SM) access required. Zero is returned as the creation date for root directories, MPE accounts, and MPE groups created prior to release 4.5. 7 U16 Last access date: The date in CALENDAR intrinsic format.
Command Definitions (FCONTROL - FLOCK) FLABELINFO Table 5-6. FLABELINFO Itemnum/Item Values Item num Mnem onic 15 I16 Item Description Block size: Maintained for compatibility with MPE V/E-based systems. (If a zero is returned, use itemnum 31 instead.) 16 I16 Maximum number of extents: Maintained for compatibility with MPE V/E-based systems. (If a zero is returned, use itemnum 32 instead.) 17 I16 Last extent size: Indicates sectors. May not be up-to-date when the file is open.
Command Definitions (FCONTROL - FLOCK) FLABELINFO Table 5-6. FLABELINFO Itemnum/Item Values Item num Mnem onic 28 U32 Item Description Total number of bytes allowed in file: Equivalent to the file limit measured in bytes. May not be up-to-date when the file is open. If the file limit of the file is larger than 4gb, this item will return FSERR 311. Item number 62 returns the file limit of the file in bytes, in a 64-bit value which can safely be used for all files.
Command Definitions (FCONTROL - FLOCK) FLABELINFO Table 5-6. FLABELINFO Itemnum/Item Values Item num Mnem onic 38 REC Item Description Terminated HFS-syntax system absolute pathname: Upon input, the first four bytes are interpreted as a 32-bit unsigned integer specifying the maximum available buffer size in bytes. This maximum available buffer size does not include the four bytes used to represent this size.
Command Definitions (FCONTROL - FLOCK) FLABELINFO Table 5-6. FLABELINFO Itemnum/Item Values Item num Mnem onic 41 I32 Item Description Time of last file status change (clock format): The bit assignments are: bits bits bits bits 42 U16 0-7 = hours 8-15 = minutes 16-23 = seconds 24-31 = tenths of seconds Date of the last file status change (calendar format): The bit assignments are: bits 0-7 = years since 1900 bits 8-15 = day of the year 43 CA File owner (32 bytes): The full file owner name.
Command Definitions (FCONTROL - FLOCK) FLABELINFO Table 5-6.
Command Definitions (FCONTROL - FLOCK) FLABELINFO Table 5-6. FLABELINFO Itemnum/Item Values Item num Mnem onic 50 I32 Item Description KSAM XL and KSAM64 File Version: This item returns a value indicating the version number of a KSAM XL or KSAM64 file. A value of 1 indicates an original type KSAM XL file. A value of 2 indicates the next generation KSAM XL file. A value of zero is returned if the file is not a KSAM XL file. A value of 4 indicates a KSAM64 file.
Command Definitions (FCONTROL - FLOCK) FLABELINFO Table 5-6. FLABELINFO Itemnum/Item Values Item num Mnem onic 56 I32 Item Description File compressed flag This value indicates whether or not the data in the specified file is compressed or not. 57 I32 0 data is not compressed 1 data is compressed File migrated flag This value indicates wheter or not the data in the specidfied file has been migrated off of disk.
Command Definitions (FCONTROL - FLOCK) FLABELINFO Table 5-6. FLABELINFO Itemnum/Item Values Item num Mnem onic 64 I32 Item Description Large file flag This flag indicates whether or not the specified file’s file limit is large (greater than 4GB- 64KB or 4,294,901,760 bytes) Note that this applies to the file limit or potential capacity of the file only , and not to the actural amount of disk space allocated to the file.. 0 file is not large 1 file is large Condition Codes CCE (2) Request granted.
Command Definitions (FCONTROL - FLOCK) FLOCK FLOCK NM and CM callable. Dynamically locks a file. If dynamically locking more than one RIN, multiple RIN (MR) capability is required. Syntax I16V U16V FLOCK(filenum,lockflag); Parameters filenum 16-bit signed integer by value (required) Passes the file number of the file whose global resource identification number (RIN) is to be locked.
Command Definitions (FCONTROL - FLOCK) FLOCK The following condition codes are possible when lockflag bit (15:1)=0: CCE (2) Request granted. CCG (0) Request denied. The file was locked by another process. CCL (1) Request denied. This file was not opened with the dynamic locking aoption bit (10:1) specified 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.
6 Command Definitions (FLUSHLOG-GETUSERMODE) 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 files only. (ASC) For use with asynchronous serial communications only. (SPL) For use with SPL programming language only.
Command Definitions (FLUSHLOG-GETUSERMODE) FLUSHLOG FLUSHLOG NM and CM callable. Flushes the contents of the user logging memory buffer to the user logging file. User logging (LG) or system supervisor (OP) capability is required. Syntax I32 I16 FLUSHLOG(index,logstatus); Parameters index 32-bit signed integer by reference (required) Passes the access to the user logging system. This is the value returned in the index parameter of the OPENLOG intrinsic.
Command Definitions (FLUSHLOG-GETUSERMODE) FMTCALENDAR FMTCALENDAR NM and CM callable.
Command Definitions (FLUSHLOG-GETUSERMODE) FMTCLOCK FMTCLOCK NM and CM callable.
Command Definitions (FLUSHLOG-GETUSERMODE) FMTDATE FMTDATE NM and CM callable.
Command Definitions (FLUSHLOG-GETUSERMODE) FOPEN FOPEN NM and CM callable. Establishes access to a file and defines the physical characteristics of the file prior to access.
Command Definitions (FLUSHLOG-GETUSERMODE) FOPEN If formaldesig is the name of a user-defined file, it can begin with an asterisk (*). If formaldesig is the name of a system-defined file, it can begin with a dollar sign ($). When creating a KSAM file, formaldesig must be a unique file name, that is, one not currently existing in the permanent file directory. The formal file designator can contain command interpreter variables and expressions that are evaluated before formaldesig is parsed and validated.
Command Definitions (FLUSHLOG-GETUSERMODE) FOPEN when you issue a direct-write intrinsic call (FWRITEDIR) to a record that lies beyond the current logical end-of-file indicator. By default, magnetic tape and files are treated as ASCII files. This option is applicable only at file creation. The following bit settings are valid: 0 Binary file 1 ASCII file (ASC) Not valid for asynchronous device files. Default: 0 Bits Value/Meaning 10.3 Designator Passes a value indicating a special file opening.
Command Definitions (FLUSHLOG-GETUSERMODE) FOPEN 8.2 Record format Bit settings indicate internal record structure for a file. This option is applicable only at file creation. The following bit settings are valid: 00 Fixed-length records. The file contains logical records of uniform length. Fixed-length records are supported by disk and magnetic tape devices only. 01 Variable-length records. The file contains logical records of varying length.
Command Definitions (FLUSHLOG-GETUSERMODE) FOPEN can be specified on files specified with carriage-control either by embedding the control in the record or by sending the control code directly through the controlcode parameter of FWRITE. Carriage control is supplied only for ASCII files. This option and the ASCII/binary option (foption bit (13:1)) are mutually exclusive, and attempts to open new files with both binary and carriage control directives result in an access violation.
Command Definitions (FLUSHLOG-GETUSERMODE) FOPEN Default: 0 2.3 File type option Indicates internal record structure used to access records in a file. If the file is old, this option is ignored. Specifying a designator option (foption bits (10:3)) value other than zero overrides this option. This option is applicable only at file creation.
Command Definitions (FLUSHLOG-GETUSERMODE) FOPEN Bits Value/Meaning 12.4 Access type Indicates the type of access intended for the file. This option restricts/allows minimal use of file system intrinsics. The following bit settings are valid: 232 0000 Allows read access only, if the file's security provisions specify read access. FWRITE, FUPDATE, and FWRITEDIR intrinsic calls cannot reference this file. The end-of-file (EOF) is not changed; the record pointer starts at 0.
Command Definitions (FLUSHLOG-GETUSERMODE) FOPEN intrinsics, including FUPDATE, can be called for this file. The EOF is not changed; the record pointer starts at 0. This option is not valid for message files. 11.1 0110 Allows execute access only if the file's security provisions allow execute access. This access allows read/write access to any loaded file. The program must be running in PM to specify execute access. This option is not valid for message files. 1000 Reserved for the operating system.
Command Definitions (FLUSHLOG-GETUSERMODE) FOPEN Dynamic locking/unlocking is made possible through the equivalent of a global resource identification number (RIN) assigned to the file and temporarily acquired by FOPEN. Cooperating accessors that have opened a file with the dynamic locking option enabled must access the file using either the FLOCK and FUNLOCK intrinsics to ensure exclusive use of the file.
Command Definitions (FLUSHLOG-GETUSERMODE) FOPEN 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. If a process already has write access to the file when this call is issued, an error code is returned to the calling process.
Command Definitions (FLUSHLOG-GETUSERMODE) FOPEN transfer whole blocks leave the next record pointer set to the first record in the next block. The EOF marker always points at the last record in the file. For files opened NOBUF, the FREADDIR, FWRITEDIR, and FPOINT intrinsics treat the recnum parameter as a block number. Indicate non-RIO access to an RIO file by specifying the file NOBUF. Use the physical block size from FFILEINFO to determine the maximum transfer length.
Command Definitions (FLUSHLOG-GETUSERMODE) FOPEN implies the inhibit buffering option (aoption bit (7:1)); if NOBUF is not specified, the file system does it for you and multirecord access is not available. This option is not available if the file is located on a remote computer. When opening nonmessage files, the process must be running in privileged mode to specify this option.
Command Definitions (FLUSHLOG-GETUSERMODE) FOPEN value (the next half word boundary). Default: Device dependent; refer to the Accessing Files Programmer's Guide for default record sizes. device character array (optional) Passes a string of ASCII characters terminating with any nonalphanumeric excluding a slash (/) or period (.), designating the device where the file is to reside.
Command Definitions (FLUSHLOG-GETUSERMODE) FOPEN that the disk file is restricted to the volume class whose name is specified in volclass. The specified volume class must reside within the volume set bound to the group where the file resides. This option is applicable only at file creation. devname device name option Passes the logical device number, in ASCII format, of a specific device. The file is assumed to be permanent.
Command Definitions (FLUSHLOG-GETUSERMODE) FOPEN reading from a tape, the density of the tape overrides the density value specified. To specify density when writing to the tape file, use the keyword ;DEN=. Default: The highest density available on the device opened ;ENV= printenv printer environment option Passes the name of a file that contains a printer environment. Valid only for specified printers.
Command Definitions (FLUSHLOG-GETUSERMODE) FOPEN .[volid[,type[,exp[,seq]]]]; The period is required so that the tape label information is not mistaken for a forms message. volid Volume identifier, consisting of <=6 printable characters. In a multivolume set, specify only the first volid.
Command Definitions (FLUSHLOG-GETUSERMODE) FOPEN parameter. userlabels 16-bit signed integer by value (optional) Passes the number, in the range 0..254, of user-label records to be created for the file. Applicable to new disk files only. Default: 0 (ASC) Not valid for asynchronous device files. blockfactor 16-bit signed integer by value (optional) Passes the number of logical records in one physical record (block).
Command Definitions (FLUSHLOG-GETUSERMODE) FOPEN (such as tapes) used in a buffered mode, and is not applicable for files representing interactive terminals. This option must not specify a number of buffers whose combined size exceeds the physical capacity of the file. Default: 00010 (decimal 2) 4:7 Spooler copies Indicates the number of copies of the file to be produced by the spooling facility. The valid range is 0...127. This option is applicable to spooled devices only.
Command Definitions (FLUSHLOG-GETUSERMODE) FOPEN Applicable only at file creation. Default: 1023 records (ASC) Not valid for asynchronous device files. numextent 16-bit signed integer by value (optional) Passes a value in the range 1..32 that determines the number of extents for the file. If a value of 1 and an initialloc value of 1 is specified, the file is created as one contiguous extent of disk space.
Command Definitions (FLUSHLOG-GETUSERMODE) FOPEN Table 6-1.
Command Definitions (FLUSHLOG-GETUSERMODE) FOPEN Table 6-1. FOPEN/HPFOPEN Parameter Equivalents FOPEN Parameter HPFOPEN Itemnum,Item numextent 47, numextent initialloc 36, initial allocation filecode 37, filecode Operation Notes A file can be referenced by its formal file designator. When executed, a unique file number is returned to the process. This file number can be used, rather than the formal file designator, in other calls to this file.
Command Definitions (FLUSHLOG-GETUSERMODE) FPARSE FPARSE NM and CM callable. Parses and validates file 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 file reference string to be parsed. Terminate the string with any nonalphanumeric character except a slash (/), period (.), or colon (:).
Command Definitions (FLUSHLOG-GETUSERMODE) FPARSE -1 Invalid item values -2 Parameter bounds violation -3 Illegal delimiter; misuse of .
Command Definitions (FLUSHLOG-GETUSERMODE) FPARSE corresponding vector parameter points to: vector 32-bit signed integer array (optional) Returns vectors, one per element, for the requested item. NOTE A vector cannot be passed without a corresponding item value. Information is returned as follows: Bits Value/Meaning 16:16 Return the length of the string specified by the corresponding items parameter. If zero is returned, the requested item in formaldesig was not specified.
Command Definitions (FLUSHLOG-GETUSERMODE) FPOINT FPOINT NM and CM callable. Sets the logical record pointer for a disk file containing fixed-length or undefined-length records to any logical record. When the next FREAD or FWRITE file request is made, this record is read or written to. (KSAM) Sets both the chronological and logical record pointers to the next record in chronological sequence (the order records were written to the file).
Command Definitions (FLUSHLOG-GETUSERMODE) FPOINT • Spooled file • Not a direct access disk file • File does not contain fixed-length or undefined-length records • Not allowed with append access (KSAM) The filenum parameter was invalid or lrecnum specified a record marked for deletion. Operation Notes Not applicable to message files.
Command Definitions (FLUSHLOG-GETUSERMODE) FREAD FREAD NM and CM callable. Reads a logical record or portion of a record from a file to the stack. Syntax I16 I16V UDS I16V transfercount:=FREAD(filenum,buffer,length); Functional Return transfercount 16-bit signed integer (assigned functional return) Returns the length of the data transferred to buffer: • If a negative value is passed in the length parameter, transfercount is a positive value indicating the number of bytes transferred.
Command Definitions (FLUSHLOG-GETUSERMODE) FREAD >0 Length in half words If length is larger than the size of the logical record, and the multirecord aoption in FOPEN/HPFOPEN was not specified, transfer is limited to the length of the logical record. If the multirecord aoption in FOPEN/HPFOPEN is specified, transfer continues until either length is satisfied or end-of-data is encountered, and each transfer begins at the start of the next physical record (block).
Command Definitions (FLUSHLOG-GETUSERMODE) FREAD Condition Codes CCE (2) Request granted. The information was read. CCG (0) Request denied. The logical end-of-data was encountered during reading. When reading a labeled magnetic tape file that spans more than one volume, CCG (0) is not returned when end-of-tape (EOT) is encountered. CCG (0) is returned at actual end-of-file, with a transmission log of 0 if there is an attempt to read past end-of-file. CCL (1) Request denied.
Command Definitions (FLUSHLOG-GETUSERMODE) FREADBACKWARD FREADBACKWARD NM and CM callable. Reads a logical record backward from the current record pointer. Data is presented as if read forward. Used for tape files only. Can recover tape errors when handling I/O management and data recovery routines.
Command Definitions (FLUSHLOG-GETUSERMODE) FREADBACKWARD If length is larger than the size of the logical record, and the multirecord aoption in FOPEN/HPFOPEN was not specified, transfer is limited to the length of the logical record. If the multirecord aoption in FOPEN/HPFOPEN is specified, transfer continues until either length is satisfied or end-of-data is encountered, and each transfer begins at the start of the next physical record (block).
Command Definitions (FLUSHLOG-GETUSERMODE) FREADBYKEY FREADBYKEY NM and CM callable. Reads a logical record randomly from a KSAM file to the data stack. NOTE For KSAM files only. Syntax I16V I16V LA I16V CA length:=FREADBYKEY(filenum,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.
Command Definitions (FLUSHLOG-GETUSERMODE) FREADBYKEY determines which record is to be read. The first byte is numbered as 1. If a value of zero is specified, the primary key is used. Condition Codes CCE (2) Request granted. CCG (0) Request denied. The logical end-of-data or beginning-of-data was encountered during the read. CCL (1) Request denied. An error occurred. Either an I/O error occurred or the key could not be located.
Command Definitions (FLUSHLOG-GETUSERMODE) FREADC FREADC NM and CM callable. FREADC returns records in physical sequence, not chronological sequence. For KSAM/XL files with the REUSE option, physical is not equal to chronological sequence and FREADC reads the file in physical sequence. Deleted records are not returned using the FREADC intrinsic, the FREADDIR intrinsic must be used if deleted records are required. NOTE For KSAM files only.
Command Definitions (FLUSHLOG-GETUSERMODE) FREADC Related Information Manuals 260 Using KSAM XL and KSAM/3000 Reference Manual Chapter 6
Command Definitions (FLUSHLOG-GETUSERMODE) FREADDIR FREADDIR NM and CM callable. Reads a specific logical record or portion of a record from a direct-access disk file to the data stack. Syntax I16V UDS I16V I32V FREADDIR(filenum,buffer,length,lrecnum); Parameters filenum 16-bit signed integer by value (required) Passes the file number of the file to be read. buffer user-defined structure (required) Returns the record that was read.
Command Definitions (FLUSHLOG-GETUSERMODE) FREADDIR active and inactive records.) If an RIO file is accessed using the non-RIO method (NOBUF), FREADDIR inputs the specified block. After the FREADDIR intrinsic is executed, the logical record pointer is set to the beginning of the next logical record, or the first logical record of the next block for NOBUF files.
Command Definitions (FLUSHLOG-GETUSERMODE) FREADLABEL FREADLABEL NM and CM callable. Reads a user-defined label from a disk or magnetic tape file. Syntax I16V UDS I16V I16V FREADLABEL(filenum,buffer,length,labelid); Parameters filenum 16-bit signed integer by value (required) Passes the file number of the file whose label is to be read. buffer user-defined structure (required) Returns the label that was read. This structure must be large enough to hold the number of half words specified by length.
Command Definitions (FLUSHLOG-GETUSERMODE) FREADLABEL CCL (1) Request denied. The label was not read; an error occurred.
Command Definitions (FLUSHLOG-GETUSERMODE) FREADSEEK FREADSEEK NM and CM callable. Moves a record from a disk file to a buffer in anticipation of a FREADDIR intrinsic call. Syntax I16V I32V FREADSEEK(filenum,lrecnum); Parameters filenum 16-bit signed integer by value (required) Passes the file number of the file to be read. lrecnum 32-bit signed integer by value (required) Passes the relative number of the logical record to be read. A value of zero indicates the first logical record.
Command Definitions (FLUSHLOG-GETUSERMODE) FREEDSEG FREEDSEG NM and CM callable. Releases an extra data segment assigned it by the GETDSEG intrinsic. Data segment management (DS) capability is required. NOTE 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.
Command Definitions (FLUSHLOG-GETUSERMODE) FREEDSEG Related Information Manual Chapter 6 Introduction to MPE XL for MPE V Programmers 267
Command Definitions (FLUSHLOG-GETUSERMODE) FREELOCRIN FREELOCRIN NM and CM callable. Frees all local resource identification 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) Request granted. CCG (0) Request denied. No RINs are currently reserved for the job. CCL (1) Request denied. A minimum of one RIN is currently locked by a process.
Command Definitions (FLUSHLOG-GETUSERMODE) FRELATE FRELATE NM and CM callable. Determines whether a file pair (on any device) is interactive, duplicative, or both interactive and duplicative.
Command Definitions (FLUSHLOG-GETUSERMODE) FRELATE Condition Codes CCE (2) Request granted. CCG (0) Request denied. Infilenum and/or listfilenum corresponds to $NULL (a logical file that contains no data). No data can be read from this file, and all data written to it is discarded. Interactive or duplicative functions do not apply. CCL (1) Request denied. An error occurred.
Command Definitions (FLUSHLOG-GETUSERMODE) FREMOVE FREMOVE NM and CM callable. Marks the current record in a KSAM file for deletion. NOTE For KSAM files only. Syntax I16V FREMOVE(filenum) Parameters filenum 16-bit signed integer by value (required) Passes the file number of the file where the record is to be deleted. Operation Notes Split stack calls are permitted. Deleted records can be read with this intrinsic.
Command Definitions (FLUSHLOG-GETUSERMODE) FRENAME FRENAME NM and CM callable. Renames an open disk file (and its lockword, if applicable). The file being renamed must be either: • A new file. • An old file (permanent or temporary), opened for exclusive access with the exclusive option of the HPFOPEN/FOPEN intrinsics, and with security provisions allowing write access.
Command Definitions (FLUSHLOG-GETUSERMODE) FRENAME remote location of a device If formaldesig is the name of a user-defined file, it can begin with an asterisk (*). If formaldesig is the name of a system-defined file, it can begin with a dollar sign ($). When creating a KSAM file, formaldesig must be a unique file name, that is, one not currently existing in the permanent file directory.
Command Definitions (FLUSHLOG-GETUSERMODE) FRENAME If a file without an ACD is renamed from an MPE group to a directory (although not within the same account), an ACD is automatically assigned to the file. All errors will set the condition codes to CCL. (KSAM) Although FRENAME will work on CM KSAM files, it renders them unuseable until they are reassigned their original names. To rename a CM KSAM file, use the KSAMUTIL RENAME command. Condition Codes CCE (2) Request granted. CCG (0) Not returned.
Command Definitions (FLUSHLOG-GETUSERMODE) FSETMODE FSETMODE NM and CM callable. Controls the following access modes of files or devices: • Issuing carriage return and line feed to terminal after a terminal read. • Reporting tape automatic error recovery. • Guaranteeing chronological order of user program write requests. • Blocking program execution until physical completion of write requests.
Command Definitions (FLUSHLOG-GETUSERMODE) FSETMODE 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. The possible values are: 1 Activate output verification: All output to the file is verified as physically complete before an FWRITE, FUPDATE, or FREMOVE intrinsic returns control to the user. When a logical record is written, a CCE (2) condition is returned.
Command Definitions (FLUSHLOG-GETUSERMODE) FSETMODE Condition Codes CCE (2) Request granted. CCG (0) Not returned. CCL (1) Request denied. An error occurred.
Command Definitions (FLUSHLOG-GETUSERMODE) FSPACE FSPACE NM and CM callable. Moves a record pointer forward or backward on a magnetic tape or disk file, spaces physical records on magnetic tape files and logical records on disk files. Syntax I16V I16V FSPACE(filenum,displacement); Parameters filenum 16-bit signed integer by value (required) Passes the file number of the file on which spacing is to be done.
Command Definitions (FLUSHLOG-GETUSERMODE) FSPACE CCG (0) Request denied. An end-of-file indicator was encountered during spacing. For disk files, this is the file limit, and the logical record pointer is not changed. For magnetic tape files, this is the end-of-file mark, and the logical record pointer points to the (logical) end-of-file. The magnetic tape is positioned to one record past the file mark on the tape. For labeled tape, the logical record pointer is at the file mark. CCL (1) Request denied.
Command Definitions (FLUSHLOG-GETUSERMODE) FUNLOCK FUNLOCK NM and CM callable. Dynamically unlocks a file's global resource identification number (RIN) that was locked with the FLOCK intrinsic. Syntax I16V FUNLOCK(filenum); Parameters filenum 16-bit signed integer by value (required) Passes the file number of the file whose global RIN is to be unlocked. Condition Codes CCE (2) Request granted. CCG (0) Request denied. The calling process did not lock the file. CCL (1) Request denied.
Command Definitions (FLUSHLOG-GETUSERMODE) FUPDATE FUPDATE NM and CM callable. Updates (writes) a logical record in a disk file. Syntax I16V UDS I16V FUPDATE(filenum,buffer,length); Parameters filenum 16-bit signed integer by value (required) Passes the file number of the file to be updated. buffer user-defined structure (required) Passes the record to be written in the update. length 16-bit signed integer by value (required) Passes the number of half words or bytes to be written to the file.
Command Definitions (FLUSHLOG-GETUSERMODE) FUPDATE Operation Notes This intrinsic affects the logical record (or block for NOBUF files) of the file last referenced by any intrinsic call, except an FPOINT call, which affects the record prior to the last record referenced. FUPDATE moves the specified information from the stack into this record. The file containing this record must be opened with the update aoption specified in the FOPEN/HPFOPEN call and the file cannot have variable-length records.
Command Definitions (FLUSHLOG-GETUSERMODE) FWRITE FWRITE NM and CM callable. Writes a logical or physical record or portion of a record from the stack to a file on any device. Syntax I16V UDS I16V U16V FWRITE(filenum,buffer,length,controlcode); Parameters filenum 16-bit signed integer by value (required) Passes the file number of the file to be written on. buffer user-defined structure (required) Passes the record to be written.
Command Definitions (FLUSHLOG-GETUSERMODE) FWRITE 0 Print the full record transferred, using single spacing. This results in a maximum of 132 characters per printed line. 1 Use the first character of the data written to satisfy space control and suppress this character on the printed output. This results in a maximum of 132 characters of data per printed line. Use any octal code from Table 6-2. on page 284 to determine space control and print the full record transferred.
Command Definitions (FLUSHLOG-GETUSERMODE) FWRITE Table 6-2. Carriage Control Directives Octal Code (ASCII) Description of Carriage Action %56 - %57 (" ") Single space (with or without automatic page eject) %60 ("0") Double space (with or without automatic page eject) %61 ("1") Conditional page eject (form feed) performed by the software; if the printer is not at top-of-form, a page eject is performed.
Command Definitions (FLUSHLOG-GETUSERMODE) FWRITE Table 6-2.
Command Definitions (FLUSHLOG-GETUSERMODE) FWRITE but the perforation between pages is not automatically skipped. For the Hewlett-Packard 2608S and 2563A, if auto-eject and feature mode are in effect, a code of %60 is replaced by two codes of %302, and a code of %55 is replaced by three codes of %302. The resulting skip is double or triple space with auto-eject, respectively. Figure 6-2.
Command Definitions (FLUSHLOG-GETUSERMODE) FWRITE indicator is advanced. However, this is noted in the file label only when the file is closed or when an extent is allocated. If the physical bounds of the file are reached, CCG (0) is returned. If a magnetic tape is unlabeled (as specified in the FOPEN/HPFOPEN intrinsic, or in the FILE command) and the program attempts to write over or beyond the physical or simulated end-of-tape (EOT) marker, the FWRITE intrinsic returns CCL (1).
Command Definitions (FLUSHLOG-GETUSERMODE) FWRITEDIR FWRITEDIR NM and CM callable. Writes a specific logical record from the stack to a disk file. Syntax I16V UDS I16V I32V FWRITEDIR(filenum,buffer,length,lrecnum); Parameters filenum 16-bit signed integer by value (required) Passes the file number of the file to be written to. buffer user-defined structure (required) Passes the record to be written. This structure should be large enough to hold all of the information to be transferred.
Command Definitions (FLUSHLOG-GETUSERMODE) FWRITEDIR composed of fixed-length or undefined-length records. When information is written to a fixed-length record and NOBUF is not specified in the FOPEN/HPFOPEN call that opens the file, any unused portion of the record is padded with binary zeros or ASCII blanks. When the FWRITEDIR intrinsic is executed, the logical record pointer is set to the record immediately following the record just written, or the first logical record of the next block for NOBUF files.
Command Definitions (FLUSHLOG-GETUSERMODE) FWRITELABEL FWRITELABEL NM and CM callable. Writes a user-defined label onto a disk file or magnetic tape file that is labeled with an ANSI-standard or IBM-standard label. It also overwrites old user labels. Syntax I16V UDS I16V I16V FWRITELABEL(filenum,buffer,length,labelid); Parameters filenum 16-bit signed integer by value (required) Passes the file number of the file to be labeled. buffer user-defined structure (required) Passes the label to be written.
Command Definitions (FLUSHLOG-GETUSERMODE) FWRITELABEL Reference Manual 292 Chapter 6
Command Definitions (FLUSHLOG-GETUSERMODE) GENMESSAGE GENMESSAGE NM and CM callable (differences noted below). Provides access to messages in catalogs that were formatted with the MAKECAT utility.
Command Definitions (FLUSHLOG-GETUSERMODE) GENMESSAGE parmask 16-bit signed integer by value (optional) Passes a mask indicating parameter types for param1 through param5.
Command Definitions (FLUSHLOG-GETUSERMODE) GENMESSAGE Default: $STDLIST if you do not specify buffer, no file if you do specify buffer. errornum 16-bit signed integer by reference (optional) Returns one of the following values, indicating the success or failure of the intrinsic call.
Command Definitions (FLUSHLOG-GETUSERMODE) GENMESSAGE CCG (0) Request denied. Missing required parameter, invalid parameter, or invalid file number of catalog or destination file.
Command Definitions (FLUSHLOG-GETUSERMODE) GETDSEG GETDSEG NM and CM callable. Creates or acquires an extra data segment for use by the process. Data segment management (DS) capability is required. NOTE 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.
Command Definitions (FLUSHLOG-GETUSERMODE) GETDSEG to reference the extra data segment in later intrinsic calls. Assign the extra data segment to an identity that either allows other processes in the job or session to share the extra data segment, or that declares it private to the calling process. If the extra data segment is shareable, other processes can obtain its index (through GETDSEG) and use this index to reference the extra data segment.
Command Definitions (FLUSHLOG-GETUSERMODE) 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 Meaning 0 Successful execution. 1 Execution error, one of the following conditions exist: • Infostring was specified, but infolength was not specified.
Command Definitions (FLUSHLOG-GETUSERMODE) GETINFO 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. If infolength is too small, the information string is truncated upon return to infostring. Infostring and infolength must be specified as a pair.
Command Definitions (FLUSHLOG-GETUSERMODE) GETJCW GETJCW NM and CM callable. Returns the value of the system-defined 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.
Command Definitions (FLUSHLOG-GETUSERMODE) GETLOCRIN GETLOCRIN NM and CM callable. Acquires local resource identification 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 defined when the system is configured. Operation Notes All local RINs required by a job/session must be acquired in a single call to GETLOCRIN.
Command Definitions (FLUSHLOG-GETUSERMODE) 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.
Command Definitions (FLUSHLOG-GETUSERMODE) GETPRIORITY 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) 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 identification number (PIN) of a child process.
Command Definitions (FLUSHLOG-GETUSERMODE) GETPRIORITY NOTE rank Scheduling a process into the AS or BS priority class can result in the rescheduled process deadlocking the system or locking out system and user processes from execution. 16-bit signed integer by value (optional) Used for backward-compatibility with pre-MPE IV operating systems only. Operation Notes A process must be running in privileged mode to specify absolute priority.
Command Definitions (FLUSHLOG-GETUSERMODE) GETPRIVMODE 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 file integrity, including the operating system software itself. Hewlett-Packard will investigate and attempt to resolve problems resulting from the use of PM code.
Command Definitions (FLUSHLOG-GETUSERMODE) GETPROCID GETPROCID NM and CM callable. Returns the process identification 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 specified child process. Parameters numchild 16-bit signed integer by value (required) Passes a number indicating which child's PIN GETPROCID returns.
Command Definitions (FLUSHLOG-GETUSERMODE) GETPROCINFO GETPROCINFO NM and CM callable. Returns status information about the parent or a child process. Process handling (PH) capability is required.
Command Definitions (FLUSHLOG-GETUSERMODE) GETPROCINFO 8:8 Process priority number in master queue 0:8 Reserved for the operating system 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 identification number (PIN) of that process. Condition Codes CCE (2) Request granted. CCG (0) Request denied.
Command Definitions (FLUSHLOG-GETUSERMODE) GETUSERMODE GETUSERMODE NM and CM callable. Dynamically returns a program to nonprivileged mode. Syntax GETUSERMODE; Condition Codes CCE (2) Request granted. The program was in privileged mode at the time of the intrinsic call. CCG (0) Request granted. The program was in nonprivileged mode at the time of the intrinsic call. CCL (1) Not returned.
7 Command Definitions (HP32208-HPLOACNMPROC) 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 files only. (ASC) For use with asynchronous serial communications only. (SPL) For use with SPL programming language only.
Command Definitions (HP32208-HPLOACNMPROC) HP32208 HP32208 CM callable only. Returns the current VUF (version, update, fix 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 Version (ASCII format) 8:8 Update (binary format) 16:16 Fix level (binary format) Operation Notes This intrinsic is for use with KSAM files only.
Command Definitions (HP32208-HPLOACNMPROC) HPACDINFO HPACDINFO Lists security information from the access control definition (ACD) of a specified file or device. Syntax I32 IV * HPACDINFO(status,itemnum1,item1 IV * [,itemnum2,item2][,...]); NOTE A maximum of four itemnum2/item2 pairs can be specified. The last specified itemnum2/item2 pair takes precedence over all identical itemnum2/item2 pairs specified. Any conflict produces a warning message.
Command Definitions (HP32208-HPLOACNMPROC) HPACDINFO Table 7-1. HPACDINFO Itemnum1/Item1 Values Itemnum Mnemonic Item Description The following constants have been defined for a file or device request: 1 BA Specifies the target file name. The item1 value specified must be a byte array of 1 to 35 characters (for MPE filenames), word aligned.
Command Definitions (HP32208-HPLOACNMPROC) HPACDINFO Table 7-2. HPACDINFO Itemnum2/Item2 Values Itemnum Mnemonic Item Description 30 BA Specifies the user whose ACD information is to be returned. The item2 value specified 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. 31 BA Returns ACD modes in ASCII format.
Command Definitions (HP32208-HPLOACNMPROC) HPACDINFO Table 7-2. HPACDINFO Itemnum2/Item2 Values Itemnum Mnemonic Item Description 35 BA Returns the next user in the ACD. The item2 value returned is a 1 to 18 character byte array. Operation Notes The HPACDINFO intrinsic lists the requested security attributes of a specified file or device. Three types of itemnum/item pair descriptors can be used to define supplied input or to specify returned ACD information.
Command Definitions (HP32208-HPLOACNMPROC) HPACDPUT HPACDPUT Manipulates security information in the access control definition (ACD) of a specified file 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.
Command Definitions (HP32208-HPLOACNMPROC) HPACDPUT item2 Type varies by reference (required) Passes the information to be used to manipulate the ACD of the specified file or device. Functionality requests can be made using one of the predefined itemnum2/item2 pairs. Refer to Table 7-4., “HPACDPUT Itemnum2/Item2 Values,” on page 319. Table 7-3. HPACDPUT Itemnum1/Item1 Values Itemnum Mnemonic Item Description 1 BA Specifies the target file name.
Command Definitions (HP32208-HPLOACNMPROC) HPACDPUT Table 7-4. HPACDPUT Itemnum2/Item2 Values Itemnum Mnemonic 20 BA Create a new ACD. The item2 value specified must be a 1 to 279 character byte array. 21 BA Add ACD pairs. The item2 value specified must be a 1 to 279 character byte array. 22 BA Replace ACD pairs. The item2 value specified must be a 1 to 279 character byte array. 23 BA Delete ACD pairs. The item2 value specified must be a 1 to 279 character byte array. 24 N/A Delete an ACD.
Command Definitions (HP32208-HPLOACNMPROC) HPACDPUT Table 7-4. HPACDPUT Itemnum2/Item2 Values Itemnum Mnemonic Item Description 32 BA Replace ACD pairs. The item2 value specified must be specified using either MPE or HFS name syntax file name. HFS pathnames must begin with a dot (.) or slash (/) character and cannot exceed 1024 characters, including the dot or slash and the null character terminator. MPE filenames < 35 characters must be terminated with a null character or a carriage return.
Command Definitions (HP32208-HPLOACNMPROC) HPCALENDAR HPCALENDAR NM callable only. This intrinsic returns the date in the supported date type code 4 listed in the table, “Supported Date Formats.” Syntax I32 date := HPCALENDAR; Operation Notes Where date is the 32-bit unsigned integer (assigned functional return).
Command Definitions (HP32208-HPLOACNMPROC) HPCICOMMAND HPCICOMMAND NM callable only. Executes a command programmatically. Syntax CA I16 I16 I16V HPCICOMMAND(cmdimage,cmderror,parmnum,msglevel); Parameters cmdimage 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 Definitions (HP32208-HPLOACNMPROC) HPCICOMMAND NOTE Check the cmderror parameter to verify if cmdimage succeeded. The parmnum may provide additional information.
Command Definitions (HP32208-HPLOACNMPROC) HPCIDELETEVAR 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) 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.
Command Definitions (HP32208-HPLOACNMPROC) 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) Passes the name of a session-level variable whose value is to be retrieved.
Command Definitions (HP32208-HPLOACNMPROC) HPCIGETVAR NOTE 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. Table 7-5. HPCIGETVAR Itemnum/Item Values Itemnum Mnemonic 0 1 Item Description Itemnum/item pair ignored I32 Integer value of variable (output): 0 if variable is not an integer.
Command Definitions (HP32208-HPLOACNMPROC) HPCIGETVAR Related Information Intrinsics HPCIPUTVAR, HPCIDELETEVAR Commands DELETEVAR, SETVAR, SHOWVAR Manuals Command Interpreter Access and Variables Programmer's Guide and MPE/iX Commands Reference Manual Chapter 7 327
Command Definitions (HP32208-HPLOACNMPROC) 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 specified. Parameters varname character array (required) Passes the name of a session-level variable for which the value needs to be set.
Command Definitions (HP32208-HPLOACNMPROC) HPCIPUTVAR Passes the variable information specified in itemnum. Refer to Table 7-6., “HPCIPUTVAR Itemnum/Item Values,” on page 329. Table 7-6. HPCIPUTVAR Itemnum/Item Values Itemnun Mnemonic 0 1 Item Description Itemnum/item pair ignored I32 Integer value assigned to specified variable name (input): No other pairs are needed and, if specified, will cause an error. Default: Not considered an integer value.
Command Definitions (HP32208-HPLOACNMPROC) HPCIPUTVAR Table 7-7. HPCIPUTVAR itemnum 14 with item values Value of item Value of var_value 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 Operation Notes Allows the value of a session-level variable to be set.
Command Definitions (HP32208-HPLOACNMPROC) HPDATECONVERT HPDATECONVERT NM callable only. Converts the dates from one supported format to another. Syntax I32V * I32V * I32V I32V HPDATECONVERT(inputcode,inputdate,outputcode,outputdate,status,cutoff) Parameters inputcode is a 32-bit signed integer by value. The value should be one of the date type codes listed in the table, “Supported Date Formats." inputdate varies for type by reference. The interpretation depends upon the value of inputcode.
Command Definitions (HP32208-HPLOACNMPROC) HPDATECONVERT Table 7-8. Supported Date Formats Date Type Code Storage Type #Bytes Explanation 1 longint 8 2 integer 4 Upper 2 bytes: year next byte: month of year bottom byte: day of month yes yes 3 integer 4 Upper 2 bytes: year bottom 2 bytes: day of year yes yes 4 integer 4 Upper 23 bits: #years since 1900 bottom 9 bits: day of the year. (analogous to the existing CALENDAR format.
Command Definitions (HP32208-HPLOACNMPROC) HPDATECONVERT different countries changed at different times (around the year 1753). All the “DATE” intrinsics accept byte aligned input/output date parameters. On an error, the intrinsics initialize the output parameters to either a binary zero or a blank string depending on the type of the parameter. Though the date type “4” can represent years beyond 9999, a year beyond 9999 (which needs five digits/characters) is considered an error.
Command Definitions (HP32208-HPLOACNMPROC) HPDATEDIFF HPDATEDIFF NM callable only. This intrinsic determines the number of days that separate two given dates. Syntax I32V * * I32 I32 I32V HPDATEDIFF(datecode, firstdate,seconddate,diffindays,status,cutoff) Parameters datecode is a 32 bit signed integer by value The value should be one of the date type codes listed in the table, “Supported Date Formats." firstdate is the first input date.
Command Definitions (HP32208-HPLOACNMPROC) HPDATEFORMAT HPDATEFORMAT NM callable only. You can use this routine to format the dates that can be combinations of display formats as explained below. Many of these elements are taken from ALLBASE/SQL date formats. You can convert dates in the \Supported Date Formats" to a display string of your choice (with restrictions). The HPDATEFORMAT intrinsic will accept these format strings.
Command Definitions (HP32208-HPLOACNMPROC) HPDATEFORMAT Table 7-9. Format Specification Strings String Definition DAY Day of the week in ASCII (uppercase) format (SUN, MON, . . . ) Table 7-10. Valid Characters for Punctuation Character Definition - Hyphen / Slash . Dot ‘‘ Blank , Comma “ Null Thus, YYYY.MON.DAY, YY/MM/DD, DDMONYY, and DD-ZMM-YYYY are valid date formts.
Command Definitions (HP32208-HPLOACNMPROC) HPDATEFORMAT fmtdate is a character array (required). This array size should be at least that of formatspec. On return, it will contain the date formatted as per the formatspec. If an invalid date is passed, on return from the intrinsic its contents will be "UNKNOWN.
Command Definitions (HP32208-HPLOACNMPROC) HPDATEOFFSET HPDATEOFFSET NM callable only. This intrinsic adds or subtracts a specified offset to or from the given date. Syntax I32V * I32V * I32 I32V HPDATEOFFSET(datecode, inputdate,offset,outputdate,status,cutoff) Parameters datecode is a 32 bit signed integer by value The value should be one of the date type codes listed in the table, “Supported Date Formats." inputdate is the input date.
Command Definitions (HP32208-HPLOACNMPROC) HPDATEVALIDATE HPDATEVALIDATE NM callable only. This intrinsic checks the validity of the given date with respect to the supported formats given in the table, “Supported Date Formats.”. Syntax I32 I32V * I32V result := HPDATEVALIDATE(datecode, inputdate, cutoff) Parameters datecode is a 32 bit signed integer by value The value should be one of the date type codes listed in the table, “Supported Date Formats." inputdate is the input date.
Command Definitions (HP32208-HPLOACNMPROC) HPDEBUG HPDEBUG NM callable only. Enters the system debugger and optionally executes a defined 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.
Command Definitions (HP32208-HPLOACNMPROC) HPDEBUG Table 7-11. HPDEBUG Itemnum/Item Value Itemnum Mnemonic 1 I32 Item Description Output file number: Passes an opened file number where all output generated by Debug is sent. It must be an ASCII file with write access. The value 1 is valid and specifies that $STDLIST is used. Default: Terminal LDEV for sessions and $STDLIST for jobs. 2 I32 Welcome banner flag: Passes a value indicating whether the Debug welcome banner is printed or not.
Command Definitions (HP32208-HPLOACNMPROC) HPDEVCONTROL HPDEVCONTROL NM callable only. Provides access to specified peripheral functionality without the device being opened. Allows access to device utilities; not for general control (for example, reading or writing). Nonshareable device (ND) capability is required. Syntax I32 CA I32 I32 HPDEVCONTROL(status,ldev,itemnum,item); Parameters status 32-bit integer (required) Returns the status of the HPDEVCONTROL call.
Command Definitions (HP32208-HPLOACNMPROC) HPDEVCONTROL 200-character array before the call is made. 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. itemnum 32-bit integer (required) Specifies which operation is to be performed.
Command Definitions (HP32208-HPLOACNMPROC) HPDEVCREATE HPDEVCREATE Provides an application interface to create a streams, fifo, and device link file. 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) The name of the device file to be created. If the path_length does not indicate the length of the pathname, the device file name is assumed to be terminated with a null.
Command Definitions (HP32208-HPLOACNMPROC) HPDEVCREATE • If no errors or warnings occur, status returns 32-bits of zero. • If errors or warnings occur, status is interpreted as two 16-bit fields: Bits (0:16) Comprise status.info. A negative value indicates an error condition, and a positive value indicates a warning condition. Bits (16:16) Comprise status.subsys. The value represents the subsystem that sets the status information. For HPDEVCREATE intrinsic, the subsystem is File System (143).
Command Definitions (HP32208-HPLOACNMPROC) HPDEVCREATE Table 7-12. HPDEVCREATE Keywords/keyvalues Key word Type 1 I32 Description Device File Category. This option allows you to create one of several types of device files. The following is a list of valid categories: 1 FIFO Specifying this category creates a FIFO file. You can specify the ACD option with this item number. Any other option will result in an error.
Command Definitions (HP32208-HPLOACNMPROC) HPDEVCREATE Table 7-12. HPDEVCREATE Keywords/keyvalues Key word Type 5 CA Description Link Name. This option may be used with the major and minor number options (3 and 4) when a streams device is being created. An error is returned if this option is specified with any device file category other than STREAMS. The maximum size of this option is 8 characters (from the NMMGR link screen).
Command Definitions (HP32208-HPLOACNMPROC) HPENBLTRAP 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 off (=0), the corresponding trap is disabled.
Command Definitions (HP32208-HPLOACNMPROC) HPENBLTRAP NOTE 13:1 IEEE floating-point, invalid operation 12:1 Range errors 11:1 Software-detected NIL pointer reference 10:1 Software-detected misaligned result of pointer arithmetic or error in conversion from long pointer to short pointer 9:1 Unimplemented condition traps 8:1 Paragraph stack overflow 7:1 3000 mode packed decimal error 1:7 Reserved for MPE/iX 0:1 Assertion trap The following apply to various trap conditions represented in th
Command Definitions (HP32208-HPLOACNMPROC) HPENBLTRAP • If a trap is both enabled and armed, the user-written trap handler is invoked whenever a trap condition occurs. • If a trap is enabled but not armed, one of two situations applies: • If a Pascal/XL TRY statement has been executed, control is passed to the recover block by doing an escape. • If a Pascal/XL TRY statement has not been executed, an error message is output and the process aborts.
Command Definitions (HP32208-HPLOACNMPROC) 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) Returns the current number of entries on the process error stack. status 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.
Command Definitions (HP32208-HPLOACNMPROC) HPERRDEPTH Related Information Intrinsics HPERRMSG, ``HPERRREAD'' Manual MPE/iX Error Message Manual Volumes 1, 2 and 3 352 Chapter 7
Command Definitions (HP32208-HPLOACNMPROC) HPERRMSG HPERRMSG NM callable only. Obtains or displays error messages from the system catalog. Syntax I32V I32V I32V I32V HPERRMSG(displaycode,depth,errorproc,errornum, CA I16 I32 buffer,buflength,status); Parameters displaycode 32-bit signed integer by value (required) Specifies the operation to be performed: Chapter 7 Value Meaning 1 Dump the error stack to $STDLIST and display any errors that are detected by HPERRMSG (returned in status).
Command Definitions (HP32208-HPLOACNMPROC) HPERRMSG that the messages are placed in buffer, separated by carriage return/line feed characters. depth 32-bit signed integer by value (optional) Specifies the number of error entries from the stack that are to be displayed. A 1 (one) implies the last error entry made. Default = 0 errorproc 16-bit signed integer (reserved) Do not specify this parameter, but maintain parameter position.
Command Definitions (HP32208-HPLOACNMPROC) HPERRMSG 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 defines the subsystem that set the status information. The subsystem identifier for HPERRMSG is 187.
Command Definitions (HP32208-HPLOACNMPROC) HPERRREAD HPERRREAD NM callable only. Reads any specified error from the process stack. Syntax I32V I32 I32 I32 HPERRREAD(depth,errornum,procnum,status Parameters depth 32-bit signed integer by value (required) Passes the index of the stack entry to read from. A 1 (one) implies the last entry that was pushed. Specification of depth equal to that of the actual stack depth implies the oldest entry on the stack.
Command Definitions (HP32208-HPLOACNMPROC) HPERRREAD CAUTION If an error or warning is encountered and the status parameter was not specified, HPERRREAD causes the calling process to abort. Operation Notes Allows the user to read any specified error from the process stack. The user specifies how far down into the stack to read, and the corresponding error status is returned in errornum. If any parameters were pushed onto the stack with the specified error, this intrinsic does not return them.
Command Definitions (HP32208-HPLOACNMPROC) HPFADDTOPOINTER HPFADDTOPOINTER NM callable only. This routine can be used to perform arithmetic on a 64-bit pointer value. Byte offsets can be added to or subtracted from a pointer by specifying eithger a positive or negative offset value. Syntax @64 I64 @64 I32 HPFADDTOPOINTER(base_ptr,offset,return_ptr,status, Parameters base_ptr 64-bit pointer by reference (required) The base_ptr can be a 64-bit pointer to an object of any type.
Command Definitions (HP32208-HPLOACNMPROC) HPFFILLDATA HPFFILLDATA NM callable only. This routine can be used to efficiently initialize a buffer with a specified character value. Syntax I64 @64 CV I32 HPFFILLDATA(count,buffer_ptr,fill_char,status, Parameters count 64-bit signed integer by reference (required) A positive count of the number of bytes in the buffer indicated by the buffer_ptr parameter that should be initialized.
Command Definitions (HP32208-HPLOACNMPROC) HPFMOVEDATA HPFMOVEDATA NM callable only. This routine can be used to efficiently move data from a source buffer to a target buffer. Syntax I64 @64 @64 I32 HPFMOVEDATA(count,source_ptr,target_ptr,status, Parameters count 64-bit signed integer by reference (required) The count parameter allows the caller to specify the number of bytes to move from the source buffer to the target buffer.
Command Definitions (HP32208-HPLOACNMPROC) HPFMOVEDATA Related Information Manual Chapter 7 Accessing Files Programmer's Guide 361
Command Definitions (HP32208-HPLOACNMPROC) HPFMOVEDATALTOR HPFMOVEDATALTOR NM callable only. This routine can be used to efficiently move data from a source buffer to a target buffer.
Command Definitions (HP32208-HPLOACNMPROC) HPFMOVEDATALTOR Related Information Manual Chapter 7 Accessing Files Programmer's Guide 363
Command Definitions (HP32208-HPLOACNMPROC) HPFMOVEDATARTOL HPFMOVEDATARTOL NM callable only. This routine can be used to efficiently move data from a source buffer to a target buffer.
Command Definitions (HP32208-HPLOACNMPROC) HPFMOVEDATARTOL Related Information Manual Chapter 7 Accessing Files Programmer's Guide 365
Command Definitions (HP32208-HPLOACNMPROC) HPFIRSTLIBRARY HPFIRSTLIBRARY NM callable only. Returns the file name of the first executable library (XL) in the binding sequence of the calling process. Syntax CA I32 I32 CA HPFIRSTLIBRARY(formaldesig,status,length,firstlib, I32 I32 firstlib_length, firstlib_syntax); Parameters formaldesig character array (required) Returns the fully qualified MPE syntax file name of the first XL in the binding sequence of the calling process.
Command Definitions (HP32208-HPLOACNMPROC) HPFIRSTLIBRARY firstlib_length parameter is not specified, HPFIRSTLIBRARY determines if the firstlib parameter is long enough to hold the first library name to be returned. Note that a value is not returned in firstlib_length if the firstlib parameter is not specified.
Command Definitions (HP32208-HPLOACNMPROC) HPFMTCALENDAR HPFMTCALENDAR NM callable only. This intrinsic handles HPCALENDAR format. It does the same job as FMTCALENDAR except that it accepts the 32-bit integer returned by HPCALENDAR intrinsic. Syntax I32V CA HPFMTCALENDAR (date, formatdate) Parameters date is a 32-bit signed integer by value This holds the calendar date, in the same format as the HPCALENDAR intrinsic (that is date type 4).
Command Definitions (HP32208-HPLOACNMPROC) HPFOPEN HPFOPEN NM callable only. Creates file objects and supports FIFO files. Syntax I32 I32 I32V * HPFOPEN(filenum,status[,itemnum,item] [...]); NOTE Up to 41 itemnum/item pairs can be specified. Parameters filenum 32-bit signed integer by reference (required) Returns a file descriptor for a FIFO file. Can be used safely with all file system intrinsics that require a 16-bit file number to be passed in the intrinsic call (for example, FREAD, FWRITE, FCLOSE).
Command Definitions (HP32208-HPLOACNMPROC) HPFOPEN NOTE An itemnum takes precedence over any previously specified duplicate itemnum. Any duplicated itemnum is flagged as a warning. Itemnum/ Mnemonic Item Description 0 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.
Command Definitions (HP32208-HPLOACNMPROC) HPFOPEN expressions that are evaluated before formaldesig is parsed and validated. As the default, HPFOPEN creates a nameless file that can be read or written to, but not saved. (The domain option of a nameless file must specify a new file unless it is a device file.) The following are examples of valid formal file designators: &file/lock.group.account:node.dest.
Command Definitions (HP32208-HPLOACNMPROC) HPFOPEN Passes a value indicating a special file opening. Any of the following special files can be specified with the itemnum=2. For example, a file name of $STDLIST opens the standard list device. The following values are valid: 0 Allows all other options to specify the file. 1 The actual file designator is $STDLIST. 2 The actual file designator is $NEWPASS. 3 The actual file designator is $OLDPASS. 4 The actual file designator is $STDIN.
Command Definitions (HP32208-HPLOACNMPROC) HPFOPEN formats are supported only on disk devices. (ASC) This itemnum,item pair is ignored for files opened on a terminal; records of files on terminals are of undefined length. If the file is to be redirected to tape or disk, set the value to 0 (fixed-length). FIFO file must be created with the byte streams (9) record format.
Command Definitions (HP32208-HPLOACNMPROC) HPFOPEN Generally, the entire record can be read. Refer to the table listing the item values returned by the FFILEINFO intrinsic. However, on writes to files where carriage-control characters are specified, the data transferred is limited to recsize-1 unless a control of one is passed, indicating the data record is prefixed with embedded carriage-control characters. The value of this itemnum is ignored when a byte stream or hierarchical directory is created.
Command Definitions (HP32208-HPLOACNMPROC) HPFOPEN The following values are valid: 0 Standard (STD) file 1 KSAM/3000 file 2 Relative I/O (RIO) file 3 KSAM XL file 5 NM spoolfile 4 Circular (CIR) file 6 Message (MSG) file 7 KSAM 64 file 9 Directory Default: 0 Hierarchical directories must be created in the permanent file domain. KSAM/3000 (1), RIO (2) and CIR (4) file types may only be created using names belonging to the MPE name space. (ASC) Set the value to 0 for asynchronous devices.
Command Definitions (HP32208-HPLOACNMPROC) HPFOPEN 3 Append access only, if the file's security provisions allow either append or write access. FREAD, FREADDIR, FREADSEEK, FUPDATE, FSPACE, FPOINT, and FWRITEDIR intrinsic calls cannot reference this file. The record pointer is set to EOF prior to each FWRITE. For disk files, the EOF is updated after each FWRITE call. Therefore, data cannot be overwritten. 4 Read/Write (I/O) access only, if the file's security provisions allow both read and write access.
Command Definitions (HP32208-HPLOACNMPROC) HPFOPEN The following values 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 file. If several accessors are sharing the file, they must all specify, or not specify, this option.
Command Definitions (HP32208-HPLOACNMPROC) HPFOPEN process is already accessing this file when an HPFOPEN/FOPEN call is issued with exclusive access specified, an error status is returned to the process. If another HPFOPEN/FOPEN call is issued for this file while exclusive access is in effect, an error code is returned to the process that issued that HPFOPEN/FOPEN call. Request exclusive access only if the lock access mode is allowed by the security provisions for the file.
Command Definitions (HP32208-HPLOACNMPROC) HPFOPEN 0 No multiple process access allowed. A unique record pointer is created for this access to the file. For message files, the file system sets the multiaccess option to 2 when a zero is specified for this option. 1 Intrajob multiprocess access allowed. A record pointer is shared with all other opened files of the same name in the same job/session who opened the file with itemnum=14 is set to either 1 or 2. 2 Interjob multiprocess access allowed.
Command Definitions (HP32208-HPLOACNMPROC) HPFOPEN 0 Nowait I/O not in effect 1 Nowait I/O in effect Default: 0 Directories may not be opened using Nowait I/O (1). 17/I32 Copy mode: Passes a value that determines if any file should be treated as a standard sequential file so it can be copied by logical record or physical block to another file. Byte stream files and directories are accessed using normal access (0) regardless of the value specified for this itemnum.
Command Definitions (HP32208-HPLOACNMPROC) HPFOPEN short-mapped option. A file cannot be loaded that is currently opened with the short-mapped option. Sharing of short pointer files is provided through normal file system sharing mechanisms, for example, use of the exclusive option. With the short-mapped file, all file system intrinsics, applicable to the file, can be used. FREAD and FWRITE calls can be mixed with the short-mapped access.
Command Definitions (HP32208-HPLOACNMPROC) HPFOPEN nonshareable device should be ready prior to the HPFOPEN call (otherwise, an error results). Only one of the following options can be in effect when a file is opened: itemnum=20 itemnum=22 itemnum=23 itemnum=42 Default: Disk file located on the volume class DISC associated with the group in which file resides. A character placed in the first element designates the delimiter used by HPFOPEN to search for the end of the character array.
Command Definitions (HP32208-HPLOACNMPROC) HPFOPEN bound to the volume (the volume set is an attribute of the group in which the file resides). Only one of the following options can be in effect when a file is opened with this option: itemnum=20 itemnum=22 itemnum=23 itemnum=42 Default: A disk file located on the volume class DISC associated with the group in which file resides. A character placed in the first element designates the delimiter used by HPFOPEN to search for the end of the character array.
Command Definitions (HP32208-HPLOACNMPROC) HPFOPEN Default: The highest density available on the device opened. (ASC) Not used for asynchronous devices. 25/CA Printer environment: Passes the name of a file that contains a printer environment. This option is valid only for specified printer devices. If opening an Hewlett-Packard 268x page printer file, specify an optional printing environment for the job.
Command Definitions (HP32208-HPLOACNMPROC) HPFOPEN file already opened (for example, $STDLIST), where the highest value supplied before the last FCLOSE takes effect. This option is ignored for nonspooled devices. Default: 8 28/CA Spooled message: Passes a spooler message associated with a spoolfile. 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.
Command Definitions (HP32208-HPLOACNMPROC) HPFOPEN Passes the date of the expiration of the file or the date after which the information in the file is no longer useful, in the format MM/DD/YY. The file can be overwritten after this date. If the default is specified, the file can be overwritten immediately. In a volume set, file expiration dates must always be equal to or earlier than the date on the previous file.
Command Definitions (HP32208-HPLOACNMPROC) HPFOPEN 34I32 Spooler copies: Passes a value in the range 1..127 indicating the number of copies of the entire file to be produced by the spooling facility. This option is applicable to spooled devices only. This option can be specified for a file already opened (for example, $STDLIST), where the highest value supplied before the last FCLOSE takes effect.
Command Definitions (HP32208-HPLOACNMPROC) HPFOPEN 37/I32 File code: Passes a value that can be used as a file code to identify the type of file. This code is recorded in the file label and is accessible through the FFILEINFO intrinsic. This option is applicable only at file creation (except when opening an old file that has a negative file code). If the program is running in user mode, specify a file code in the range 0..32,767 to indicate the file type being created.
Command Definitions (HP32208-HPLOACNMPROC) HPFOPEN (ASC) Not used for asynchronous devices. 40/I32 Block factor: Passes the number of logical records to be contained in one physical record (block). This value is used to calculate the physical record size (block size) for disk and magnetic tape files. Valid ranges are 1..32,767. This option is applicable only at file creation. For fixed-length records, this option specifies the actual number of records in a block.
Command Definitions (HP32208-HPLOACNMPROC) HPFOPEN HPFOPEN to search for the end of the character array. The delimiter can appear again only following the last valid character of the character array, for example: %devclass% (% is the delimiter, devclass is the designator) fabcxyzf (f is the delimiter, abcxyz is the designator) This itemnum may not be specified when creating hierarchical directories. Hierarchical directories created on the system volume set is allocated on any volume within the set.
Command Definitions (HP32208-HPLOACNMPROC) HPFOPEN 45/CA Fill character: Passes two ASCII characters that determine what padding character to use at the end of blocks or unused pages, and the padding used by itemnum=53. Do not use delimiter characters for this option. The fill character must be a 2 byte array. The first character only is used as the padding character. The second character is reserved for future use. This option is applicable only at file creation.
Command Definitions (HP32208-HPLOACNMPROC) HPFOPEN transfer whole blocks leave the next record pointer set to the first record in the next block. The EOF marker always points at the last record in the file. For files you have opened NOBUF, the FREADDIR, FWRITEDIR, and FPOINT intrinsics treat the recnum parameter as a block number. Indicate non-RIO access to an RIO file by specifying the file NOBUF. Use the physical block size from FFILEINFO to determine the maximum transfer length.
Command Definitions (HP32208-HPLOACNMPROC) HPFOPEN parameter in a FILE command can override this option, unless file equations are disallowed with itemnum=9. The following values are valid: 0 No change. The disposition remains as it was before the file was opened. If the file is new, it is deleted by FCLOSE; otherwise, the file is assigned to the domain it belonged to previously. An unlabeled tape file is rewound. If the file resides on a labeled tape, the tape is rewound and unloaded. 1 Permanent file.
Command Definitions (HP32208-HPLOACNMPROC) HPFOPEN 51/String Pascal XL string: Passes a formal file designator that follows MPE/iX file 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 file, you may use either itemnum=2 or you may use itemnum=51; you may not use both.
Command Definitions (HP32208-HPLOACNMPROC) HPFOPEN name space. The filerefence in the file equation string is interpreted using MPE-escaped semantics. Both the formaldesignator and the filereference in the file equation string may also contain embedded command interpreter variables or expressions. 53/I32 ASCII/binary: Passes a value indicating whether ASCII or binary code is to be used for a new file when it is written to a device that supports both codes.
Command Definitions (HP32208-HPLOACNMPROC) HPFOPEN attached to a new file. The byte array has a length of 1 to 279 bytes. Unlike other HPFOPEN options that expect a delimiter at both the beginning and the end of the byte array, this option only expects a trailing carriage return character as a delimiter, for example, (X:@.@;R,W:MGR.SYS;RACD:JOHN.SMITH) Where, the is the carriage return character (13, 0x0D).
Command Definitions (HP32208-HPLOACNMPROC) HPFOPEN 0 This value indicates that Non-Block mode is off. This is the default value. 1 This value indicates that Non-Block mode is on. Specifying any value other than those described above will result in error.8 80/I32 Reserved for the operating system. 81/I32 Symbolic link option: This itemnum allows the caller to specify different options when traversing through or opening a symbolic link.
Command Definitions (HP32208-HPLOACNMPROC) HPFPCONVERT HPFPCONVERT NM and CM callable. Converts data between binary floating-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) Passes the floating-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.
Command Definitions (HP32208-HPLOACNMPROC) HPFPCONVERT status 4 IEEE 64-bit 5 IEEE 128-bit 32-bit signed integer by reference (optional) Returns the status of the HPFPCONVERT 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 fields. Bits (0:16) comprise status.info.
Command Definitions (HP32208-HPLOACNMPROC) HPFPCONVERT Operation Notes The HPFPCONVERT intrinsic accepts a source binary floating-point number and converts it to the equivalent destination binary floating-point format. You must specify the format of the source and destination numbers. Optionally, you can specify the rounding mode. The conversion is performed by regarding the source number as infinitely precise and with unbounded range, and then rounding it to fit the designated destination format.
Command Definitions (HP32208-HPLOACNMPROC) HPGETPROCPLABEL HPGETPROCPLABEL NM callable only. Dynamically loads a native mode (NM) executable library procedure. Syntax CA U32 I32 CA HPGETPROCPLABEL(procname,plabel,status,firstfile, B casesensitive); Parameters procname character array (required) Passes the name of the procedure being searched for. The first character of procname designates the terminating character that HPGETPROCPLABEL uses to search for the end of the name.
Command Definitions (HP32208-HPLOACNMPROC) HPGETPROCPLABEL a procedure named procname. If either procname is not located in the XL or procname contains unresolved external references that must be satisfied in subsequent XLs, then each XL in the binding sequence after firstfile is searched. If firstfile is not located in the binding sequence, then firstfile has a binding sequence independent of the program and is bound directly to the system libraries.
Command Definitions (HP32208-HPLOACNMPROC) 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) Passes an ASCII procedure name, left-justified and blank-padded.
Command Definitions (HP32208-HPLOACNMPROC) HPLOADCMPROCEDURE defines the subsystem that set the status information. The subsystem identifier for HPLOADCMPROCEDURE is 105. Operation Notes The HPLOADCMPROCEDURE intrinsic helps you avoid switching by name overhead. Switching by name incurs the overhead of forming a hash probe out of the target procedure's name and finding the name in a hash table in order to obtain the procedure's plabel.
Command Definitions (HP32208-HPLOACNMPROC) 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) Passes the target procedure name. The target procedure must be contained in an executable library (XL).
Command Definitions (HP32208-HPLOACNMPROC) HPLOADNMPROC Related Information Intrinsics HPSWITCHTOCMPROCEDURE Manual Switch Programming Guide 406 Chapter 7
8 Command Definitions (HPMERGEEND-LOGSTATUS) This chapter continues the description of 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 files only. (ASC) For use with asynchronous serial communications only. (SPL) For use with SPL programming language only.
Command Definitions (HPMERGEEND-LOGSTATUS) 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 fields. Bits (0:16) comprise status.info.
Command Definitions (HPMERGEEND-LOGSTATUS) HPMERGEERRORMESS 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.
Command Definitions (HPMERGEEND-LOGSTATUS) HPMERGEERRORMESS Manual 410 SORT-MERGE/XL Programmer's Guide Chapter 8
Command Definitions (HPMERGEEND-LOGSTATUS) HPMERGEINIT HPMERGEINIT NM callable only. Initializes the MERGE/XL subsystem. Syntax I32 I32A PROC I32A HPMERGEINIT(status,inputfiles,preprocessor,outputfiles, 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.
Command Definitions (HPMERGEEND-LOGSTATUS) HPMERGEINIT intrinsic to retrieve merged records. postprocessor procedure (reserved) Do not specify this parameter, but maintain parameter position. keysonly 32-bit signed integer by value (optional) Flag that determines if only keys are sent as output. If set to 0, the entire record is sent as output. If set to any value other than 0, the key fields are concatenated together with he major key on the left and the remaining keys following.
Command Definitions (HPMERGEEND-LOGSTATUS) HPMERGEINIT 12 Short floating-point decimal 13 Floating-point decimal The fourth element gives the ordering sequence of the records: NOTE altseq Value Meaning 0 ascending 1 descending The integrity of the keys array must be maintained throughout the MERGE/XL operation. Do not change it until after you have called the HPMERGEEND intrinsic. character array (optional) Passes an alternate collating sequence.
Command Definitions (HPMERGEEND-LOGSTATUS) HPMERGEINIT 5 memsize 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. Set the first 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).
Command Definitions (HPMERGEEND-LOGSTATUS) HPMERGEOUTPUT HPMERGEOUTPUT NM callable only. Retrieves records, one at a time, from MERGE/XL. Syntax I32 CA I32 HPMERGEOUTPUT(status,buffer,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 fields. Bits (0:16) comprise status.info.
Command Definitions (HPMERGEEND-LOGSTATUS) HPMERGESTAT 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 fields. Bits (0:16) comprise status.info.
Command Definitions (HPMERGEEND-LOGSTATUS) HPMERGESTAT Related Information Intrinsics Hewlett-Packard SORT, Hewlett-Packard MERGE Manual SORT-MERGE/XL Programmer's Guide Chapter 8 417
Command Definitions (HPMERGEEND-LOGSTATUS) HPMERGETITLE 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 fields. Bits (0:16) comprise status.info.
Command Definitions (HPMERGEEND-LOGSTATUS) HPMYFILE HPMYFILE NM callable only. Returns the file name of the native mode program or executable library (XL) that called the HPMYFILE intrinsic. Syntax CA I32 I32 CA HPMYFILE(formaldesig,status,length,myfile I32 I32 myfile_length, myfile_syntax); Parameters formaldesig character array (required) Returns the fully qualified MPE syntax file name of the program or XL that called HPMYFILE.
Command Definitions (HPMERGEEND-LOGSTATUS) HPMYFILE returned indicates that no file name is returned. myfile character array (optional) Returns the absolute pathname or fully qualified MPE syntax name of the program or XL that called HPMYFILE. The myfile parameter contains the name with delimiters. The first and last characters of the returned value are blanks that act as delimiters.
Command Definitions (HPMERGEEND-LOGSTATUS) HPMYPROGRAM HPMYPROGRAM NM callable only. Returns the file 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 qualified MPE syntax name of the program being executed by the calling process.
Command Definitions (HPMERGEEND-LOGSTATUS) HPMYPROGRAM The myprogram parameter contains the name with delimiters. The first and last characters of the returned value are blanks that act as delimiters. myprogram_length 32-bit signed integer by reference (optional) On input, the myprogram_length parameter specifies the maximum myprogram length in bytes. On output, myprogram_length returns the actual length of myprogram, including the surrounding delimiters.
Command Definitions (HPMERGEEND-LOGSTATUS) HPPIPE HPPIPE Creates a pipe file type object defined as device type of streams, file type of pipes, and record format of byte streams. Syntax I32 I32 I32 HPPIPE(read_fd, write_fd, status) Parameters 32-bit signed integer by reference (required) read_fd Returns the read file descriptor for the pipe. Attempts to write to a read file descriptor results in an error.
Command Definitions (HPMERGEEND-LOGSTATUS) HPPIPE Operation Notes Enables creation of a pipe, which is a nameless object that can only be reached from members of its process's family. Returns two file numbers to the calling process that represent the write and read ends of the pipe. Use the FWRITE and FREAD intrinsics to read and write to the pipe. Data is returned in a first in, first out manner.
Command Definitions (HPMERGEEND-LOGSTATUS) HPRESETDUMP 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 fields. Bits (0:16) comprise status.info.
Command Definitions (HPMERGEEND-LOGSTATUS) HPSELECT HPSELECT Determine whether a file or group of files 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.
Command Definitions (HPMERGEEND-LOGSTATUS) HPSELECT Bits representing file numbers greater than numfiles (minus 1) are ignored. The buffer containing the bit mask only needs to be as large as the number of 32-bit words required to contain the bits for numfiles files. If a timeout is specified and the time limit has elapsed, the mask is cleared on return. Default: No files are checked for reading.
Command Definitions (HPMERGEEND-LOGSTATUS) HPSELECT The timeout value is specified by a 64-bit record containing the following two fields: 32-bit unsigned integer = seconds 32-bit integer = microseconds Values up to 2**32 seconds can be specified. Default: HPSELECT blocks until one of the specified conditions is true. 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.
Command Definitions (HPMERGEEND-LOGSTATUS) HPSELECT Related Information Intrinsics Chapter 8 IOWAIT 429
Command Definitions (HPMERGEEND-LOGSTATUS) 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 Meaning 0 Condition Code Greater Than (CCG). A special condition occurred but may not have affected the execution of the request. 1 Condition Code Less Than (CCL).
Command Definitions (HPMERGEEND-LOGSTATUS) 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 fields. Bits (0:16) comprise status.info.
Command Definitions (HPMERGEEND-LOGSTATUS) HPSETDUMP user may resume the process or terminate it with the Debug CONTINUE command. If the abort is caused by a stack overflow, a stack trace is printed and the process is terminated immediately and the command string is not executed.
Command Definitions (HPMERGEEND-LOGSTATUS) 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.
Command Definitions (HPMERGEEND-LOGSTATUS) HPSORTEND Operation Notes HPSORTEND initiates the merge phase of the Hewlett-Packard SORT program and writes to the output file if the HPSORTOUTPUT intrinsic is not used. HPSORTEND is required if you called HPSORTINIT. Call HPSORTEND either after all calls to the output file 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.
Command Definitions (HPMERGEEND-LOGSTATUS) 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.
Command Definitions (HPMERGEEND-LOGSTATUS) HPSORTINIT HPSORTINIT NM callable only. Initializes the SORT/XL subsystem. Syntax I32 I32A I32A I32 HPSORTINIT(status,inputfiles,outputfiles,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.
Command Definitions (HPMERGEEND-LOGSTATUS) HPSORTINIT retrieve the sorted records.
Command Definitions (HPMERGEEND-LOGSTATUS) HPSORTINIT position of the first byte of the key within the input record. The second element gives the number of bytes in the key.
Command Definitions (HPMERGEEND-LOGSTATUS) HPSORTINIT The second element specifies one fewer than the total number of characters in the collating sequence. If the first element is CHR(0), the remaining array elements comprise the actual collating sequence responsible for the particular Hewlett-Packard SORT operation. Default: element 1 = CHR(255), element 2 = CHR(255) keycompare procedure (reserved) Do not specify this parameter, but maintain parameter position.
Command Definitions (HPMERGEEND-LOGSTATUS) HPSORTINPUT HPSORTINPUT NM callable only. Passes records, one at a time, to SORT/XL. Syntax I32 CA I32V HPSORTINPUT(status,buffer,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 fields. Bits (0:16) comprise status.info.
Command Definitions (HPMERGEEND-LOGSTATUS) HPSORTOUTPUT HPSORTOUTPUT NM callable only. Retrieves records, one at a time, from SORT/XL program. Syntax I32 CA I32 HPSORTOUTPUT(status,buffer,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 fields. Bits (0:16) comprise status.info.
Command Definitions (HPMERGEEND-LOGSTATUS) HPSORTSTAT HPSORTSTAT NM callable only. Prints the SORT/XL statistics on $STDLIST. Syntax I32 I32A HPSORTSTAT(status,statistics); Parameters 32-bit signed integer by reference (optional) status 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 fields. Bits (0:16) comprise status.info.
Command Definitions (HPMERGEEND-LOGSTATUS) HPSORTSTAT Operation Notes Call HPSORTSTAT after you have called the HPSORTEND intrinsic. A call to HPSORTSTAT is valid only if the statistics parameter is specified to the HPSORTINIT and HPSORTEND intrinsics. The same array is supplied to HPSORTSTAT. Related Information Intrinsics HPSORT, HPMERGE Manual SORT-MERGE/XL Programmer's Guide .
Command Definitions (HPMERGEEND-LOGSTATUS) HPSORTTITLE 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.
Command Definitions (HPMERGEEND-LOGSTATUS) HPSWITCHTOCM HPSWITCHTOCM NM callable only. Makes native mode (NM) to compatibility mode (CM) mixed-mode procedure calls possible.
Command Definitions (HPMERGEEND-LOGSTATUS) HPSWITCHTOCM fretlen 32-bit signed integer by value (optional) The length in bytes of the optional functional return value. fretval record by value (optional) NM pointer to the beginning of the area to which the optional functional return value is returned. condcode 16-bit signed integer by reference (optional) Returns the condition code that the target CM procedure returns. Valid values are in the range 0..2.
Command Definitions (HPMERGEEND-LOGSTATUS) 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 specified by the CM caller.
Command Definitions (HPMERGEEND-LOGSTATUS) HPSWTONMNAME nparms 16-bit signed integer by value (required) Passes the number of parameters to be passed to the target NM procedure. It specifies the length of the argdesc array. Account for any hidden parameters (for example, parameters, an extensible parameter list, and so forth). arglist 16-bit signed integer array by reference (required) Passes the actual parameters to be passed in the NM procedure.
Command Definitions (HPMERGEEND-LOGSTATUS) 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 specified by the CM caller.
Command Definitions (HPMERGEEND-LOGSTATUS) HPSWTONMPLABEL 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.
Command Definitions (HPMERGEEND-LOGSTATUS) 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) Passes as ASCII procedure name, left-justified and padded with blanks. The name can have a maximum of 16 characters.
Command Definitions (HPMERGEEND-LOGSTATUS) HPUNLOADCMPROCEDURE Operation Notes Procedures are automatically unloaded when your process terminates. Use the HPUNLOADCMPROCEDURE intrinsic to unload before the process terminates.
Command Definitions (HPMERGEEND-LOGSTATUS) HPVOLINFO HPVOLINFO Returns volume information. Up to six items of information can be retrieved. They must be specified in pairs (,itemnum, item) and separated by commas Syntax I32 I16 * HPVOLINFO(status, volspecifiernum, volspecifier 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.
Command Definitions (HPMERGEEND-LOGSTATUS) HPVOLINFO 454 -151 Missing itemnum or item (not paired). -152 Required parameter omitted. -153 Parameter address out of bounds. -154 Split stack calls not allowed. -155 LDEV, volume set/class, volume not mounted. -156 Invalid volume specifier number. -157 Invalid volume specifier. -158 LDEV not a disk LDEV. -159 Device class not configured for volumes. -160 Device class does not map into a volume class.
Command Definitions (HPMERGEEND-LOGSTATUS) HPVOLINFO error. -183* Disk access error. Check the error stack to determine the exact error. -184* A mirrored volume that was specified is disabled. -185* The volume set specified is not a volume set on the system. -186* The volume class specified is not present in the volume set specified. -187* The member volume specified is not present in the volume set specified.
Command Definitions (HPMERGEEND-LOGSTATUS) HPVOLINFO When 1 is used as the volspecifiernum, the volspecifier must be an LDEV number that corresponds to a configured and mounted volume. An LDEV number can be any number from 1 through 999. For character specifiers, the first character determines the delimiter character for the parameter. The delimiter must be printable; it cannot be alphanumeric or one of the special characters ". , :" or "_" as explained below.
Command Definitions (HPMERGEEND-LOGSTATUS) HPVOLINFO • For volspecifiernum 4 on MPE V, a volume name consists of as many as eight alphanumeric characters. The first character must be a letter. For private volumes, names may be partially or fully qualified (vname.group.acct). Each field of the name must be one to eight alphanumeric characters, the first of which must be a letter. The maximum number of characters allowed is 55. %SETxxxxx.GROUPxxx.ACCOUNTx:NAMExxxx.GROUPxxx.
Command Definitions (HPMERGEEND-LOGSTATUS) HPVOLINFO format that is the default mode of the caller. If the intrinsic is called from compatibility mode, any real values specified to HPVOLINFO must be in 64-bit Hewlett-Packard 3000 format, and any real values returned by HPVOLINFO will be in that format. If the intrinsic is called from native mode, any real values specified to HPVOLINFO must be in 64-bit IEEE format, and any real values returned by HPVOLINFO will be returned in that format.
Command Definitions (HPMERGEEND-LOGSTATUS) HPVOLINFO returned is for the split user volume. Table 8-1.
Command Definitions (HPMERGEEND-LOGSTATUS) 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 configured on the system. It returns a 32-bit signed integer containing the number of volumes sets. Zero (0) is the only valid volspecifiernum. May be used with Item=3.
Command Definitions (HPMERGEEND-LOGSTATUS) HPVOLINFO passed. The remaining bytes are mapped to a list of 32-byte names. On return, the value has been modified to reflect the actual number of names returned. A volume can be associated with more than one volume class. So when the specifier is 1 or 4, the list returned is a list of volume classes that the volume is a member of. When the specifier is 2, the list returned is a list of volume classes that are a subset of the volume set.
Command Definitions (HPMERGEEND-LOGSTATUS) HPVOLINFO Item 6 may be used to determine the maximum number of names that can be returned. When the specifier is 2 or 3, the list of member volumes that make up the set or class is returned. When the specifier is 5, the list of member volumes configured with the passed device class is returned. On MPE/iX, you can remove some or all of the volumes in a volume set (excluding the master volume).
Command Definitions (HPMERGEEND-LOGSTATUS) HPVOLINFO Function = MPE/iX, MPE V: DSTAT Returns the volume set name corresponding to the passed LDEV. An LDEV can be associated with only one volume set. This item is a character array and must be specified with a length of 32 bytes. 13 Logical device number Returns the logical device number of the specified volume. This item returns a 16-bit signed integer containing the logical device number.
Command Definitions (HPMERGEEND-LOGSTATUS) HPVOLINFO When the specifier is 1 or 4, the total MPE overhead consists of the MPE overhead on the volume whose LDEV or volume name was specified. These are subsets of items 16 and 17. When the specifier is 2 or 3, the MPE overhead on the volumes that make up the set or class is returned. 18 & 19 MPE/iX transient space overhead Returns the MPE/iX transient space overhead. This item is valid only on MPE/iX. These are subsets of items 16 and 17.
Command Definitions (HPMERGEEND-LOGSTATUS) HPVOLINFO overhead in sectors. Item 23 returns this overhead as a 64-bit real. MPE V virtual memory overhead is the volume space that is allocated for saving segments of main memory temporarily. This amount of configured virtual memory space is equivalent to the amount of used virtual memory space. Virtual memory on MPE V is allocated only on system volumes. There is no virtual memory on private volumes.
Command Definitions (HPMERGEEND-LOGSTATUS) HPVOLINFO make up the set or class is returned. 28 & 29 MPE/iX transaction management overhead Returns the MPE/iX transaction management overhead. This item is valid only on MPE/iX. Item 28 returns a 64-bit signed integer containing the transaction management overhead in sectors. Item 29 returns this overhead as a 64-bit real. These are subsets of items 16 and 17.
Command Definitions (HPMERGEEND-LOGSTATUS) HPVOLINFO 34 & 35 Reserved for disk space used by temporary files. 36 & 37 Free space distribution array Function = MPE/iX: DISCFREE MPE V: FREE5 Returns the free space distribution array. The caller passes an array that specifies a series of ranges. The intrinsic returns the number of free areas whose size is within each of the specified ranges. The array must consist of 64-bit values.
Command Definitions (HPMERGEEND-LOGSTATUS) HPVOLINFO 38 & 39 Free space distribution sectors per range Function = MPE/iX: DISCFREE, MPE V: FREE5 Returns the free space distribution sectors per range. The caller passes an array that specifies a series of ranges. For each range specified in the array, the intrinsic returns the total free space for free areas found in that range.
Command Definitions (HPMERGEEND-LOGSTATUS) HPVOLINFO Table 8-2.
Command Definitions (HPMERGEEND-LOGSTATUS) HPVOLINFO ITEM# ITEM TYPE APPLICABLE VOLUME SPECIFIERS 23 MPE V virtual memory overhead in sectors R64 1, 2, 4 24 Directory space overhead in sectors I64 1, 2, 3, 4 25 Directory space overhead in sectors R64 1, 2, 3, 4 26 MPE/iX file label overhead in sectors I64 1, 2, 3, 4 27 MPE/iX file label overhead in sectors R64 1, 2, 3, 4 28 MPE/iX transaction management overhead I64 1, 2, 3, 4 29 MPE/iX transaction management overhead R64 1,
Command Definitions (HPMERGEEND-LOGSTATUS) INITUSLF INITUSLF NM and CM callable. Initializes a buffer corresponding to record 0 of a USL file to the empty state. NOTE A USL contains CM object code and is meaningful only in the CM program development process. 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.
Command Definitions (HPMERGEEND-LOGSTATUS) INITUSLF CCL (1) Request denied. An error number is returned to uslferror.
Command Definitions (HPMERGEEND-LOGSTATUS) IODONTWAIT IODONTWAIT NM and CM callable. Initiates completion operations for an I/O request. Syntax I16 I16V UDS I16 U16 fnum:=IODONTWAIT(filenum,buffer,length,cstation) Functional Return fnum 16-bit signed integer (assigned functional return) The file number for which the completion occurred. If no completion occurred, zero is returned. Parameters filenum 16-bit signed integer by value (required) The file number for which there is a pending I/O request.
Command Definitions (HPMERGEEND-LOGSTATUS) 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) Request granted.
Command Definitions (HPMERGEEND-LOGSTATUS) IOWAIT IOWAIT NM and CM callable. Initiates completion operations for an I/O request. Syntax I16 I16V UDS I16 U16 fnum:=IOWAIT(filenum,buffer,length,cstation); Functional Return fnum 16-bit signed integer (assigned functional return) The file number for which the completion occurred. If no completion occurred, zero is returned. Parameters filenum 16-bit signed integer by value (required) The file number for which there is a pending I/O request.
Command Definitions (HPMERGEEND-LOGSTATUS) IOWAIT Operation Notes The IOWAIT intrinsic initiates completion operations for an I/O request. If you opened a file 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 buffer area if necessary.
Command Definitions (HPMERGEEND-LOGSTATUS) JOBINFO JOBINFO NM and CM callable. Returns information about any current job or session under your user name and account. If you have sufficient 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] [...]); NOTE You can specify up to five itemnum/item/itemerror triples.
Command Definitions (HPMERGEEND-LOGSTATUS) JOBINFO itemnum 3 Unsuccessful call. Syntax error in calling sequence. 4 Unsuccessful call. Unable to retrieve jsnum. 5 Process terminated. The process terminated during the start of retrieval. 16-bit signed integer by value (optional) Specifies which item value is to be returned. Refer to Table 4-20 for a complete list of valid item numbers and what they return to the caller.
Command Definitions (HPMERGEEND-LOGSTATUS) JOBINFO output is left-justified and padded with blanks. 2/CA8 Session/job name. An ASCII output parameter. Output is left-justified and padded with blanks. 3/CA8 User name. An ASCII output parameter. Output is left-justified and padded with blanks. 4/CA8 User logon group. An ASCII output parameter. Output is left-justified and padded with blanks. 5/CA8 User account. An ASCII output parameter. Output is left-justified and padded with blanks.
Command Definitions (HPMERGEEND-LOGSTATUS) JOBINFO 13/I16 Current number of active sessions 14/I16 Job input priority 15/I32 Job/session number 16/I16 Jobfence 17/I16 Job output priority 18/I16 Number of copies 19/I16 Job limit (system) 20/I16 Session limit (system) 21/I16 Job deferred. Returns the values: 0 No 1 Yes 22/U16 Main CI PIN for job/session 23/U16 Original job spooled. Returns the values: 24/U16 25/U16 26/U16 0 No 1 Yes RESTART option.
Command Definitions (HPMERGEEND-LOGSTATUS) JOBINFO less than or equal to 32768. 31/I16 $STDIN spoolfile status. Returns data for current jobs and sessions only. Returns the values: 32/I16 0 Open 1 Active 3 Reserved 4 Ready $STDLIST spoolfile number. Returns data for current jobs and sessions only. Valid for spoolfile numbers less than or equal to 32768. 33/I16 $STDLIST spoolfile status. Returns data for current jobs and sessions only.
Command Definitions (HPMERGEEND-LOGSTATUS) JOBINFO 43/CA8 The user name of the job submitter. An ASCII output parameter. Output is left justified and padded with blanks. 44/CA8 The user account of the job submitter. An ASCII output parameter. Output is left justified and padded with blanks. 45/CA8 The logical device of the job submitter. An ASCII output parameter. Output is left justified and padded with blanks. 46/U16 The date/time that the STREAM command was submitted by the job submitter.
Command Definitions (HPMERGEEND-LOGSTATUS) 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 identification number (PIN) of the child process to be deleted. Operation Notes All resources held by the deleted processes are released.
Command Definitions (HPMERGEEND-LOGSTATUS) LOADPROC 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.
Command Definitions (HPMERGEEND-LOGSTATUS) LOADPROC CCL (1) Request denied. The value returned to idnum is a CM loader error code.
Command Definitions (HPMERGEEND-LOGSTATUS) LOCKGLORIN LOCKGLORIN NM and CM callable. Locks a global resource identification number (RIN). Multiple RIN (MR) capability is required to lock more than one global RIN simultaneously. Syntax I16V U16 CA LOCKGLORIN(rinnum,lockflag,rinpassword); Parameters rinnum 16-bit signed integer by value (required) Passes the RIN of the resource to be locked. This is the RIN furnished in the GETRIN command.
Command Definitions (HPMERGEEND-LOGSTATUS) LOCKGLORIN The following condition codes are possible if lockflag bit (15:1)=0: CCE (2) Request granted. If the calling process has already locked the RIN, lockflag bit (15:1) is set to 0. If the RIN is free, lockflag 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.
Command Definitions (HPMERGEEND-LOGSTATUS) LOCKLOCRIN LOCKLOCRIN NM and CM callable. Locks a local resource identification number (RIN). Syntax I16V U16 LOCKLOCRIN(rinnum,lockflag); Parameters rinnum 16-bit signed integer by value (required) A previously allocated local RIN; valid values range from 1 to the value specified in the rincount parameter of the GETLOCRIN intrinsic.
Command Definitions (HPMERGEEND-LOGSTATUS) LOCKLOCRIN RIN was allocated, or rinnum specified a number less than or equal to zero. The following condition codes are possible if lockflag bit (15:1)=0: CCE (2) Request granted. If the calling process has already locked the RIN, lockflag bit (15:1) is set to 1. If the RIN is free, lockflag bit (15:1) is set to 0. CCG (0) Request denied. The RIN was locked by another process. CCL (1) Request denied.
Command Definitions (HPMERGEEND-LOGSTATUS) LOCRINOWNER LOCRINOWNER NM and CM callable. Determines process identification number (PIN) of the process that locked a local resource identification 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.
Command Definitions (HPMERGEEND-LOGSTATUS) LOGINFO LOGINFO NM and CM callable. Provides information about an opened user logging file (whole file set). User logging (LG) or system supervisor (OP) capability is required. Syntax I32V I16 I16V * LOGINFO (index,logstatus [,itemnum,item] [...]; NOTE You can specify up to four itemnum/item pairs. Parameters index 32-bit signed integer by value (required) Passes your access to the user logging system.
Command Definitions (HPMERGEEND-LOGSTATUS) LOGINFO 2/I32 Current file size 3/I32 Current file space left 4/I16 Number of users 5/I32 Total records written in whole file set 6/CA Current log file name 7/I16 Current log file type 0 DISK 1 TAPE 8/CA Previous log file name 9/I16 Previous log file type 0 DISK 1 TAPE 10/U16 CHANGELOG allowed (true/false) 11/U16 AUTO allowed (true/false) 12/I16 Current file sequence number 13/I16 Log status: 14/I16 0 INACTIVE 1 ACTIVE 2 Close p
Command Definitions (HPMERGEEND-LOGSTATUS) LOGSTATUS LOGSTATUS NM and CM callable. Provides information about a currently opened user logging file. 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) Passes your access to the user logging system. This is the value returned in the index parameter of the OPENLOG intrinsic.
Command Definitions (HPMERGEEND-LOGSTATUS) LOGSTATUS Manual 494 User Logging Programmer's Guide Chapter 8
9 Command Definitions (MAIL-PUTJCW) This chapter continues the descriptions of 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 files only. (ASC) For use with asynchronous serial communications only. (SPL) For use with SPL programming language only.
Command Definitions (MAIL-PUTJCW) MAIL 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 Meaning 0 Mailbox empty. 1 Contains previous outgoing mail from this calling process that the destination process has not yet collected.
Command Definitions (MAIL-PUTJCW) MAIL Condition Codes CCE (2) Request granted. The mailbox mailstatus was tested. CCG (0) Request denied. An illegal pin parameter was specified. The value of 3 is returned to the calling process through mailstatus. CCL (1) Request denied. The length parameter defines stack address that does not have write access.
Command Definitions (MAIL-PUTJCW) MERGEEND MERGEEND NM and CM callable. Restores the data stack to its original state and ends the merging operation. Syntax MERGEEND; Condition Codes CCE (2) Request granted. No error occurred during the MERGE program. CCG (0) Not returned. CCL (1) Request denied. An error occurred during the MERGE program. Operation Notes Call this intrinsic only if the MERGEINIT intrinsic was called.
Command Definitions (MAIL-PUTJCW) 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 Returns the error number from the MERGEINIT errorparm parameter. message character array Returns the text of the error message.
Command Definitions (MAIL-PUTJCW) MERGEINIT MERGEINIT NM and CM callable. Initializes the MERGE/XL subsystem and the merging of two or more sorted files.
Command Definitions (MAIL-PUTJCW) MERGEINIT Passes the number of keys used during the comparison of records. This parameter can be either equal to or greater than one. If you specify the numkeys parameter, you must also specify the keys parameter. Together, numkeys and keys describe the way records are merged. keys 16-bit signed 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.
Command Definitions (MAIL-PUTJCW) MERGEINIT Bits (8:8) of the first element specify one fewer than the total number of characters in the collating sequence (in this instance, chr(255) or %377). The remaining array elements comprise the actual collating sequence responsible for the particular MERGE operation. keycompare procedure (reserved) Do not specify this parameter, but maintain parameter position. errorproc procedure (reserved) Do not specify this parameter, but maintain parameter position.
Command Definitions (MAIL-PUTJCW) MERGEINIT Related Information Intrinsics HPSORT, HPMERGE Manual SORT-MERGE/XL Programmer's Guide Chapter 9 503
Command Definitions (MAIL-PUTJCW) 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 Returns the next output record. length 16-bit signed integer Returns the length of the record parameter value.
Command Definitions (MAIL-PUTJCW) MERGESTAT 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 files, 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.
Command Definitions (MAIL-PUTJCW) 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.
Command Definitions (MAIL-PUTJCW) MYCOMMAND MYCOMMAND NM and CM callable (difference noted below). Parses (delineates and defines) parameters for a user-defined command image. Syntax I16 CA CA entrynum:=MYCOMMAND(cmdimage,delimiters, I16V I16 I32A maxparms,numparms,params, CA @* dictionar,definition); Functional Return entrynum 16-bit signed integer (assigned functional return) Returns the command entry number. If the dictionary parameter is not specified, 0 is returned.
Command Definitions (MAIL-PUTJCW) MYCOMMAND delimiter is identified later by its position in this string. Default: The delimiter array ",=; (carriage return)". maxparms 16-bit signed integer by value (required) Passes the maximum number of parameters expected in cmdimage. Accepts values from 0 to 8192. numparms 16-bit signed integer by reference (required) Returns the number of parameters found in cmdimage. params 32-bit signed integer array (required) Returns an array of maxparms entries.
Command Definitions (MAIL-PUTJCW) MYCOMMAND 0:16 Always zero. dictionary character array (optional) Passes the character array that is to be searched for the command name in cmdimage. The format must be identical to that of the dictionary parameter in the SEARCH intrinsic. The command, delimited by a blank, is extracted from cmdimage, and the SEARCH intrinsic is called with the command name used as the buffer parameter of SEARCH.
Command Definitions (MAIL-PUTJCW) MYCOMMAND PARSED PARAM OF COMIMAGE > 255 CHARACTERS Condition Codes CCE (2) Request granted. The parameters were formatted, without exception. If dictionary was specified, the functional return is the command entry number. CCG (0) Request granted. More parameters were found in cmdimage than were allowed by maxparms. Only the first maxparms of these parameters were formatted in params and returned. CCL (1) Request denied.
Command Definitions (MAIL-PUTJCW) NLAPPEND NLAPPEND NM and CM callable. Appends a language ID number to a file name that allows an application to designate which language-dependent file to use. Syntax CA I16V U16A NLAPPEND(formaldesig,langnum,error); Parameters formaldesig character array (required) Passes and returns a formal file designator. When passed, the file name must end with three blanks. When returned, the language ID has been appended to the name.
Command Definitions (MAIL-PUTJCW) NLCOLLATE NLCOLLATE NM and CM callable. Collates two character strings according to the specified language collating sequence and determines a lexical ordering. Syntax CA CA I16V I16 NLCOLLATE(buffer1,buffer2,bufferlength,result, I16V U16A U16A langnum,error,collseq); Parameters buffer1 character array (required) Passes the first character string to be collated. buffer2 character array (required) Passes the second character string to be collated.
Command Definitions (MAIL-PUTJCW) NLCOLLATE 1 *NLS not installed 2 *Specified language not configured 3 Invalid collating table entry 4 Invalid bufferlength parameter 5 *NLS internal error 6 *NLS internal error * Do not apply to calls with a langnum equal to 0 (NATIVE3000/XL). collseq 16-bit unsigned integer array (optional) Passes the native language collating sequence table as returned by itemnum=11 of the NLINFO intrinsic.
Command Definitions (MAIL-PUTJCW) NLCOLLATE2 NLCOLLATE2 NM callable. Collates two character strings according to the specified language collating sequence and determines a lexical ordering. Designed to be used with a COBOL program.
Command Definitions (MAIL-PUTJCW) NLCOLLATE2 Value Meaning 0 Successful 1 *NLS not installed 2 *Specified language not configured 3 Invalid collating table entry 4 Invalid bufferlength parameter 5 *NLS internal error 6 *NLS internal error * Do not apply to calls with a langnum equal to 0 (NATIVE3000/XL). collseq 16-bit unsigned integer array (optional) Passes the native language collating sequence table as returned by itemnum=11 of the NLINFO intrinsic.
Command Definitions (MAIL-PUTJCW) 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.
Command Definitions (MAIL-PUTJCW) NLCONVCLOCK 3 Invalid time string 4 Invalid length 5 *NLS internal error 6 *NLS internal error * Do not apply to calls with a langnum equal to 0 (NATIVE3000/XL).
Command Definitions (MAIL-PUTJCW) 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.
Command Definitions (MAIL-PUTJCW) NLCONVCUSTDATE 3 Invalid date string 4 Invalid string length 5 *NLS internal error 6 *NLS internal error 7 Separator character in buffer does not match custom date template 8 Length of date string > 13 characters (excluding leading and trailing blanks) * Do not apply to calls with a langnum equal to 0 (NATIVE3000/XL). NOTE When a byte array is passed the code receives the starting position and the length.
Command Definitions (MAIL-PUTJCW) 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.
Command Definitions (MAIL-PUTJCW) NLCONVNUM 3 Invalid length specified (inlength or outlength) 4 Invalid number specified (instring) 5 *NLS internal error 6 *NLS internal error 7 Truncation occurred (outstring partially formatted) 8 Invalid numspec parameter 9 Invalid fmtmask parameter * Do not apply to calls with langnum equal to 0 (NATIVE3000/XL). numspec 16-bit unsigned integer by value (optional) Returns a byte array from NLNUMSPEC, containing format information.
Command Definitions (MAIL-PUTJCW) NLCONVNUM For languages using an alternate set of digits (ARABIC and HINDI digits only), this intrinsic converts the digits to ASCII for recognition and use as numeric characters.
Command Definitions (MAIL-PUTJCW) NLFINDSTR NLFINDSTR NM and CM callable. Searches string1 for string2, and returns an integer value indicating the offset in string1 where string2 was found. Syntax I16 I16V CA I16V CA offset:=NLFINDSTR(langnum,string1,length1,string2, I16V U16A U16A length2,error,charset); Functional Return offset 16-bit signed integer (assigned functional return) Returns a -1 if string2 is not found in string1.
Command Definitions (MAIL-PUTJCW) NLFINDSTR 3 Invalid length1 parameter 4 Invalid length2 parameter 5 *NLS internal error 6 *NLS internal error * Do not apply to calls with langnum equal to 0 (NATIVE3000/XL). charset 16-bit unsigned integer array (optional) Contains the character set definition for the language to be used, as returned by itemnum= 12 of the NLINFO intrinsic. When specifying a character set, be sure that the language ID used matches the character set.
Command Definitions (MAIL-PUTJCW) NLFMTCALENDAR 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.
Command Definitions (MAIL-PUTJCW) NLFMTCALENDAR Related Information Intrinsics NLCONVCLOCK, NLCONVCUSTDATE, NLFMTCLOCK, NLFMTCUSTDATE, NLFMTDATE, NLFMTLONGCAL Manual Native Language Programmer's Guide 526 Chapter 9
Command Definitions (MAIL-PUTJCW) NLFMTCLOCK NLFMTCLOCK NM and CM callable. Formats the time of day, in the specified language, obtained with the CLOCK intrinsic.
Command Definitions (MAIL-PUTJCW) NLFMTCLOCK * Do not apply to calls with a langnum equal to 0 (NATIVE3000/XL).
Command Definitions (MAIL-PUTJCW) NLFMTCUSTDATE 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.
Command Definitions (MAIL-PUTJCW) NLFMTCUSTDATE * Do not apply to calls with a langnum equal to 0 (NATIVE3000/XL).
Command Definitions (MAIL-PUTJCW) NLFMTDATE NLFMTDATE NM and CM callable. Formats the date and time according to language-dependent templates returned by itemnums 1 and 3 of the NLINFO intrinsic.
Command Definitions (MAIL-PUTJCW) NLFMTDATE 3 Invalid date value 4 Invalid time value 5 *NLS internal error 6 *NLS internal error * Do not apply to calls with a langnum equal to 0 (NATIVE3000/XL).
Command Definitions (MAIL-PUTJCW) NLFMTLONGCAL 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.
Command Definitions (MAIL-PUTJCW) NLFMTLONGCAL Operation Notes Split-stack calls are not permitted.
Command Definitions (MAIL-PUTJCW) NLFMTNUM NLFMTNUM NM and CM callable. Converts a string containing an ASCII number (can include NATIVE-3000 decimal separator (.), thousands separator (,), and currency symbol/name ($)) to a language-specific format using the decimal separator, thousands separator, and currency symbol/name defined for the native language.
Command Definitions (MAIL-PUTJCW) NLFMTNUM 1 *NLS not installed 2 *Specified language not configured 3 Invalid length specified (inlength or outlength) 4 Invalid number specified (instring) 5 *NLS internal error 6 *NLS internal error 7 Truncation occurred (outstring partially formatted) 8 Invalid numspec parameter 9 Invalid fmtmask parameter 10 Invalid decimals parameter * Do not apply to calls with a langnum equal to 0 (NATIVE3000/XL).
Command Definitions (MAIL-PUTJCW) NLFMTNUM fmtmask 16-bit unsigned integer by value (optional) Contains formatting specifications for the input. The default value is 0, a simple substitution.
Command Definitions (MAIL-PUTJCW) NLFMTNUM They must be the character(s) in instring. Even if insertion (of the separators) is specified in fmtmask, the thousands and decimal separators are still valid characters in the input. In this case, they are substituted. If no justification is specified, the output is right-justified with the same number of trailing spaces as the input. If the output is truncated, it is left-truncated.
Command Definitions (MAIL-PUTJCW) NLGETLANG NLGETLANG NM and CM callable. Returns a language ID number that characterizes the current user, data, or system. Hewlett-Packard subsystems and application programs use NLGETLANG for automatic configuration. 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.
Command Definitions (MAIL-PUTJCW) NLGETLANG Operation Notes The NLGETLANG intrinsic locates the language ID numbers requested by langtype 1 and 2 by referring to the Hewlett-Packard defined job control words (JCWs), NLUSERLANG and NLDATALANG respectively. If the required JCW does not exist or has a value greater than or equal to FATAL (32768), The error value of 4 is returned.
Command Definitions (MAIL-PUTJCW) NLINFO 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) Contains the item to be returned.
Command Definitions (MAIL-PUTJCW) NLINFO 3 *Specified character set not configured 4 No national table present 5 *NLS internal error 6 *NLS internal error 7-9 Reserved for the operating system 10 Itemnum out of range * Do not apply to calls with a langnum equal to 0 (NATIVE3000/XL). Itemnum/ Mnemonic 1/CA Item Description Returns the calendar format in an 18 byte array. The 18 bytes of the string for this definition are interpreted as the format description for that language.
Command Definitions (MAIL-PUTJCW) NLINFO yyyy Numeric year Nyy National year NPyy National year that can include a before-period symbol Valid separators are any special character. For example, a date format can be yy/mm/dd. This format in NATIVE3000/XL results in 81/03/25. 3/CA Returns the clock specification in an 8 byte array.
Command Definitions (MAIL-PUTJCW) NLINFO ...SATURDAY" 8/CA Returns the YES/NO responses in a 12 byte array; the first 6 bytes contain the (upshifted) YES response; the second 6 bytes contain the (upshifted) NO response. 9/CA Returns the symbols for decimal separator and thousands indicator in a 2 byte array. The first byte contains the decimal separator, the second byte contains the thousands indicator. The second byte can take a special value of 0.
Command Definitions (MAIL-PUTJCW) NLINFO 16/CA Returns the downshift table in a 256 byte array. 17/CA Returns the language numbers of all configured languages. The first element of this array contains the number of configured languages. The second element contains the language number of the first configured language. The third element contains the language number of the second configured language, and so forth. (The langnum parameter is disregarded.
Command Definitions (MAIL-PUTJCW) NLINFO M 1-4 of these are replaced by an equal number of bytes from the month abbreviation. O 1-12 of these are replaced by an equal number of bytes from the month of year. mm Numeric month of year. yy Numeric year of century. Nyy National year. NPyy National year that can include a before-period symbol. E 1-8 of these are replaced by an equal number of bytes from the emperor/country name.
Command Definitions (MAIL-PUTJCW) NLINFO 35/U16 35/U16 A logical value that returns the language character size. 0 1 byte characters (8-bits) 1 2 byte characters (16-bits) A logical value that returns a true (1), if the language requires suppressing the leading zero or a blank in the date format.
Command Definitions (MAIL-PUTJCW) NLJUDGE 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 flags,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.
Command Definitions (MAIL-PUTJCW) NLJUDGE 1 *NLS not installed 2 *Specified language not configured 3 Invalid string length 4 Not returned 5 *NLS internal error 6 *NLS internal error 7 *Invalid characters found in instring * Do not apply to calls with langnum equal to 0 (NATIVE-3000). charset 16-bit unsigned integer array (optional) Contains the character set definition for the language to be used, as returned by itemnum=12 of NLINFO.
Command Definitions (MAIL-PUTJCW) NLKEYCOMPARE NLKEYCOMPARE NM and CM callable. Compares two strings of different 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) Passes the generic key to be compared to the keys contained in the record read by FREAD.
Command Definitions (MAIL-PUTJCW) NLKEYCOMPARE collates after the specified key). This means that the FREAD call found a record whose key follows the specified range. No records matching generickey follow. langnum 16-bit signed integer by value (required) Contains the language ID number, specifying the collating sequence to be used for the compare.
Command Definitions (MAIL-PUTJCW) NLMATCH NLMATCH Compares a string against a pattern which has previously been compiled with the NLMATCHINIT intrinsic. Syntax I BA BA IV result := NLMATCH(comp_pattern,string,length); Functional Return Zero is returned in result if the string matches the compiled comp_pattern. If there is no match, the mismatch location is returned.
Command Definitions (MAIL-PUTJCW) NLMATCHINIT NLMATCHINIT Compiles a pattern into a form for use with the NLMATCH intrinsic. Syntax I BA I result := NLMATCHINIT(pattern,pattern_len, IV BA I langid,comp_pattern,comp_buf_size); Functional Return Zero is returned if the compilation of pattern is successful. Otherwise the result contains the error code.
Command Definitions (MAIL-PUTJCW) NLMATCHINIT ? Any character Other metacharacter indicate choice, grouping, and ranges: Char Selected ! 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 Operation Example ! Transparency !x : Range x:y Repetition (1/0 or more) x+ or x* Concatenation xy Choice x,y +/* , The
Command Definitions (MAIL-PUTJCW) NLMATCHINIT 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. If comp_buf_size > 0 (zero), the comp_pattern contains the compiled pattern and comp_buf_size contains its actual size in bytes. If NLMATCHINIT is not zero, an error occurred and NLMATCHINIT returns the error code in return.
Command Definitions (MAIL-PUTJCW) 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.
Command Definitions (MAIL-PUTJCW) NLNUMSPEC 2 Currency symbol replaces the decimal separator 3 Currency symbol precedes the sign 18-19 Length of currency symbol (integer), includes spaces 20-37 Currency symbol, includes spaces 38-59 Reserved for the operating system error 16-bit unsigned integer array (required) Returns two elements: the first element is the error number; the second element is reserved and always returns 0.
Command Definitions (MAIL-PUTJCW) 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 (undefined graphic character) or 5 (control code), as returned by itemnum=12 of the NLINFO intrinsic.
Command Definitions (MAIL-PUTJCW) NLREPCHAR 7 Invalid charset table entry 8 Overlapping strings, outbuffer overwrites inbuffer * Do not apply to calls with a langnum equal to 0 (NATIVE3000/XL). charset 16-bit unsigned integer array (optional) Passes the character set definition for the language used, as returned in NLINFO itemnum= 12. If this parameter is present, langnum is ignored, and this intrinsic is more efficient.
Command Definitions (MAIL-PUTJCW) 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 CA U16V numchar:=NLSCANMOVE(inbuffer,outbuffer,flags, I16V I16V U16A bufferlength,langnum,error, U16A CA charset,shiftinfo); Functional Return 16-bit signed integer (assigned functional return) numchar Contains the number of characters acted upon in the scan or move function.
Command Definitions (MAIL-PUTJCW) NLSCANMOVE 11:1 9:2 0:9 3 Undefined graphic character 4 Special character 5 Control code WHILE/UNTIL option, if: 0 String scanned while the condition (specified by flags (12:4)) is true 1 String scanned until the condition (specified by flags (12:4)) is true Shift: 1 Upshift 2 Downshift Reserved for the operating system bufferlength 16-bit signed integer by value (required) Passes the maximum number of bytes to be acted upon during the indicated function.
Command Definitions (MAIL-PUTJCW) NLSCANMOVE NLINFO itemnum=12. If present, the langnum parameter is ignored, and this routine is much more efficient. shiftinfo character array (optional) Passes shift information for a desired upshift or downshift (for example, as returned in NLINFO items 15 or 16 ). This parameter is utilized when bits (9:2) of flags are not equal to 0. If present, the langnum parameter is ignored, and this routine is much more efficient.
Command Definitions (MAIL-PUTJCW) NLSUBSTR 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 flags,error,charset); Parameters instring character array (required) Contains the string from which the substring is extracted. The string can contain both 1 byte and 2 byte Asian characters.
Command Definitions (MAIL-PUTJCW) NLSUBSTR Asian character: 8:4 0000 Return an error condition 0001 Start from startposition +1 0010 Start from startposition -1 0011 Start from startposition, but replace character with a blank in outstring 0100 Start from startposition regardless Used if the last character in a substring is the first byte of a 2 byte Asian character: 0000 Return an error condition 0001 Move until movelength +1 0010 Move until movelength -1 0011 Move until movelength, but
Command Definitions (MAIL-PUTJCW) NLSUBSTR 14 *End position second byte of an Asian character, or an overflow condition occurred due to flags * Do not apply to calls with langnum equal to 0 (NATIVE-3000). charset 16-bit unsigned integer array (optional) Contains the character set definition for the language to be used, as returned by itemnum= 12 of NLINFO. When specifying a character set, be sure that the language ID used matches the character set. Operation Notes Split-stack calls are not permitted.
Command Definitions (MAIL-PUTJCW) 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) Contains the language ID number. instring character array (required) Contains the string, in phonetic order, to be converted to screen order.
Command Definitions (MAIL-PUTJCW) NLSWITCHBUF 5 *NLS internal error 6 *NLS internal error * Do not apply to calls with langnum equal to 0 (NATIVE3000/XL). Operation Notes This intrinsic is designed to handle data for languages written from right-to-left (for example, ARABIC). Screen order is defined right-to-left if the primary mode of the terminal or printer is from right-to-left, as it is when used principally for entering or displaying data from a right-to-left language.
Command Definitions (MAIL-PUTJCW) NLTRANSLATE NLTRANSLATE NM and CM callable. Translates a string of characters from EBCDIC-to-ASCII or ASCII-to-EBCDIC using the appropriate native language table.
Command Definitions (MAIL-PUTJCW) NLTRANSLATE 4 Invalid length parameter 5 *NLS internal error 6 *NLS internal error * Do not apply to calls with a langnum equal to 0 (NATIVE3000/XL). transtable character array (optional) Passes a translation table in a 256 byte array. Each byte contains the translation of the byte whose value is its index. This parameter corresponds to itemnums 13 and 14 of the NLINFO intrinsic. If present, the langnum parameter is ignored, and this routine is more efficient.
Command Definitions (MAIL-PUTJCW) OPENLOG OPENLOG NM and CM callable. Provides access to the user logging facility. Syntax I32 CA CA I16 I16 OPENLOG(index,logid,pass,mode,logstatus); Parameters index 32-bit signed integer by reference (required) 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. The value returned is valid only for the process that made the OPENLOG call.
Command Definitions (MAIL-PUTJCW) OPENLOG 3 Request to open or write to a user logging process not running 5 Incorrect mode parameter passed 6 Request denied; user logging process suspended 7 Illegal capability; user logging (LG) or system supervisor (OP) capability required 8 Incorrect password passed 9 Error while writing to the user logging file 12 System out of disk space; user logging cannot proceed 13 Out of user logging entries 15 End-of-file on user logging file 16 Invalid user l
Command Definitions (MAIL-PUTJCW) PAUSE PAUSE NM and CM callable. Suspends the calling process for a specified 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 affecting the time countdown process.
Command Definitions (MAIL-PUTJCW) 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) Passes the string of ASCII characters to $STDLIST. length 16-bit signed integer by value (required) 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.
Command Definitions (MAIL-PUTJCW) PRINTFILEINFO PRINTFILEINFO NM and CM callable. Prints a file information display on the job/session list device. Syntax I16V PRINTFILEINFO(filenum); Parameters filenum 16-bit signed integer by value (required) Passes the file number of the file to be displayed. Operation Notes Hierarchical directories and files can be opened using FOPEN or HPOPEN intrinsic. PRINTFILEINFO is used to display file information for any type of directory or file.
Command Definitions (MAIL-PUTJCW) 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) 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. length 16-bit signed integer by value (required) Passes the length of the output string to be transmitted.
Command Definitions (MAIL-PUTJCW) 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.
Command Definitions (MAIL-PUTJCW) PRINTOPREPLY negative, it specifies a byte count. Do not specify a length of >31 bytes. Condition Codes CCE (2) Request granted. CCG (0) Not returned. CCL (1) Request denied. A physical I/O error occurred. Further error analysis through the FCHECK intrinsic is not possible.
Command Definitions (MAIL-PUTJCW) 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) Returns a value indicating the success or failure of the intrinsic call. Refer to Table 9-1..
Command Definitions (MAIL-PUTJCW) PROCINFO Table 9-1.
Command Definitions (MAIL-PUTJCW) PROCINFO Table 9-2. PROCINFO Itemnum/Item Values Itemnum Mnemonic 3 I16 Item Description Number of children of the process specified 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.
Command Definitions (MAIL-PUTJCW) PROCINFO Table 9-2. PROCINFO Itemnum/Item Values Itemnum Mnemonic 6 I16A Item Description Process identification numbers (PINs) of all children of the process specified by pin. A variable number of PINs are returned; item must be a 16-bit signed integer array. The first element of the array must be set by the calling process to indicate the array size.
Command Definitions (MAIL-PUTJCW) PROCINFO Table 9-2. PROCINFO Itemnum/Item Values Itemnum Mnemonic 10 CA Item Description Program name that the process specified 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 file.group.account, where file is the local file name, group is the group name, and account is the account name of the file containing the program that the specified process is currently executing.
Command Definitions (MAIL-PUTJCW) PROCINFO CCG (0) Not returned. CCL (1) Request denied. Error codes set and returned in error1 and error2.
Command Definitions (MAIL-PUTJCW) 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.
Command Definitions (MAIL-PUTJCW) PUTJCW 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) 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.
Command Definitions (MAIL-PUTJCW) PUTJCW • System-reserved An attempt to assign a value to a system-reserved JCW results in an error.
10 Command Definitions (QUIT-ZSIZE) This chapter continues the description of 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 files only. (ASC) For use with asynchronous serial communications only. (SPL) For use with SPL programming language only.
Command Definitions (QUIT-ZSIZE) QUIT 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.
Command Definitions (QUIT-ZSIZE) 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.
Command Definitions (QUIT-ZSIZE) READ READ NM and CM callable. Reads an ASCII string from $STDIN into an array. Syntax I16 CA I16V length:=READ(message,msglength); Functional Return 16-bit signed integer (assigned functional return) length The length of the ASCII string that was read. If msglength is positive, the length specified is in half words; if negative, the length specified is in bytes. Parameters message character array (required) Returns the ASCII characters that were read.
Command Definitions (QUIT-ZSIZE) READ • 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 file's actual EOF is interpreted as the valid EOF indicator. Condition Codes CCE (2) Request granted. CCG (0) Request granted. A record with a colon in the first column, signaling the end-of-data or a hardware end-of-file, was encountered. CCL (1) Request denied.
Command Definitions (QUIT-ZSIZE) READX READX NM and CM callable. Reads an ASCII string from $STDINX into an array. Syntax I16 CA I16V length:=READX(message,msglength); Functional Return 16-bit signed integer (assigned functional return) length The length of the ASCII string that was read. If msglength is positive, the length specified is in half words; if negative, the length specified is in bytes. Parameters message character array (required) Returns the ASCII characters that were read.
Command Definitions (QUIT-ZSIZE) READX If $STDIN is redirected, only the file's actual EOF is interpreted as the valid EOF indicator. Condition Codes CCE (2) Request granted. CCG (0) An EOD, EOF, or in a job, EOJ, JOB, or DATA command was encountered. CCL (1) Request denied. A physical I/O error occurred. Further error analysis through the FCHECK intrinsic is not possible.
Command Definitions (QUIT-ZSIZE) RECEIVEMAIL 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,waitflag); Functional Return mailstatus 16-bit unsigned integer (assigned functional return) Returns one of the following values: Value Meaning 0 Mailbox empty and waitflag bit (15:1)=0. 1 No message collected, the mailbox contained outgoing mail from the receiving process.
Command Definitions (QUIT-ZSIZE) RECEIVEMAIL 1 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. If the mailbox for the receiving process is empty, the action taken depends on the waitflag parameter specified in the RECEIVEMAIL intrinsic call. If the mailbox is currently in use by another process, RECEIVEMAIL waits until the mailbox is free before accessing it.
Command Definitions (QUIT-ZSIZE) RESETCONTROL 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.
Command Definitions (QUIT-ZSIZE) RESETDUMP RESETDUMP NM and CM callable. Disables the abort stack analysis facility. Only the current process is affected. Syntax RESETDUMP; Condition Codes CCE (2) Request granted. CCG (0) The abort stack analysis facility was disabled prior to the RESETDUMP call and remains disabled. CCL (1) Not returned.
Command Definitions (QUIT-ZSIZE) SEARCH SEARCH NM and CM callable (differences noted below). Searches a specially-formatted array for a specified entry or name. Syntax I16 CA I16V CA entrynum:=SEARCH(buffer,length,dictionary, @* definition); Functional Return entrynum 16-bit signed integer (assigned functional return) Returns the entry number of the name in dictionary that matches buffer. If the name specified in buffer is not found, a zero is returned.
Command Definitions (QUIT-ZSIZE) 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 (definition). 5,1,"I","IN", 6,1,"O","OUT", 7,1,"S","SKIP", 7,1,"E","EXIT", 0; In this model, the first entry specifies that the entry's length is five bytes. The name ("I") is one byte and its definition is "IN".
Command Definitions (QUIT-ZSIZE) SENDMAIL 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,waitflag); Functional Return mailstatus 16-bit unsigned integer (assigned functional return) Returns one of the following values: Value Meaning 0 Mail transmitted successfully and mailbox contained no previous mail.
Command Definitions (QUIT-ZSIZE) SENDMAIL outgoing mail. location user-defined structure (required) The buffer containing the message. waitflag 16-bit unsigned integer by value (required) Action to be taken if the mailbox contains previously sent mail, as specified in bit (15:1): Bits Value/Meaning 0 Cancel (overwrite) any mail sent previously with the current mail. 1 Wait until the receiving process collects the previous mail before sending current mail.
Command Definitions (QUIT-ZSIZE) SETDUMP SETDUMP NM and CM callable. Arms a call to the system debugger from a process abort. Syntax I16V SETDUMP(flags); Parameters flags 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.
Command Definitions (QUIT-ZSIZE) SETDUMP Related Information Intrinsics HPRESETDUMP, HPSETDUMP, RESETDUMP, STACKDUMP Commands SETDUMP Manual MPE/iX System Debug Reference Manual Chapter 10 603
Command Definitions (QUIT-ZSIZE) SETJCW 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-defined bit contents of the system JCW for interprocess communication.
Command Definitions (QUIT-ZSIZE) SORTEND SORTEND NM and CM callable. Closes the scratch file 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 file are completed by the SORTINIT intrinsic, or after all calls to the SORTOUTPUT intrinsic are completed.
Command Definitions (QUIT-ZSIZE) SORTERRORMESS 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 Returns the error number from SORTINIT in the errorparm parameter. message character array Returns the text of the error message. This parameter must be at least 80 characters long.
Command Definitions (QUIT-ZSIZE) SORTINIT SORTINIT NM and CM callable. Initiates the SORT program. Syntax I16A I16A I16V SORTINIT(inputfiles,outputfiles,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 inputfiles 16-bit signed integer array (optional) Passes the file identification numbers of the input files to be sorted.
Command Definitions (QUIT-ZSIZE) SORTINIT Passes the maximum length of a record in characters. If you do not specify reclength, the record length is taken from the first file specified in the inputfiles parameter. If this parameter is not specified, the inputfiles parameter must be specified. numrecs 32-bit signed integer by value (optional) Passes the upper bound to the number of records to be sorted.
Command Definitions (QUIT-ZSIZE) SORTINIT NOTE altseq The integrity of the keys array must be maintained throughout the SORT operation. Do not change it until after the SORTEND intrinsic has been called. 16-bit signed integer array (optional) Passes an alternate collating sequence.
Command Definitions (QUIT-ZSIZE) SORTINIT SORTERRORMESS intrinsic to obtain the error message text. spaceallocation 16-bit signed integer (reserved) Do not specify this parameter, but maintain parameter position. charseq 16-bit signed integer array (optional) Passes language information in a two-element array. Set the first element to 1. Set the second element to the language ID number of the native language whose collating sequence is to be used to sort keys of type 9 (character).
Command Definitions (QUIT-ZSIZE) SORTINPUT 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 Passes the next input data record. length 16-bit signed integer Passes the length of the record parameter value.
Command Definitions (QUIT-ZSIZE) 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 Returns the next output record. The format of this record is specified in the outputoption parameter of the SORTINIT intrinsic. length 16-bit signed integer Returns the length of the record parameter value.
Command Definitions (QUIT-ZSIZE) SORTSTAT SORTSTAT NM and CM callable. Prints the SORT program statistics on $STDLIST. Call SORTSTAT after you have called the SORTEND intrinsic.
Command Definitions (QUIT-ZSIZE) SORTTITLE 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.
Command Definitions (QUIT-ZSIZE) STACKDUMP STACKDUMP NM and CM callable (differences noted below). Calls the system debugger to send a stack trace to $STDLIST or to the file specified in the formaldesig parameter. Control then returns to the calling procedure.
Command Definitions (QUIT-ZSIZE) STACKDUMP Condition Codes CCE (2) Request granted. CCG (0) Request denied. An invalid address for the location of the formaldesig parameter was detected. CCL (1) Request denied. File system error occurred during opening, writing to, or closing the file. The file error number is returned in idnumber.
Command Definitions (QUIT-ZSIZE) STARTSESS STARTSESS NM and CM callable. Initiates a session on the specified 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).
Command Definitions (QUIT-ZSIZE) STARTSESS status information.
Command Definitions (QUIT-ZSIZE) STARTSESS Chapter 10 7008 ldev specified not a real device 7009 Caller requires programmatic sessions (PS) capability 7010 Semicolon (;) delimiter is missing 7011 The LDEV is not a valid integer 7012 The LDEV cannot be a negative number 7014 Session was aborted before logging on 7015 Logon failed because system is at its session limit 7016 Logon failed because the session's INPRI was <= system jobfence 7017 Logon failed because the system was unable to obt
Command Definitions (QUIT-ZSIZE) STARTSESS NOTE 7034 Logon failed because the session's logon group is out of connect time 7035 Logon string was not terminated with a carriage-return character (%15) 7036 The LDEV has an invalid type and subtype for a programmatic session 7039 Internal programmatic session error 7040 Unable to allocate $STDERR, or logon failed because of a failure to open $STDERR 7042 Group is not specified, and there is no default home group Error messages with numbers in the
Command Definitions (QUIT-ZSIZE) SUSPEND SUSPEND NM and CM callable. Suspends a process. Process handling (PH) capability is required.
Command Definitions (QUIT-ZSIZE) SUSPEND it begins execution with the instruction immediately following the SUSPEND call. Condition Codes CCE (2) Request granted. CCG (0) Not returned. CCL (1) Request denied. The allow parameter is not valid, the specified RIN is not owned by this process, or the specified RIN was not locked.
Command Definitions (QUIT-ZSIZE) SWITCHDB 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.
Command Definitions (QUIT-ZSIZE) TERMINATE TERMINATE NM and CM callable. Releases all resources held by the process and its descendants are released. All remaining files, opened by the process and its descendants, are closed and assigned the same disposition they had when opened.
Command Definitions (QUIT-ZSIZE) TIMER 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.
Command Definitions (QUIT-ZSIZE) 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) Request granted. CCG (0) Not returned. CCL (1) Request denied. An invalid procid was specified.
Command Definitions (QUIT-ZSIZE) UNLOCKGLORIN UNLOCKGLORIN NM and CM callable. The UNLOCKGLORIN intrinsic unlocks a global resource identification 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) Request granted.
Command Definitions (QUIT-ZSIZE) UNLOCKLOCRIN UNLOCKLOCRIN NM and CM callable. The UNLOCKLOCRIN intrinsic unlocks a local resource identification 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 specified in the rincount parameter of the GETLOCRIN intrinsic call. Condition Codes CCE (2) Request granted. CCG (0) Request denied.
Command Definitions (QUIT-ZSIZE) WHO 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.
Command Definitions (QUIT-ZSIZE) WHO localattr Bits Value/Meaning 0:1 System manager (SM) 1:1 Account manager (AM) 2:1 Account librarian (AL) 3:1 Group librarian (GL) 4:1 Diagnostician (DI) 5:1 System supervisor (OP) 6:1 Volume set creation (CV) 7:1 Volume set usage (UV) 8:1 User logging (LG) 9:4 Reserved for the operating system 13:1 Communications system (CS) 14:1 Nonshareable devices (ND) 15:1 Save files (SF) 16:7 Reserved for the operating system 23:1 Batch access (BA)
Command Definitions (QUIT-ZSIZE) WHO home group is not assigned, this array is filled with blanks. term 16-bit unsigned integer by reference (optional) Returns the logical device number of the job/session input device. If this is a spooled (STREAM) batch job, then the logical device number is the virtual device. A virtual device simulates a spooling device. Users cannot own the actual spooling device, so the virtual device allows users access to spooling.
Command Definitions (QUIT-ZSIZE) WRITELOG WRITELOG NM and CM callable. Writes database and subsystem file records to the user logging file. User logging (LG) or system supervisor (OP) capability is required. Syntax I32 U16A I16 I16 I16 WRITELOG(index,data,length,mode,logstatus); Parameters index 32-bit signed integer by reference (required) Passes your access to the user logging system. This is the value returned in the index parameter of the OPENLOG intrinsic.
Command Definitions (QUIT-ZSIZE) WRITELOG Value Meaning 0 Successful 1 Nowait requested, user logging process busy 2 Parameter out of bounds 4 Incorrect index parameter passed 5 Incorrect mode parameter passed 9 Error occurred while writing 12 System out of disk space; user logging cannot proceed 14 Invalid access 15 End-of-file on user log file Related Information Intrinsics BEGINLOG, ENDLOG Manual User Logging Programmer's Guide Chapter 10 633
Command Definitions (QUIT-ZSIZE) XARITRAP XARITRAP NM and CM callable (differences 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 floating-point exceptions are enabled, and the system trap handler is armed. Many floating-point operations result in an inexact result.
Command Definitions (QUIT-ZSIZE) XARITRAP 18:1 Decimal divide by zero 17:1 IEEE floating-point inexact result 16:1 IEEE floating-point underflow 15:1 IEEE floating-point overflow 14:1 IEEE floating-point divide by zero 13:1 IEEE floating-point invalid operation 12:1 Range errors 11:1 Software-detected NIL pointer reference 10:1 Software-detected misaligned result of pointer arithmetic or error in conversion from long pointer to short pointer 9:1 Unimplemented condition traps 8:1 Paragr
Command Definitions (QUIT-ZSIZE) XARITRAP bits in the mask for enabling/disabling traps of these formats. • Some error conditions specified here are not strictly arithmetic traps (for example, range errors, nil pointers, and paragraph stack overflow). However, many arithmetic traps are caught by reserved instructions that raise the conditional traps. For this reason, all are enabled/disabled by XARITRAP. • Some instructions that raise conditional traps are reserved to indicate the above trap conditions.
Command Definitions (QUIT-ZSIZE) XARITRAP • If a trap is disabled, irrespective of whether it is armed, the trap is ignored, and execution of the process continues without any interruption. Condition Codes CCE (2) Request granted. The desired traps are now armed. CCG (0) Request granted. All traps are now disarmed. CCL (1) Not returned.
Command Definitions (QUIT-ZSIZE) XCONTRAP XCONTRAP NM and CM callable (difference noted below). Arms or disarms user-written subsystem break trap handling procedure. Syntax I*V I* XCONTRAP(plabel,oldplabel); NOTE 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.
Command Definitions (QUIT-ZSIZE) XCONTRAP 0:16 16-bit external CM plabel oldplabel (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 configured, oldplabel returns 0. Operation Notes Call XCONTRAP to arm a user-written subsystem break trap handling procedure.
Command Definitions (QUIT-ZSIZE) XLIBTRAP XLIBTRAP NM and CM callable (differences noted below). Enables or disables a user-written software library trap handling procedure. Syntax I*V I* XLIBTRAP(plabel,oldplabel); NOTE 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.
Command Definitions (QUIT-ZSIZE) XSYSTRAP XSYSTRAP NM and CM callable (differences noted below). Enables or disables a user-written system trap handling procedure. Syntax I*V I* XSYSTRAP(plabel,oldplabel); NOTE 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.
Command Definitions (QUIT-ZSIZE) ZSIZE 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.
Command Definitions (QUIT-ZSIZE) ZSIZE Related Information None Chapter 10 643
Command Definitions (QUIT-ZSIZE) ZSIZE 644 Chapter 10
Index A Abort calling process QUIT, 588 Abort entire user process structure QUITPROG, 589 Abort errors, 28 Abort specified job/session ABORTSESS, 44 Abort stack analysis facility, disable RESETDUMP, 597 ABORTSESS Abort specified job/session, 44 Accept another CONTROL-Y signal RESETCONTROL, 596 Access file, predefine characteristics FOPEN, 226 Access file, terminate FCLOSE, 118 Access information returned, file FGETINFO, 192 Access job and session information JOBINFO, 477 Access message catalogs GENMESSAGE,
Index ASCII string, convert to 16-bit binary BINARY, 61 ASCII string, read $STDIN into array READ, 590 ASCII string, read $STDINX into array READX, 592 Assign system-defined files and create process CREATEPROCESS, 83 Assign value of JCW in JCW table PUTJCW, 585 Attribute, retrieve session-level HPCIGETVAR, 325 B BEGINLOG Mark beginning of user logging transaction, 59 BINARY Convert number from ASCII string to 16-bit binary, 61 Binary conversion, 16-bit to numeric ASCII string ASCII, 57 Binary floating-poin
Index Delete inactive entries from USL file, 70 CLOCK Return system time, 72 Close a file FCLOSE, 118 Close access to user logging facility CLOSELOG, 73 Close scratch file and restore data stack SORTEND, 605 Close specified application message catalog file CATCLOSE, 64 CLOSELOG Close access to user logging facility, 73 CM from NM, mixed-mode execution HPSWITCHTOCM, 445 CM plabel, get for switch to CM HPLOADCMPROCEDURE, 403 Code, condition, 25 Coding procedures Intrinsic, 17 Collectively enables/disables ar
Index Copy data from extra data segment DMOVIN, 98 CPU time, return for process PROCTIME, 584 CREATE Create a process, 77 Create a process CREATE, 77 Create extra data segment GETDSEG, 297 Create file on shareable device HPFOPEN, 369 Create process and assign system-defined files CREATEPROCESS, 83 CREATEPROCESS Create process and assign system-defined files, 83 Creates pipe file type object HPPIPE, 423 Creating link files, 344 CTRANSLATE Convert string from EBCDIC to ASCII, 88 Current date and time returne
Index Define Itemnum and item pair options, 22 Define file and establish access FOPEN, 226 Define parameter bit setting, 21 Delete calling process TERMINATE, 624 Delete child process KILL, 483 Delete entry from session-level variable table HPCIDELETEVAR, 324 Delete inactive entries from USL file CLEANUSL, 70 Description Functional return, 24 Determine Byte Size of Character NLJUDGE, 548 Determine if file pair is inactive/duplicative FRELATE, 269 Determine process PIN that locked local RIN LOCRINOWNER, 490
Index ENDLOG Mark end of user logging transaction, 102 Enter privileged mode, dynamically GETPRIVMODE, 306 Entries, clean inactive from USL file CLEANUSL, 70 Entry, delete from variable table HPCIDELETEVAR, 324 Entry, search array for specified SEARCH, 598 Error Abort, 28 Condition codes, 25 Status parameter, 25 Error information for file I/O errors, return FCHECK, 107 Error message, get/display for system catalog HPERRMSG, 353 Error message, retrieve if fatal HPMERGEERRORMESS, 409 HPSORTERRORMESS, 435 Err
Index Status information for KSAM file, 200 File access FOPEN, 226 File access, terminate FCLOSE, 118 File designator, parse and validate FPARSE, 247 File display, print on list device PRINTFILEINFO, 574 File has exception condition HPSELECT, 426 File I/O errors, error information returned FCHECK, 107 File information returned FFILEINFO, 166 File information returned, access FGETINFO, 192 File information returned, status FGETINFO, 192 File label information, disk file returned FLABELINFO, 207 File label,
Index Logical record, read randomly, 257 Read logical record randomly to data stack, 257 FREADC Logical record, read chronologically, 259 Read logical record chronologically to data stack, 259 FREADDIR Read logical record from direct access disk file, 261 FREADLABEL Read user file label, 263 FREADSEEK Move record from disk file to buffer, 265 Free local RINs from allocation to job FREELOCRIN, 268 FREEDSEG Release extra data segment, 266 FREELOCRIN Free local RINs from allocation to job, 268 FRELATE Deter
Index Mapping data types, 22 Inactive entries, clean from USL file CLEANUSL, 70 Inactive/duplicative, determine file pair FRELATE, 269 Increase length of USL file EXPANDUSLF, 104 Information about open User Logging file LOGINFO, 491 LOGSTATUS, 493 Information, return user-supplied GETINFO, 299 Initialize MERGE subsystem HPMERGEINIT, 411 MERGEINIT, 500 Initialize the SORT subsystem HPSORTINIT, 436 Initialize USL file to empty state INITUSLF, 471 Initiate completion for I/O request IODONTWAIT, 473 IOWAIT, 47
Index Load compatibility mode SL procedure LOADPROC, 484 Load native mode library procedure HPGETPROCPLABEL, 401 LOADPROC Load compatibility mode SL procedure, 484 Local RINs, acquire GETLOCRIN, 302 Local RINs, free from allocation to job FREELOCRIN, 268 Lock file for exclusive use FLOCK, 219 Lock global RIN LOCKGLORIN, 486 Lock local RIN LOCKLOCRIN, 488 LOCKGLORIN Lock global RIN, 486 LOCKLOCRIN Lock local RIN, 488 LOCRINOWNER Determine process PIN that locked local RIN, 490 Logical record pointer for di
Index Mnemonic Intrinsic, 21 Mnemonic, meaning, 21 mode Option Privileged, 21 Move and scan character strings NLSCANMOVE, 560 Move record from disk file to buffer FREADSEEK, 265 Move record pointer on tape/disk file FSPACE, 278 Multiple resource identification number (MR) Capability, 30 MYCOMMAND Parse user defined command image, 507 N Name translation Case-insensitive languages, 17 Name, search array for specified SEARCH, 598 Native mode library procedure, load HPGETPROCPLABEL, 401 NLAPPEND Concatenate fi
Index Output messages and access message facility CATREAD, 67 P Parameter Status error, 25 Parameter alignment, 20 Parameter bit setting, 21 Parameter checking, 17 Parameters, intrinsic, 15 Parent process, request PIN of FATHER, 106 Parent process, return status GETPROCINFO, 308 Parse and validate file designator FPARSE, 247 Parse user defined command image MYCOMMAND, 507 Pass records to SORT HPSORTINPUT, 440 PAUSE Suspend calling process for time specified, 572 Perform control operation on a file or devic
Index HPERRDEPTH, 351 Process handling (PH) Capability, 30 Process information, provide access PROCINFO, 578 Process stack, read error HPERRREAD, 356 Process structure, abort entire user QUITPROG, 589 Process, accept another CONTROL-Y signal RESETCONTROL, 596 Process, change priority GETPRIORITY, 304 Process, delete calling TERMINATE, 624 Process, receive mail from another RECEIVEMAIL, 594 Process, request PIN of parent FATHER, 106 Process, return CPU time PROCTIME, 584 Process, return source of activation
Index FREEDSEG, 266 Release SORT work area and end sort operation HPSORTEND, 433 Release work area and end merge HPMERGEEND, 408 Remove disk file FRENAME, 272 Replace nondisplayable characters of string NLREPCHAR, 558 Request KSAM access information FGETKEYINFO, 200 Request KSAM status information FGETKEYINFO, 200 Request PIN of parent process FATHER, 106 Request utility functions, 15 Required capabilities for intrinsic use, 29 RESETCONTROL Accept another CONTROL-Y signal, 596 RESETDUMP Disable abort stack
Index RIN, unlock global UNLOCKGLORIN, 627 RIN, unlock local UNLOCKLOCRIN, 628 RINs, acquire local GETLOCRIN, 302 RINs, free from allocation to job FREELOCRIN, 268 Routine header, 17 S Scan and move character strings NLSCANMOVE, 560 Scratch file, close and restore data stack SORTEND, 605 SEARCH Search array for specified entry/name, 598 Search array for specified entry/name SEARCH, 598 Search JCW table and return value FINDJCW, 202 Search String NLFINDSTR, 523 Send mail to another process SENDMAIL, 600 SEN
Index MERGEOUTPUT, 504 Spooled device file, control operations FDEVICECONTROL, 144 Stack trace, execute full STACKDUMP, 615 Stack, read logical record from file FREAD, 252 STACKDUMP Execute full stack trace, 615 STARTSESS Initiate session on specified terminal, 617 Statistics for SORT, print on $STDLIST HPSORTSTAT, 442 Statistics, print MERGE on $STDLIST HPMERGESTAT, 416 Status for parent/child process, return GETPROCINFO, 308 Status information for KSAM file FGETKEYINFO, 200 Status information returned, f
Index Time, format through language dependent template NLFMTDATE, 531 Time, return actual system CLOCK, 72 TIMER Return system timer information, 625 Title information, print on $STDLIST HPMERGETITLE, 418 Title, print on $STDLIST HPSORTTITLE, 444 MERGETITLE, 506 SORTTITLE, 614 Transaction, mark beginning of user logging BEGINLOG, 59 Translate string from/to EBCDIC NLTRANSLATE, 568 Trap handling procedure, arm/disarm XARITRAP, 634 XCONTRAP, 638 XLIBTRAP, 640 Trap, enable/disable HPENBLTRAP, 348 Trap, intrin
Index Version, print on $STDLIST HPSORTTITLE, 444 W WHO Return information about user, 629 Work area, release and end merge HPMERGEEND, 408 Write file ready, 426 Write logical record from stack to disk file FWRITEDIR, 289 Write logical/physical record from stack to file FWRITE, 283 Write record to User Logging file WRITELOG, 632 Write user file label FWRITELABEL, 291 WRITELOG Write record to User Logging file, 632 X XARITRAP Arm/disarm arithmetic trap handling procedure, 634 XCONTRAP Arm/disarm subsystem b
