Guardian Programming Reference Summary for pTAL and TAL Abstract This summary provides a quick reference to information required for Guardian programming in pTAL and TAL. Product Version G09 Supported Releases This manual supports G06.15 and all subsequent releases until otherwise indicated in a new edition.
Document History Part Number Product Version Published 098691 D20 September 1993 114339 D30 March 1995 138788 G06.03 December 1998 422954-001 G06.06 August 1999 522631-001 G09 February 2002 Ordering Information For manual ordering information: domestic U.S. customers, call 1-800-243-6886; international customers, contact your local sales representative. Document Disclaimer Information contained in a manual is subject to change without notice.
Guardian Programming Reference Summary for pTAL and TAL Tables What’s New in This Manual iii Manual Information iii New and Changed Information iv About This Manual v Your Comments Invited v Notation Conventions v Compaq Computer Corporation —522631-001 i
1. Process Name and ID Formats Contents 1. Process Name and ID Formats 2. File Codes 3. Device Types and Subtypes 4. Procedure Calls Summary (A-C) 5. Procedure Calls Summary (D-F) 6. Procedure Calls Summary (G-N) 7. Procedure Calls Summary (O-Q) 8. Procedure Calls Summary (R-Z) 9. CONTROL Operations 10. SET^FILE Operations 11. SETMODE Operations 12. Completion Codes 13. Traps 14. Interprocess Messages 15. Error Codes 16. ASCII Character Set 17.
What’s New in This Manual Manual Information Guardian Programming Reference Summary for pTAL and TAL Abstract This summary provides a quick reference to information required for Guardian programming in pTAL and TAL. Product Version G09 Supported Releases This manual supports G06.15 and all subsequent releases until otherwise indicated in a new edition.
What’s New in This Manual New and Changed Information New and Changed Information This revision of the Guardian Programming Reference Summary for pTAL and TAL includes the following changes: • • • An entry has been added to Section 4, Procedure Calls Summary (A-C), for the CPU_GETINFOLIST procedure that directs users to the PROCESSOR_GETINFOLIST_ documentation. The unsupported proc call GETSYSTEMSERIALNUMBER has been removed from Section 6, Procedure Calls Summary (G-N).
About This Manual Your Comments Invited After using this manual, please take a moment to send us your comments. You can do this by returning a Reader Comment Card or by sending an Internet mail message. A Reader Comment Card is located at the back of printed manuals and as a separate file on the Tandem User Documentation disc. You can either fax or mail the card to us. The fax number and mailing address are provided on the card. Also provided on the Reader Comment Card is an Internet mail address.
About This Manual General Syntax Notation { } Braces. A group of items enclosed in braces is a list from which you are required to choose one item. The items in the list may be arranged either vertically, with aligned braces on each side of the list, or horizontally, enclosed in a pair of braces and separated by vertical lines. For example: LISTOPENS PROCESS { $appl-mgr-name } { $process-name } ALLOWSU { ON | OFF } | Vertical Line.
Notation for Messages About This Manual !i and !o. In procedure calls, the !i notation follows an input parameter (one that passes data to the called procedure); the !o notation follows an output parameter (one that returns data to the calling program). For example: CALL CHECKRESIZESEGMENT ( segment-id , error ) ; !i !o !i,o. In procedure calls, the !i,o notation follows an input/output parameter (one that both passes data to the called procedure and returns data to the calling program).
Notation for Management Programming Interfaces About This Manual [ ] Brackets. Brackets enclose items that are sometimes, but not always, displayed. For example: Event number = number [ Subject = first-subject-value ] A group of items enclosed in brackets is a list of all possible items that can be displayed, of which one or none might actually be displayed.
Change Bar Notation About This Manual !o. The !o notation following a token or field name indicates that the token or field is optional. For example: ZSPI-TKN-MANAGER token-type ZSPI-TYP-FNAME32. !o Change Bar Notation Change bars are used to indicate substantive differences between this edition of the manual and the preceding edition. Change bars are vertical rules placed in the right margin of changed portions of text, figures, tables, examples, and so on.
About This Manual Change Bar Notation Guardian Programming Reference Summary for pTAL and TAL —522631-001 x
1 Process Name and ID Formats D-Series Process File Name Formats The syntax for a process file name that identifies an unnamed process is: [node]$:cpu:pin:seq-no The syntax for a process file name that identifies a named process is: [node]process-name[:seq-no][.qual-l[.qual-2]] node specifies the name of the node on which the process is running. A node name consists of a backslash (\) followed by as many as seven alphanumeric characters; the first alphanumeric character must be a letter.
Process Name and ID Formats Process Descriptors A process descriptor is a form of process file name that always includes the node and seq-no sections of the name; when identifying a named process, it never includes the optional qualifiers qual-1 or qual-2. Operating system procedures always use the external file-name notation when returning a process descriptor. Process Handles A process handle is a 10-word structure that identifies a single named or unnamed process.
2 File Codes For additional information about file codes, refer to the Guardian Procedure Errors and Messages Manual. .
File Codes File Code Description 264 Transfer alias file 265 Transfer trace file 266 Transfer queue file 267 Transfer inverted attachment file 268 Transfer external objects file 275 Transfer WORDLINK and Translator format name file 276 Transfer WORDLINK and Translator character map file 277 Transfer WORDLINK and Translator batch gateway configuration file 278 Transfer WORDLINK and Translator format type file 280 Transfer WORDLINK and Translator text server text file 281 Transfer Syst
File Codes File Code Description 505 5106 Tri-Density tape drive microcode object file 510 Standard (unformatted) microcode file 520 NonStop TXP processor microcode file 521 GASM-format microcode object file 525 NonStop VLX processor microcode file 540-549 Safeguard files 550-599 NonStop SQL files 600 MUMPS global file 601 MUMPS routine file 602 MUMPS global directory file 603-620 MUMPS files 660 Encore capture file 661-669 Encore files 700 Native object file 830-831 Comm tra
File Codes Guardian Programming Reference Summary for pTAL and TAL —522631-001 2 -4
3 Device Types and Subtypes Table 3-1. Device Types and Subtypes (page 1 of 14) Type Device Sub type 0 Process D-Series Description G-Series Description 0 Default subtype for general use Default subtype for general use 1-49 Reserved for definition by Tandem. The following subtypes are defined: Reserved for definition by Tandem.
Device Types and Subtypes Table 3-1. Device Types and Subtypes (page 2 of 14) Type Device 3 Disk Sub type D-Series Description G-Series Description 7 4109 (fixed-head part, 1.45 MB formatted capacity) N.A. 8 4110, 4111 (128 MB formatted capacity) N.A. 4120 (V8) (128 MB formatted capacity) N.A. 9 4114 or 4115 (264 MB formatted capacity) N.A. 10 4130 (XL8) (415 MB formatted capacity) N.A. 16 4160 (V80) (265 MB formatted capacity) with 3125 controller N.A.
Device Types and Subtypes Table 3-1. Device Types and Subtypes (page 3 of 14) Type Device 3 Disk Sub type D-Series Description G-Series Description 33 4245 (1038 MB formatted capacity) with 3681 MFC N.A. 34 4255 (2 GB formatted capacity) with 3681 MFC N.A.
Device Types and Subtypes Table 3-1. Device Types and Subtypes (page 4 of 14) Type 4 Device Magnetic tape unit Sub type D-Series Description G-Series Description 3 5101, 5103, 5104, 5110, 5114 (9-track, 45/125 ips) tape units with 3207 controllers N.A. 4 5130 (9-track, 200 ips) master tape unit or 5131 slave unit with 3208 controller N.A. 5 5120 cartridge tape unit with 3209 or 3681 controller in 3681 MFC N.A.
Device Types and Subtypes Table 3-1.
Device Types and Subtypes Table 3-1.
Device Types and Subtypes Table 3-1.
Device Types and Subtypes Table 3-1.
Device Types and Subtypes Table 3-1.
Device Types and Subtypes Table 3-1. Device Types and Subtypes (page 10 of 14) Type Device 30 Optical disk unit 31 36 Sub type D-Series Description G-Series Description 3 5420 optical disk subsystem with 3220 controller N.A. SNMP 0 NonStop SNMP Agent NonStop SNMP Agent TandemTalk 1 AppleTalk Transaction Protocol (ATP) N.A. 2 AppleTalk Data Stream Protocol (ADSP) N.A. 3 AppleTalk Session Protocol (ASP) N.A. 4 AppleTalk Printer Access Protocol (PAP) N.A.
Device Types and Subtypes Table 3-1. Device Types and Subtypes (page 11 of 14) Type Device 50 CSM 51 CP6100 Sub type D-Series Description G-Series Description 0 Communications Subsystem Manager with 3650, 6100, or 6110 controller N.A. 1 Single-board (SBSCSM) with 3605 or 3606 controller N.A. 2 N.A. SWAN Concentrator Manager(CONMGR) 3 N.A.
Device Types and Subtypes Table 3-1. Device Types and Subtypes (page 12 of 14) Type Device 55 Open Systems Interconnection (OSI) 56 Multilan Sub type D-Series Description G-Series Description 5 N.A. Tandem application, presentation, and session (TAPS) processes 11 N.A. OSI/Message Handling System (OSI/MHS) 12 N.A. OSI/Message Handling System (OSI/MHS) 20 N.A. OSI/FTAM Application Manager 21 N.A. OSI/FTAM Services 24 N.A. OSI/CMIP 25 N.A.
Device Types and Subtypes Table 3-1. Device Types and Subtypes (page 13 of 14) Type Device 59 AM6520 60 AM3270 TR3271 61 X.25 Sub type D-Series Description G-Series Description 0 Line attached to a byte-synchronous controller N.A. 10 Line attached to 3605, 6100 CSS, or 6105 or 6110 CC N.A.
Device Types and Subtypes Table 3-1. Device Types and Subtypes (page 14 of 14) Type Device 65 Storage Subsystem Manager 66 67 Sub type D-Series Description G-Series Description 0 N.A. responsible for the configuration and control of storage I/O processes NonStop Kernel Management 0 N.A. responsible for the configuration and control of system-wide attributes and generic processes SCSI Lock Management 0 N.A.
4 Procedure Calls Summary (A-C) This section lists procedure calls in alphabetic order and briefly describes the syntax of each. For additional information about the procedure calls, refer to the Guardian Procedure Calls Reference Manual. ABEND (Superseded by PROCESS_STOP_) Deletes a process or a process pair.
Procedure Calls Summary (A-C) process-id, INT:ref:4 input < (CCL) ACTIVATEPROCESS failed, or no process is designated process-id. = (CCE) The process is activated. ADDDSTTRANSITION (Superseded by DST_TRANSITION_ADD_) Allows a super-group user (255, n) to add an entry to the daylight-saving time (DST) transition table.
Procedure Calls Summary (A-C) error, INT returned value 0 No error; the requested values are returned. 2 Parameter error; the address parameter was missing. 3 Bounds error; error-detail contains the number of the first parameter found to be in error, where 1 designates the first parameter on the left. This error is returned only to nonprivileged callers. 4 address is not mapped. 5 address.<0> = 1, address is an invalid address. address.<0> <> 1, address is within relative segment 1, 2, or 3.
Procedure Calls Summary (A-C) -105 TNS user code segment. -104 TNS user library segment. -103 TNS user data segment. -102 Main RISC stack segment. -101 Debug stack segment. -100 Priv RISC stack segment. -99 System data segment. -98 System code segment. -97 System code segment. -96 System code segment. -95 System code segment. -94 System code segment. error-detail, INT .
Procedure Calls Summary (A-C) 24 The pin parameter was supplied and the caller is not privileged. 29 A required parameter was not supplied. 122 The supplied value of proc-name-size is less than the length of the procedure name that is to be returned into proc-name. p-reg, INT:value input stack-env, INT:value input <4> Library bit <7> System code bit <11:15> Space ID bits proc-name, STRING .EXT:ref output proc-name-size, INT:value input proc-name-length, INT .
Procedure Calls Summary (A-C) ALLOCATESEGMENT (Superseded by SEGMENT_ALLOCATE_) Allocates a selectable extended data segment for use by the calling process. It can also be used to share selectable extended data segments or flat extended data segments allocated by other processes. status := ALLOCATESEGMENT ( segment-id ,[ segment-size ] ,[ filename ] ,[ pin-and-flags ] ); status, INT returned value 0 No error. 1-999 File-system error related to the creation or open of the swap file.
Procedure Calls Summary (A-C) <2> Allocate a writeback-inhibit segment. <1> If 1, bits <8:15> are ignored. <1> If 0, allocate a segment sharable by the PIN method. ALTER (Superseded by FILE_ALTERLIST_) Changes disk file characteristics that cannot ordinarily be changed while the file is open. This procedure operates only on Guardian objects. CALL ALTER ( filename ,function ,newvalue ,[ partonly ] ); filename, INT:ref:12 input function, INT:value input 1 Change file code.
Procedure Calls Summary (A-C) ALTERPRIORITY (Superseded by PROCESS_SETINFO_) Is used to change the execution priority of a process or process pair. CALL ALTERPRIORITY ( process-id ,priority ); process-id, INT:ref:4 input priority, INT:value input < (CCL) ALTERPRIORITY failed, or no process was designated as process-id. = (CCE) The priority of the process is altered. ARMTRAP (Superseded by SIGACTION_INIT_) Specifies a location within the application program where execution begins if a trap occurs.
Procedure Calls Summary (A-C) filenum, INT:ref:1 (AWAITIO), INT .EXT:ref:1 (AWAITIOX) input, output input, output buffer-addr, INT:ref:1 (AWAITIO), INT(32) .EXT:ref:1 (AWAITIOX) output output count-transferred, INT:ref:1 (AWAITIO), INT .EXT:ref:1 (AWAITIOX) output output tag, INT(32):ref:1 (AWAITIO), INT(32) .EXT:ref:1 (AWAITIOX) output output timelimit, INT(32):value (AWAITIO, AWAITIOX) input > 0D A wait-for-completion is specified. = -1D An indefinite wait is indicated.
Procedure Calls Summary (A-C) BINSEM_CLOSE_ Closes access to a binary semaphore. error := BINSEM_CLOSE_ ( semid ); error, INT returned value 0 No error. 29 Required parameter missing. The semid parameter must be specified. 4022 Invalid parameter. The semid parameter does not identify a binary semaphore that is opened by the calling process. The corresponding OSS errno value is EINVAL. 4045 Deadlock.
Procedure Calls Summary (A-C) 4022 Invalid parameter. The security parameter is not a valid value. Specifying an invalid value for security could cause unpredictable results in future releases. The corresponding OSS errno value is EINVAL. 4024 Process cannot open the binary semaphore. The process has reached the maximum number of binary semaphores it can open, or the process file segment (PFS) has reached the maximum limit of available space. The corresponding OSS errno value is EMFILE. 4028 No space.
Procedure Calls Summary (A-C) BINSEM_LOCK_ Locks a binary semaphore. status := BINSEM_LOCK_ ( semid ,timeout ); status, INT returned value 0 No error. The binary semaphore becomes locked. 4011 Operation timed out. The time-out value was reached before the binary semaphore could be locked. The corresponding OSS errno value is EAGAIN. 4022 Invalid parameter. The semid parameter does not identify a binary semaphore that is opened by the calling process. The corresponding OSS errno value is EINVAL.
Procedure Calls Summary (A-C) 4013 Invalid access. The calling process does not have access to the binary semaphore because of its security. The security for a binary semaphore is set by the BINSEM_CREATE_ procedure. The corresponding OSS errno value is EACCESS. 4022 Invalid parameter. The processhandle parameter does not specify a process. A process that is being created or is terminating is treated as though it does not exist. The corresponding OSS errno value is EINVAL.
Procedure Calls Summary (A-C) error, INT returned value processhandle, INT .EXT:ref:10 input receiver-filenum, INT:value input breaktag, INT .EXT:ref:2 input CANCEL Cancels the oldest incomplete operation on a file opened for nowait I/O. CALL CANCEL ( filenum ); filenum, INT:value input < (CCL) An error occurred (call FILEINFO). = (CCE) The operation was canceled. CANCELPROCESSTIMEOUT Cancels a timer set by SIGNALPROCESSTIMEOUT.
Procedure Calls Summary (A-C) < (CCL) An error occurred (call FILEINFO). = (CCE) The operation was canceled. CANCELTIMEOUT Cancels a timer initiated by SIGNALTIMEOUT. CALL CANCELTIMEOUT ( tag ); tag, INT:value input = (CCE) CANCELTIMEOUT finished successfully. > (CCG) The value of tag was invalid. CHANGELIST Controls polling when the application program acts as a supervisor or tributary station in a centralized multipoint configuration.
Procedure Calls Summary (A-C) CHECK^BREAK Tests whether the BREAK key has been pressed since the last CHECK^BREAK. CHECK^BREAK is a sequential I/O (SIO) procedure and can be used only with files that have been opened by OPEN^FILE. state := CHECK^BREAK ( { common-fcb } { file-fcb } ); state, INT returned value 1 The BREAK key was pressed; the process owns BREAK. 0 The BREAK key was not pressed; this process does not own BREAK.
Procedure Calls Summary (A-C) segment-id, INT:value input filename, INT .EXT:ref:12 input pin-and-flags, INT:value input <8:15> Optional PIN for segment sharing. <5:7> Not used; must be zero (0). <4> Allocate an extensible segment. <3> Allocate a segment sharable by the file-name method. <2> Allocate a writeback-inhibit segment. <1> If 1, bits <8:15> are ignored. <1> If 0, allocate a segment sharable by the PIN method. error, INT .
Procedure Calls Summary (A-C) <13:15> 0 Rewind and unload, do not wait for completion (default). 1 Rewind, take offline, do not wait for completion. 2 Rewind, leave online, do not wait for completion. 3 Rewind, leave online, wait for completion. 4 Do not rewind, leave online. < (CCL) An invalid file number was supplied, or the backup process does not exist. = (CCE) The close was successful.
Procedure Calls Summary (A-C) < (CCL) The error parameter is missing, or a bounds error occurred on the error parameter. = (CCE) Is set by all other errors (see error parameter) CHECKDEFINE Updates a backup process with a DEFINE that was changed in the primary process. status := CHECKDEFINE [ ( define-name ) ]; status, INT returned value <0:7> 0 = Operation successful. 1 = Could not communicate with backup. <8:15> File-system error number. define-name, STRING .
Procedure Calls Summary (A-C) CHECKOPEN (Superseded by FILE_OPEN_CHKPT_) Is called by a primary process to open a designated file for the primary’s backup process.
Procedure Calls Summary (A-C) <9> <10:11> <12:15> 0 No 1 Yes Must be 0 Exclusion mode: 0 Shared 1 Exclusive 2 Process exclusive 3 Protected Type of I/O: 0 Wait I/O >0 Nowait I/O and the maximum number of concurrent nowait I/O operations that can be in progress at a given time sync-or-receive-depth, INT:value input sequential-block-buffer, INT:ref:* input buffer-length, INT:value input backerror, INT:ref:1 output Š0 File-system error number for FILE_OPEN_ in the backup process.
Procedure Calls Summary (A-C) status, INT returned value <0:7> =0 No error. <0:7> =1 No backup, or CHECKPOINT cannot communicate with backup, <8:15> = filesystem error number <0:7> =2 Takeover from the primary, <8:15> <0:7> =3 =0 =1 =2 =3 The primary process stopped. The primary process ended abnormally. The processor running the primary process failed. The primary process called CHECKSWITCH. Illegal parameter, <8:15> = The number of the parameter in error; the leftmost position equals 1.
Procedure Calls Summary (A-C) stack-base, INT:ref:* input descriptors, INT:ref:* input CHECKPOINTMANYX Is called by a primary process to send information about the primary process’s current executing state to the backup process when more than five pieces of information are sent. status := CHECKPOINTMANYX ( [ stack-base ] ,[ descriptors ] ); status, INT returned value <0:7> =0 No error. <0:7> =1 No backup, or CHECKPOINTMANYX cannot communicate with the backup, <8:15> = file-system error number.
Procedure Calls Summary (A-C) CHECKPOINTX Is called by a primary process to send information about the primary process’s current executing state to the backup process. status := CHECKPOINTX ( [ stack-base ] ,[ segment-id1 ], [ bufferx-1 ], [ count-1 ] ,[ segment-id2 ], [ bufferx-2 ], [ count-2 ] ,[ segment-id5 ], [ bufferx-5 ], [ count-5 ] ); status, INT returned value <0:7> =0 No error.
Procedure Calls Summary (A-C) CHECKRESIZESEGMENT Complements the RESIZESEGMENT procedure. CALL CHECKRESIZESEGMENT ( segment-id ,error ); segment-id, INT:value input error, INT .EXT:ref:1 output 2 Segment not allocated by the primary process or segment ID is invalid. 29 The segment-id is missing. 30 No control blocks available for linking. 31 Cannot use the process file segment (PFS), or the PFS has no room for a message buffer in either the backup process or the primary process.
Procedure Calls Summary (A-C) 117 Set TRANSID forwarding. 141 Enable/disable large transfers. 149 Set alternate key insertion locking. error, INT .EXT:ref:1 output 2 The value of function is not one of the allowed values. 29 The filenum or function parameter is missing. 30 No message control blocks are available. 31 Cannot use the process file segment (PFS), or the PFS has no room for a message buffer in either the backup process or the primary process.
Procedure Calls Summary (A-C) CHILD_LOST Examines a system message to determine whether a specified process or process pair has been lost. error := CHILD_LOST_ ( message:length ,processhandle ); error, INT 0 Process or process pair is not lost. 1 Reserved. 2 Parameter error. 3 Bounds error. 4 Process or process pair is lost. 5 System message is not relevant. returned value message:length, STRING .EXT:ref:*, INT:value -2 Local processor down. -5 Process deletion (stop).
Procedure Calls Summary (A-C) filenum, INT:value input tape-disposition, INT:value <13:15> input 0 Rewind and unload, do not wait for completion. 1 Rewind, take offline, do not wait for completion. 2 Rewind, leave online, do not wait for completion. 3 Rewind, leave online, wait for completion. 4 Do not rewind, but leave the file online. < (CCL) The file was not open, or for $RECEIVE or the TFILE, there is an outstanding operation using an active transaction.
Procedure Calls Summary (A-C) CLOSEALLEDIT Closes all open IOEdit files. CLOSEALLEDIT is an IOEdit procedure and can be used only with files that have been opened by OPENEDIT or OPENEDIT_. CALL CLOSEALLEDIT; CLOSEEDIT Closes a specified file that was opened by OPENEDIT or OPENEDIT_. CLOSEEDIT is an IOEdit procedure and can be used only with files that have been opened by OPENEDIT or OPENEDIT_.
Procedure Calls Summary (A-C) status, INT returned value filenum, INT .EXT:ref:1 input, output count-transferred, INT:value input tag, INT(32):value input COMPRESSEDIT Copies a specified EDIT file to a new EDIT file that it creates. COMPRESSEDIT is an IOEdit procedure and can be used only with files that have been opened by OPENEDIT or OPENEDIT_. error := COMPRESSEDIT ( filenum ,[ start ] ,[ increment ] ); error, INT returned value filenum, INT .
Procedure Calls Summary (A-C) COMPUTETIMESTAMP Converts a Gregorian (common civil calendar) date and time into a 64-bit Julian timestamp. ret-timestamp := COMPUTETIMESTAMP ( date-n-time ,[ errormask ] ); ret-timestamp, FIXED returned value date-n-time, INT:ref:8 input [0] The Gregorian year (yyyy, for example, 1986). [1] The Gregorian month (1-12). [2] The Gregorian day of the month (1-31). [3] The hour of the day (0-23). [4] The minute of the hour (0-59).
Procedure Calls Summary (A-C) CONFIG_GETINFO_BYLDEV CONFIG_GETINFO_BYNAME Obtain the logical and physical attributes of a device on a G-series release. Use the CONFIG_GETINFO_BYLDEV procedure to specify the device by logical device number. Use the CONFIG_GETINFO_BYNAME procedure to specify the device by name. Note. These procedures are supported only on G-series releases.
Procedure Calls Summary (A-C) ldevnum (CONFIG_GETINTO_BYLDEV only) input devname:length, STRING .EXT:ref:* (CONFIG_GETINTO_BYDEVNAME only) input:input common-info output common-info-maxlen, INT:value input common-info-len, INT .EXT:ref:1 output specific-info, INT .EXT:ref:* output specific-info-maxlen, INT:value input specific-info-len, INT .
Procedure Calls Summary (A-C) error := CONFIG_GETINFO_BYNAME2_ ( devname:length ,common-info ,common-maxlen ,common-len ,specific-info ,specific-maxlen ,specific-len ,timeout ,error-detail ); error, INT(32) returned value 0D Device found and data is returned. The value of error-detail is set to zero. 1D Device or subtype 30 process returned an error. The error is reported in error-detail. 2D Required parameter is invalid.
Procedure Calls Summary (A-C) CONTIME Converts a 48-bit timestamp to a date and time in integer form. CALL CONTIME ( date-and-time ,t0 ,t1 ,t2 ); date-and-time, INT:ref:7 [0] Year (1975, 1976, ... ). [1] Month (1-12). [2] Day (1-31). [3] Hour (0-23). [4] Minute (0-59). [5] Second (0-59). [6] 0.01 sec (0-99). t0, t1, t2, INT:ref:3 output input CONTROL Performs device-dependent I/O operations.
Procedure Calls Summary (A-C) CONTROLBUF Performs device-dependent I/O operations requiring a data buffer. CALL CONTROLBUF ( filenum ,operation ,buffer ,count ,[ count-transferred ] ,[ tag ] ); filenum, INT:value input operation, INT:value input buffer, INT:ref:* input count, INT:value input count-transferred, INT:ref:1 output tag, INT(32):value input > (CCL) An error occurred (call FILEINFO). = (CCE) CONTROLBUF was successful.
Procedure Calls Summary (A-C) 0 Sets the limit on the number of outstanding messages to the process, including timelimit expiration messages. 1 Sets the limit on the number of outstanding messages sent by the process (the maximum number of send XLBs for this process). CONVERTASCIIEBCDIC Translates the 256 EBCDIC encodings to and from the 256 8-bit ASCII encodings. For more information, refer to the Guardian Procedure Calls Reference Manual.
Procedure Calls Summary (A-C) process-time, FIXED:value input hours, INT:ref:1 output minutes, INT:ref:1 output seconds, INT:ref:1 output milliseconds, INT:ref:1 output microseconds, INT:ref:1 output < (CCL) The process-time parameter represents a quantity greater than 3.7 years. = (CCE) CONVERTPROCESSTIME is successful. > (CCG) One or more of the supplied output parameters failed the bounds check on the address.
Procedure Calls Summary (A-C) -2 Impossible LCT. -1 Ambiguous LCT. 0 No errors, successful. 1 DST range error. 2 DST table not loaded. >2 File-system error (attempting to reach “NODE”). CPU_GETINFOLIST Use the PROCESSOR_GETINFOLIST_ procedure instead of CPU_GETINFOLIST. Calls to PROCESSOR_GETINFOLIST are identical in their format and values to those for CPU_GETINFOLIST.
Procedure Calls Summary (A-C) CREATE (Superseded by FILE_CREATE_ and FILE_CREATELIST_) Defines a new structured or unstructured disk file. This procedure operates only on Guardian objects.
Procedure Calls Summary (A-C) recordlen, INT:value input data-blocklen, INT:value input key-sequenced-params, INT:ref:3 input alternate-key-params, INT:ref:* input partition-params, INT:ref:* input maximum-extents, INT:value input unstructured-buffer-size, INT:value input open-defaults, INT:value input <0> =0 =1 Verify writes off (default). Verify write on. <1> =0 =1 The system automatically selects serial or parallel writes. Serial mirror writes only.
Procedure Calls Summary (A-C) CREATEREMOTENAME (Superseded by PROCESSNAME_CREATE_) Supplies a process name that is unique for the specified system in a network. (This process name goes into the name parameter of NEWPROCESS.) CALL CREATEREMOTENAME ( name ,sysnum ); name, INT:ref:3 output sysnum, INT:value input < (CCL) The remote the DCT could not be accessed. = (CCE) CREATEREMOTENAME was successful.
Procedure Calls Summary (A-C) error, INT returned value process-id, INT .EXT:ref:4 input processhandle, INT .EXT:ref:10 output pair-flag, INT .EXT:ref:1 output node-number, INT(32):value input CURRENTSPACE Returns the ENV register (as saved in the stack marker) and a string (in ASCII) containing the space ID of the caller.
Procedure Calls Summary (A-C) Guardian Programming Reference Summary for pTAL and TAL —522631-001 4- 44
5 Procedure Calls Summary (D-F) This section lists procedure calls in alphabetic order and briefly describes the syntax of each. For additional information about the procedure calls, refer to the Guardian Procedure Calls Reference Manual. DAYOFWEEK Takes a 32-bit Julian day number and returns the corresponding day of the week. day := DAYOFWEEK ( julian-day-num ); day, INT returned value julian-day-num, INT(32):value input 0 Sunday, 1 = Monday, ..., 6 = Saturday. -1 The julian-day-num is negative.
Procedure Calls Summary (D-F) DEBUG directly invokes the debug facility. CALL DEBUG; DEBUGPROCESS (Superseded by PROCESS_DEBUG_) Invokes the debug facility on a process. CALL DEBUGPROCESS ( process-id ,error ,[ term ] ,[ now ] ); process-id, INT:ref:4 input error, INT:ref:1 output 0 No error. 11 Specified process does not exist. 13 Invalid name. 14 Supplied process ID references an LDEV that does not exist. 18 Specified system is not known.
Procedure Calls Summary (D-F) DEFINEADD Adds a DEFINE to the calling process’s context using the attributes in the working set. DEFINEADD can replace an existing DEFINE with the attributes in the working set. error := DEFINEADD ( define-name ,[ replace ] ,[ checknum ] ); error, INT returned value 0 Add was successful. 2049 A syntax error occurred in name. 2050 Define already exists. 2051 Define does not exist. 2052 Unable to obtain file-system buffer space.
Procedure Calls Summary (D-F) 006 If you specify DEVICE, you cannot specify SYSTEM in the same DEFINE, and vice versa. 007 If you specify LABELS BYPASS or LABELS OMITTED, then DEVICE is required and the following attributes may not be specified: VOLUME, OWNER, FILESECT, FILESEQ, FILEID, RETENTION, EXPIRATION, GEN, VERSION, RECFORM, BLOCKLEN, RECLEN, REELS, USE, EBCDIC, SYSTEM. 008 If you specify VOLUME SCRATCH, then USE IN or USE EXTEND is not allowed.
Procedure Calls Summary (D-F) DEFINEINFO Returns selected information about a DEFINE. error := DEFINEINFO ( define-name ,class ,attribute-name ,value-buf ,value-buf-len ,value-len ); error, INT returned value 0 Add was successful. 2049 A syntax error occurred in name. 2051 Define does not exist. 2052 Unable to obtain file-system buffer space. 2054 Bounds error in define-name. 2066 Missing parameter. define-name, STRING .EXT:ref:24 input class, STRING .
Procedure Calls Summary (D-F) filenum, INT:value input address-list, INT:ref:* input address-size, INT:value input num-entries, INT:value input polling-count, INT:value input polling-type, INT:value input < (CCL) An error occurred (call FILEINFO). = (CCE The DEFINELIST procedure was executed successfully. DEFINEMODE Controls the use of DEFINEs. error := DEFINEMODE ( new-value ,[ old-value ] ); error, INT returned value 0 Success. 2067 The value supplied in new-value is invalid.
Procedure Calls Summary (D-F) 2052 Unable to obtain file-system buffer space. 2054 Parameter address is bad. 2066 Missing parameter. 2060 No more DEFINEs. define-name, STRING .EXT:ref:24 input, output DEFINEPOOL (Superseded by POOL_CHECK_, POOL_DEFINE_, POOL_GETINFO_, POOL_GETSPACE_, POOL_PUTSPACE_, and POOL_RESIZE_) Designates a portion of a user’s stack or an extended data segment for use as a pool. status := DEFINEPOOL ( pool-head ,pool ,pool-size ); status, INT returned value 0 No error.
Procedure Calls Summary (D-F) DEFINEREADATTR Obtains the current value of an attribute in a DEFINE in the calling process’s context or in the working set. error := DEFINEREADATTR ( [ define-name ] ,attribute-name ,[ cursor ] ,value-buf ,value-buf-len ,value-len ,[ read-mode ] ,[ info-word ] ); error, INT returned value 0 Successful. 2049 A syntax error occurred in name. 2051 DEFINE not found. 2052 An error occurred when placing PFS in use. 2054 Bounds error on parameter.
Procedure Calls Summary (D-F) info-word, INT:ref:1 output <14:15> Indicates the type of the attribute: 0 = Optional 1 = Defaulted 2 = Required DEFINERESTORE Uses a saved version of a DEFINE in the user’s buffer to create an active DEFINE. If an active DEFINE of the same name already exists, it can optionally be replaced. The saved DEFINE can also be placed in the working set without its name.
Procedure Calls Summary (D-F) buffer, INT .EXT:ref:* input options, INT:value input define-name, STRING .EXT:ref:24 output checknum, INT:ref:1 output DEFINERESTOREWORK[2] DEFINERESTOREWORK restores the DEFINE working set from the background set. DEFINERESTOREWORK2 allows a second background DEFINE working set to be restored. error := DEFINERESTOREWORK; error := DEFINERESTOREWORK2; error, INT returned value 0 Success. 2052 Unable to obtain file-system buffer space.
Procedure Calls Summary (D-F) 2053 Not enough physical memory. 2054 Bounds error on buffer, deflen or define-name parameters. 2057 DEFINE or working set is incomplete. 2058 DEFINE or working set is inconsistent. 2059 DEFINE or working set is invalid. 2066 Parameter missing. 2075 The value of option.<0:14> is not 0. 2076 User’s buffer is too small. 2077 The buffer or define-name parameter is in invalid segment.
Procedure Calls Summary (D-F) DEFINESETATTR Modifies the value of an attribute in the DEFINE working set. error := DEFINESETATTR ( attribute-name ,[ value ] ,[ value-len ] ,[ default-names ] ); error, INT returned value 0 Successful. 2049 Syntax error in name. 2052 Unable to obtain file-system buffer space. 2055 Attribute not supported. 2062 Attribute name too long. 2063 A syntax error occurred in default names. 2064 The required attribute cannot be reset 2066 Parameter missing.
Procedure Calls Summary (D-F) 0 Successful. 2049 Syntax error in name. 2051 DEFINE not found. 2052 Unable to obtain file-system buffer space. 2053 Unable to obtain physical memory. 2054 Bounds error occurred on define-name. 2066 Parameter missing. define-name, STRING .EXT:ref:24 input DEFINEVALIDATEWORK Checks the working set for consistency. error := DEFINEVALIDATEWORK ( checknum ); error, INT returned value 0 Successful. 2057 Working set is incomplete.
Procedure Calls Summary (D-F) DELETEEDIT Deletes from an EDIT file all lines that have line numbers in a specified range. DELETEEDIT is an IOEdit procedure and can be used only with files that have been opened by OPENEDIT or OPENEDIT_. error := DELETEEDIT ( filenum ,first ,last ); error, INT returned value filenum, INT:value input first, INT(32):value input last, INT(32):value input DEVICE_GETINFOBYLDEV_ Obtains the logical and physical attributes of a device.
Procedure Calls Summary (D-F) 0 Information successfully returned. 1 Reserved. 2 Parameter error; error-detail contains the number of the first parameter found to be in error, where 1 designates the first parameter on the left. 3 Bounds error; error-detail contains the number of the first parameter found to be in error, where 1 designates the first parameter on the left. 4 Device not found; error-detail contains a file-system error number. 5 Buffer too small.
Procedure Calls Summary (D-F) DEVICE_GETINFOBYNAME_ Obtains the logical and physical attributes of a device. error := DEVICE_GETINFOBYNAME_ ( devname:length ,[ logical-info ] ,[ logical-info-maxlen ] ,[ logical-info-len ] ,[ primary-info ] ,[ primary-info-maxlen ] ,[ primary-info-len ] ,[ backup-info ] ,[ backup-info-maxlen ] ,[ backup-info-len ] ,[ timeout ] ,[ error-detail ] ); error, INT returned value 1 Reserved.
Procedure Calls Summary (D-F) DEVICEINFO (Superseded by FILE_GETINFOBYNAME_ or FILE_GETINFOLISTBYNAME_) Obtains the device type and physical record length of a file. The file can be opened or closed. CALL DEVICEINFO ( filename ,devtype ,physical-recordlen ); filename, INT:ref:12 input devtype, INT:ref:1 output <0> Demountable. <1> Audited disk, or the file name specified was a subdevice. <2:3> Undefined. <4:9> Device type. <10:15> Device subtype.
Procedure Calls Summary (D-F) <0> Demountable. <1> Audited disk, or the file name specified was a subdevice. <2:3> Undefined. <4:9> Device type. <10:15> Device subtype. physical-recordlen, INT:ref:1 output diskprocess-version, INT:ref:1 output 0 DP1 disk process. 1 DP2 disk process. error, INT:ref:1 output options, INT:value input <0:12> Should be 0. <13> If 1, this call is initiating a nowait inquiry only, and information will be returned in a system message.
Procedure Calls Summary (D-F) DISKINFO (Superseded by FILE_GETINFOLISTBYNAME_) Obtains information about disk volumes. error := DISKINFO ( name , [ capacity ] , [ avail ] , [ numfrag ] , [ biggest ] , [ drivekinds ] , [ drivecaps] ); error, INT returned value name, INT .EXT:ref:12 input capacity, INT(32) .EXT:ref:1 output avail, INT(32) .EXT:ref:1 output numfrag, INT(32) .EXT:ref:1 output biggest, INT(32) .EXT:ref:1 output drivekinds, STRING .
Procedure Calls Summary (D-F) next-addr, INT(32) returned value ascii-num, STRING .EXT:ref:* input signed-result, INT(32) .EXT:ref:1 output base, INT:value input status, INT .EXT:ref:1 output 1 A nonexistent number (the string does not start with a valid sign, prefix, or numeric). 0 Valid conversion. -1 Illegal integer (the number cannot be represented in 32 bits as a signed quantity). flags, INT:value input <0:12> Must be 0. <13> Disallow preceding sign (+/-).
Procedure Calls Summary (D-F) <0:14> Must be 0. <15> Blank-fill on left (the default is zero-fill). DST_GETINFO_ Provides information about the DST entry that is in effect at time keygmt. error:= DST_GETINFO_ ( keygmt , dstentry ); error keygmt, FIXED:value input dstentry, INT:EXT:ref:* output DST_TRANSITION_ADD_ Allows a super-group user (255,n) to add an entry to the daylight-saving-time (DST) transition table.
Procedure Calls Summary (D-F) Error Summary for DST_* Procedures: Error Literal Value Description 0 ZSYS^VAL^DST^OK The operation is successful. 1 ZSYS^VAL^DST^SECURITY^ERROR The caller is not a super-group user (255,n). 2 ZSYS^VAL^DST^BAD^VERSION The version number passed in ZSYS^DDL^DST^ENTRY^DEF is not valid. The only valid version is ZSYS^VAL^DST^VERSION^SE P1997. 3 ZSYS^VAL^DST^BAD^PARAMETER One of the specified parameters is not valid.
Procedure Calls Summary (D-F) Error Literal Value Description 9 ZSYS^VAL^DST^RANGE^LOW The specified keygmt value was less than the lowgmt value of the first DST interval with nonzero offset. This error is returned by the DST_GETINFO_ procedure. 10 ZSYS^VAL^DST^RANGE^HIGH The specified keygmt value is greater than the highgmt of the last DST interval with nonzero offset. This error is returned by the DST_GETINFO_ procedure.
Procedure Calls Summary (D-F) >= 0 Indicates that the reading of the file was successful. -1 End of file encountered. -2 Error occurred while reading. -3 Text file format error. -4 Sequence error. -5 Checksum error. -6 Invalid buffer address. edit-controlblk, INT:ref:* input buffer, STRING:ref:* output bufferlen, INT:value input sequence-num, INT(32):ref:1 output EDITREADINIT Prepares a buffer in the application program’s data area for subsequent calls to EDITREAD.
Procedure Calls Summary (D-F) ERRNO_GET_ Obtains the value of the errno variable set by many OSS, native C/C++, and some Guardian routines. ?SOURCE $SYSTEM.SYSTEM.HERRNO error := ERRNO_GET_; error, INT(32) returned value EXTENDEDIT Copies an EDIT file to a new file that it creates and that has a larger extent size than the original file. EXTENDEDIT is an IOEdit procedure and can only be used with files that have been opened by OPENEDIT or OPENEDIT_.
Procedure Calls Summary (D-F) error, INT returned value filename:length, STRING .EXT:ref:*,INT:value input:input item-list, INT .EXT:ref:* input number-of-items, INT:value input values, INT .EXT.ref:* input values-length, INT:value input partonly, INT:value input error-item, INT .EXT:ref:1 output FILE_CLOSE_ Closes an open file opened by either FILE_OPEN_ or OPEN.
Procedure Calls Summary (D-F) 0 Rewind and unload; do not wait for completion. 1 Rewind and take offline; do not wait for completion. 2 Rewind and leave online; do not wait for completion. 3 Rewind and leave online; wait for completion. 4 Do not rewind; leave online. FILE_COMPLETE_ Completes one previously initiated I/O operation for a Guardian file or returns ready information for one Open System Services (OSS) file.
Procedure Calls Summary (D-F) FILE_COMPLETE_GETINFO_ Provides information about the set of files that are currently enabled for completion and thus can be completed by the FILE_COMPLETE_ procedure. These files were enabled for completion by one or more previous calls to the FILE_COMPLETE_SET_ procedure. status := FILE_COMPLETE_GETINFO_ ( info-list ,maxnum-info-elements ,[ num-info-elements ] ); status, INT returned value info-list, INT .
Procedure Calls Summary (D-F) FILE_CREATE_ Defines a new structured or unstructured disk file. This procedure operates only on Guardian objects. error := FILE_CREATE_ ( filename:maxlen ,filenamelen ,[ file-code ] ,[ primary-extent-size ] ,[ secondary-extent-size ] ,[ maximum-extents ] ,[ file-type ] ,[ options ] ,[ recordlen ] ,[ blocklen ] ,[ keylen ] ,[ key-offset ] ); error, INT returned value filename:maxlen, STRING .EXT:ref:*,INT:value input, output:input filenamelen, INT .
Procedure Calls Summary (D-F) <0:9> Reserved (must be 0). <13> Audit compression. For audited files, the audit data is to be compressed. <14> Audited. The file is to be audited under TMF. Must be 0 for systems without TMF. <15> Odd unstructured. For unstructured files, I/O transfers are to occur with the exact counts specified. If this option is not selected, transfers are rounded up to an even byte boundary. Must be 0 for other file types.
Procedure Calls Summary (D-F) FILE_GETINFO_ Obtains a limited set of information about a file identified by file number. error := FILE_GETINFO_ ( filenum ,[ last-error ] ,[ filename:maxlen ] ,[ filename-length ] ,[ type-info ] ,[ flags ] ); error, INT returned value filenum, INT:value input last-error, INT .EXT:ref:1 output filename:maxlen, STRING .EXT:ref:*,INT:value output:input filename-length, INT .EXT:ref:1 output type-info, INT .EXT:ref:5 output [0] = Device type.
Procedure Calls Summary (D-F) <0:14> Reserved and undefined. <15> File is an OSS file. FILE_GETINFOBYNAME_ Obtains a limited set of information about a file identified by file name. error := FILE_GETINFOBYNAME_ ( filename:length ,[ type-info ] ,[ physical-recordlen ] ,[ options ] ,[ tag-or-timeout ] ,[ flags ] ); error, INT returned value filename:length, STRING .EXT:ref:*,INT:value input:input type-info, INT .EXT:ref:5 output [0] = Device type. [1] = Device subtype. Object type.
Procedure Calls Summary (D-F) <0:12> Reserved (specify 0). <13> Specifies that this call is only initiating a nowait inquiry and the information will be returned in a system message. Do not set both options.<13> and options.<14>. <14> Specifies that the sending of a device type inquiry message to a subtype 30 process should not be allowed to take longer than indicated by timeout. If the time is exceeded, error 40 is returned.
Procedure Calls Summary (D-F) Code Size (bytes) Description 1 2 File name length 2 * File name 3 2 Current-file-name length 4 * Current file name 5 2 DEFINE name length 6 * DEFINE name 7 2 Last error 8 2 Last-error detail 9 2 Partition in error 10 2 Key in error 11 4 Next record pointer 12 4 Current record pointer 13 2 Current key specifier 14 2 Current key length 15 * Current key value 16 2 Current primary-key length 17 * Current primary-key value 18
Procedure Calls Summary (D-F) Code Size (bytes) Description 40 2 SQL type 41 2 File type 42 2 File code 43 2 Logical record length 44 2 Block length 45 2 Key offset 46 2 Key length 47 2 Lock key length 50 2 Primary extent size 51 2 Secondary extent size 52 2 Maximum extents 53 2 Allocated extents 54 8 Creation time 56 8 Last open time 57 8 Expiration time 58 2 File owner 59 2 Safeguard security 60 2 Progid security 61 2 Clear on purge 62 4 Opera
Procedure Calls Summary (D-F) Code Size (bytes) Description 78 2 Broken 79 2 Corrupt 80 2 Secondary partition 81 2 Index levels 82 2 SQL program 83 2 SQL valid 84 2 SQL-catalog name length 85 * SQL-catalog name 90 2 Number of partitions 91 * Partition descriptors 92 * Partition-volume name-length array 93 * Partition-volume names 94 2 Partition partial-key length 95 * Partition partial-key values 96 2 Partition-volume names total length 100 2 Number of alte
Procedure Calls Summary (D-F) Code Size (bytes) Description 141 8 Partition modification LCT 142 4 Aggregate EOF 143 4 Aggregate maximum file size 144 8 Aggregate modification time 145 8 Aggregate modification LCT 153 2 Logical (packed) record length 160 6 Three-word partition modification LCT 161 2 OSS file 164 4 OSS group ID 165 4 OSS access permissions 166 2 OSS open 167 4 OSS user ID 168 2 OSS number of links 169 2 Security mechanisms in effect FILE_GETINFOL
Procedure Calls Summary (D-F) FILE_GETLOCKINFO_ Obtains information about locks (held or pending) on a local disk file or on a set of files on a local disk volume. This procedure operates only on Guardian objects.
Procedure Calls Summary (D-F) [3:4] Record ID if the lock is a record lock on a file that is not key-sequenced; undefined otherwise. [5] The length in bytes of the key if the lock is a record lock on a keysequenced file; 0 otherwise. [6:n] The key value if the lock is a record lock on a key-sequenced file. lock-descr-length INT:value input participants INT .EXT:ref:* output [0] Flags. The bits have the following meanings: <0> =1 =0 The participant is identified by process handle.
Procedure Calls Summary (D-F) error, INT returned value searchname:length, STRING .EXT:ref:*,INT:value input:input prevtag, FIXED .EXT:ref:1 input, output primary-opener, INT .EXT:ref:10 output backup-opener, INT .EXT:ref:10 output accessmode, INT .EXT:ref:1 output 0 Read-write. 1 Read only. 2 Write only. exclusion, INT .EXT:ref:1 output 0 Shared. 1 Exclusive. 2 Process exclusive (supported only for Optical Storage Facility). 3 Protected. syncdepth, INT .
Procedure Calls Summary (D-F) FILE_GETRECEIVEINFO_ Returns information about the last message read on the $RECEIVE file. error := FILE_GETRECEIVEINFO_ ( receive-info ); error, INT returned value receive-info, INT .EXT:ref:17 output [0] I/O type. Indicates the data operation last performed by the message sender. 0 = Not a data message (system message). 1 = Sender called WRITE. 2 = Sender called READ. 3 = Sender called WRITEREAD. [1] Maximum reply count.
Procedure Calls Summary (D-F) error, INT:value returned value filename, INT:value input infobuf, INT:EXT.ref:* output infomax, INT:value input infosize, INT:EXT.ref:1 output FILE_OPEN_ Establishes a communication path between an application process and a file, and returns a file number to the caller.
Procedure Calls Summary (D-F) nowait-depth, INT:value input sync-or-receive-depth, INT:value input options, INT:value input <0> Unstructured access. For disk files, access is to occur as if the file were unstructured, that is, without regard to record structures and partitioning. (For unstructured files, setting this bit to 1 causes secondary partitions to be inaccessible.) Must be 0 for other devices. <1> Nowait open processing.
Procedure Calls Summary (D-F) FILE_OPEN_CHKPT_ Is called by a primary process to open a designated file for its backup process. error := FILE_OPEN_CHKPT_ ( filenum ,[ status ] ); error, INT returned value filenum, INT:value input status, INT .EXT:ref output 0 Backup open succeeded (error is 0). 1 File was opened in backup with warning. 2 Open failed in backup. 3 Unable to communicate with backup. 4 Error occurred in primary. FILE_PURGE_ Deletes a disk file that is not open.
Procedure Calls Summary (D-F) FILE_RESTOREPOSITION_ The FILE_RESTOREPOSITION_ procedure supersedes the REPOSITION procedure and is used to position a disk file to a saved position (the positioning information having been saved by a call to the FILE_SAVEPOSITION_ procedure). error := FILE_RESTOREPOSITION_ ( filenum ,savearea ,savesize ); error, INT:value returned value filenum, INT:value input savearea, INT:EXT.
Procedure Calls Summary (D-F) FILE_SETKEY_ The FILE_SETKEY_ procedure supersedes the KEYPOSITION[X] procedures. The FILE_SETKEY_ procedure is used to position by primary or alternate key within a structured file, and sets the current position, access path, and positioning mode for the specified file. FILE_SETKEY_ can be used with format 2 files.
Procedure Calls Summary (D-F) FILE_SETSYNCINFO_ The FILE_SETSYNCINFO_ procedure supersedes the SETSYNCINFO procedure and is used by the backup process of a process pair after a failure of the primary process. The FILE_SETSYNCINFO_ procedure passes a process pair’s latest synchronization block (received in a checkpoint message from the primary process) to the file system. Unlike the SETSYNCINFO procedure, the FILE_SETSYNCINFO_ procedure can be used with format 2 files.
Procedure Calls Summary (D-F) FILEINFO (Superseded by FILE_GETINFO_, FILE_GETINFOBYNAME_, FILE_GETINFOLIST_, and FILE_GETINFOLISTBYNAME_) Obtains error and characteristic information about a file.
Procedure Calls Summary (D-F) secondary-extent-size INT:ref:1 output current-record-pointer INT(32):ref:1 output open-flags, INT:ref:1 output <1> For the $RECEIVE file only, the process will receive open, close, CONTROL, SETMODE, RESETSYNC, and CONTROLBUF system messages. <2> Unstructured access, regardless of the actual file structure. <3:5> Is the access mode: 0 = Read/write access. 1 = Read-only access. 2 = Write-only access.
Procedure Calls Summary (D-F) num-extents-allocated INT:ref:1 output max-file-size INT(32):ref:1 output partition-size INT:ref:1 output num-partitions INT:ref:1 output file-type INT:ref:1 output <2> =1 <5:7> This file is audited by TMF. SQL object type: 0 = Not SQL. 2 = SQL table. 5 = SQL protection view. 7 = SQL shorthand view. <10> =1 <11> =1 REFRESH is specified for this file. For key-sequenced files, index compression is specified.
Procedure Calls Summary (D-F) <7> 0 = File closed. 1 = File opened. <8> 0 = Not licensed for privileged procedures. 1 = licensed. <9> 0 = Not a secondary partition. 1 = A secondary partition. <10> 0 = File contents valid. 1 = File contents probably invalid. <11:15> Unused. sync-depth, INT:ref:1 output next-open-fnum, INT:ref:1 output < (CCL) An error occurred; the error number returned in error. =(CCE) FILEINFO executed successfully.
Procedure Calls Summary (D-F) < (CCL) An error occurred (see error-code). = (CCE) FILEINQURE was successful. > (CCG) One or more of the items requested are invalid for the file’s device type, file type, open status, or other characteristic. FILENAME_COMPARE_ Compares two file names to determine if they refer to the same object. error := FILENAME_COMPARE_ ( filename1:length ,filename2:length ); error, INT returned value -1 The file names do not refer to the same object.
Procedure Calls Summary (D-F) -1 Node name. 0 Destination name (for example, volume, device or process). 1 First qualifier (for example, subvolume). 2 Second qualifier (file identifier if disk file) options, INT:value <0:12>= <13> Reserved (specify 0). =1 =0 <14> =1 =0 <15> input =1 =0 Do not return default values; that is, if a requested part is not present in filename but a default exists for it, return a null string instead of the default value. Default values can be returned.
Procedure Calls Summary (D-F) error, INT returned value filename:maxlen, STRING .EXT:ref:*,INT:value input, output:input filename-length, INT .EXT:ref:1 input, output piece:length, STRING .EXT:ref:*,INT:value input:input level, INT:value input -1 Node name. 0 Destination name (for example, volume, device, or process). 1 First qualifier (for example, subvolume). 2 Second qualifier (file identifier if disk file). options, INT:value <0:13> <14> Reserved (specify 0).
Procedure Calls Summary (D-F) FILENAME_FINDFINISH_ Releases the resources reserved for a search that was previously initiated by a call to FILENAME_FINDSTART_. error := FILENAME_FINDFINISH_ ( searchid ); error, INT returned value searchid, INT:value input FILENAME_FINDNEXT_ Returns the next name in a set of named entities that was defined by a call to FILENAME_FINDSTART_.
Procedure Calls Summary (D-F) 0 1 2 3 -1 [4] = Unstructured disk file. Relative disk file. Entry-sequenced disk file. Key-sequenced disk file. Not a disk file. File code. >= 0 -1 Disk file. Not a disk file. tag, INT(32):value input FILENAME_FINDSTART_ Sets up a search of named entities. error := FILENAME_FINDSTART_ ( searchid ,[ search-pattern:length ] ,[ resolve-level ] ,[ device-type ] ,[ device-subtype ] ,[ options ] ,[ startname:length ] ); error, INT returned value searchid, INT .
Procedure Calls Summary (D-F) <0:8> Reserved (specify 0). <9> The search is to be executed in a nowait manner. The results of the search are returned in system messages sent to $RECEIVE. <10> Device simulation by subtype 30 devices is not to be supported. <11> The search is not to include subprocesses. <12> If an entity is encountered that is offline (that is, the system is not connected or the device is down), an error is to be reported.
Procedure Calls Summary (D-F) filename:length, STRING .EXT:ref:*,INT:value input:input pattern:length, STRING .EXT:ref:*,INT:value input:input generic-set, INT .EXT:ref:1 output -1 The name falls before the first possible match. 0 The name falls within the set of possible matches. 1 The name falls after the last possible match. FILENAME_RESOLVE_ Converts a partially qualified file name to a fully qualified file name.
Procedure Calls Summary (D-F) <12> If a DEFINE name is supplied for partialname, and if the DEFINE contains only a file name (that is, it is a simple MAP DEFINE), then FILENAME_RESOLVE_ returns that file name as the result. If neither this option nor options.<11> is specified, then the DEFINE name is returned as the result. <13> If a logical device number (LDEV) appears as part of partialname, FILENAME_RESOLVE_ translates it to the corresponding symbolic device name.
Procedure Calls Summary (D-F) -1 Node name. 0 Name of device or process without qualifiers. >0 Name of device or process with entity-level qualifiers. options, INT:value input <0:13> Reserved (specify 0). <14> Specifies that a subvolume name be accepted as valid input. <15> Specifies that a file name pattern be accepted as valid input. FILENAME_TO_OLDFILENAME_ Converts a file name to a C-series internal file name.
Procedure Calls Summary (D-F) 4006 The fileset that corresponds to the supplied Guardian name for an OSS file is not mounted. The corresponding OSS errno value is ENXIO. 4013 The caller does not have search access to one of the directories within all of the resulting pathnames. The corresponding OSS errno value is EACCESS. 4014 A parameter has an invalid address. The corresponding OSS errno value is DEFAULT. 4022 Either options is specified and options.
Procedure Calls Summary (D-F) error, INT returned value longname:length, STRING .EXT:ref:*,INT:value input:input shortname:maxlen, STRING .EXT:ref:*,INT:value output:input shortname-length, INT .EXT:ref:1 output level, INT:value input. -1 Node name. 0 Destination name (for example, volume, device, or process). 1 First qualifier (for example, subvolume). 2 Second qualifier (file identifier if disk file). defaults:length, STRING .
Procedure Calls Summary (D-F) partition-in-error, INT:ref:1 output specifier-of-key-in-error, INT:ref:1 output file-type, INT:ref:1 output <2> = 1 This file is audited by the TMF subsystem. SQL object type: <5:7> 0= 2= 4= 5= 7= Not SQL. SQL table. SQL index. SQL protection view. SQL shorthand view. <10> =1 REFRESH is specified for this file. <11> =1 <12> =1 =1 For key-sequenced files, index compression is specified. For key-sequenced files, data compression is specified.
Procedure Calls Summary (D-F) FIXSTRING Edits a string based on subcommands provided in a template. CALL FIXSTRING ( template ,template-len ,data ,data-len ,[ maximum-data-len ] ,[ modification-status ] ); template, STRING:ref:* input template-len, INT:value input data, STRING:ref:* input, output data-len, INT:ref:1 input, output maximum-data-len, INT:value input modification-status, INT:ref:1 output 0 No change was made to data.
Procedure Calls Summary (D-F) FNAME32EXPAND (Superseded by FILENAME_SCAN_ and FILENAME_RESOLVE_) Expands a partial file name from the compacted external form to the 32-character file name used by the Distributed Name Service programmatic interface. length := FNAME32EXPAND ( extname ,intname ,defaults ); length, INT returned value extname, STRING .EXT:ref:35 input intname, STRING .EXT:ref:32 output defaults, STRING .
Procedure Calls Summary (D-F) length, INT returned value internal-name, INT:ref:12 input external-name, STRING:ref:26 or STRING:ref:34 output FNAMECOMPARE (Superseded by FILENAME_COMPARE_) Compares two file names within a local or network environment to determine whether these file names refer to the same file or device. status := FNAMECOMPARE ( filename1 ,filename2 ); status, INT returned value -1 (CCL) The file names do not refer to the same file.
Procedure Calls Summary (D-F) [0:3] default volname. First two bytes can be “\sysnum,” in which case “$” is omitted from volume name. (blank-filled on right). [4:7] default subvolname (blank-filled on right). [0:7] corresponds directly to word[1:8] of the command interpreter startup message. FNAMETOFNAME32 (obsolete) Converts a file name from the 12-word Guardian format to the 32-character Distributed Name Service format.
Procedure Calls Summary (D-F) output iformat, STRING:ref:* (Use with FORMATCONVERT) STRING .EXT:ref:* (Use with FORMATCONVERTX) iformatlen, INT:value input eformat, input STRING:ref:* (Use with FORMATCONVERT) STRING .EXT:ref:* (Use with FORMATCONVERTX) eformatlen, INT:value input scales, output INT:ref:* (Use with FORMATCONVERT) INT .EXT:ref:* (Use with FORMATCONVERTX) input, output scale-count, INT:ref:* (Use with FORMATCONVERT) INT .
Procedure Calls Summary (D-F) 0 Successful operation. 267 Buffer overflow. 268 No buffer. 271 EDIT item mismatch. 272 Illegal input character. 273 Bad format. 274 Numeric overflow. buffer, input, output STRING:ref:* (Use with FORMATDATA) STRING .EXT:ref:* (Use with FORMATDATAX) bufferlen, INT:value input buffer-occurs, INT:value input length, output INT:ref:* (Use with FORMATDATA ) INT .EXT:ref:* (Use with FORMATDATAX) iformat, input INT:ref:* (Use with FORMATDATA ) INT .
Procedure Calls Summary (D-F) <3> P-Relative (iformat array) 0 = The iformat array address is G-relative. 1 = The iformat array address is P-relative. <4> Null value passed 0 = Each variable-list item is a 4-word group (FORMATDATA) or a 5-word group (FORMATDATAX). 1 = Each variable-list item is a 5-word group (FORMATDATA) or a 7-word group (FORMATDATAX). <15> Input 0 = FORMATDATA[X] performs output operations. 1 = FORMATDATA[X] performs input operations.
6 Procedure Calls Summary (G-N) This section lists procedure calls in alphabetic order and briefly describes the syntax of each. For additional information about the procedure calls, refer to the Guardian Procedure Calls Reference Manual. GETPCPBINFO Provides a process with information from its own (the current) process control block (PCB).
Procedure Calls Summary (G-N) GETCRTPID (Superseded by PROCESS_GETINFO_ and PROCESS_GETINFOLIST_) Obtains the four-word process ID associated with a process CRTPID contains the process name or creation timestamp in words[0:2] and cpu,pin in word[3]. CALL GETCRTPID ( cpu,pin ,process-id ); cpu,pin, INT:value input process-id, INT:ref:4 output < (CCL) GETCRTPID failed, or no such process exists. = (CCE) GETCRTPID completed successfully.
Procedure Calls Summary (G-N) sysnum, INT:value input devtype, INT:value input devsubtype, INT:value input GETINCREMENTEDIT Returns the record number increment value for an IOEdit file. GETINCREMENTEDIT is an IOEdit procedure and can be used only with files that have been opened by OPENEDIT or OPENEDIT_. increment := GETINCREMENTEDIT ( filenum ); increment, INT(32) returned value filenum, INT .
Procedure Calls Summary (G-N) position, INT(32) returned value filenum, INT:value input GETPPDENTRY (Superseded by PROCESS_GETPAIRINFO_) Obtains a description of a named process pair by the process pair’s index into the destination control table (DCT). CALL GETPPDENTRY ( index ,sysnum ,ppd ); index, INT:value input sysnum, INT:value input ppd, INT:ref:9 output [0:2] Process name (in local form). [3].<0:7> Processor of primary process. [3].<8:15> PIN of primary process. [4].
Procedure Calls Summary (G-N) cpu,pin, INT:value input process-id, INT:ref:4 output sysnum, INT:value input < (CCL) The GETREMOTECRTPID failed. Either no such process exists, the remote system could not be accessed, or the process has an inaccessible name, consisting of more than four characters. = (CCE) GETREMOTECRTPID was successful. GETSYNCINFO (Superseded by FILE_GETSYNCINFO_) Returns a disk file’s synchronization block so it can be sent to the backup process in a checkpoint message.
Procedure Calls Summary (G-N) >0 The logical device number of the network line handler that controls the current path to the system designated by sysnum. 0 The sysnum parameter is not defined. -1 All paths to the system are down. -2 The system is not on a network, or the system is local and unnamed (system name is blank). -3 A bounds error occurred on sysname.
Procedure Calls Summary (G-N) 0 No error. 11 Record not in use. The specified group name or group ID is undefined. 22 Parameter out of bounds. An input parameter is not within the valid range, or return information does not fit into the length of the space provided, or an output parameter overlays the stack marker that was created by calling this procedure. 29 This procedure was called without specifying a required parameter. 590 Bad parameter value.
Procedure Calls Summary (G-N) GROUP_GETNEXT_ Returns a group name and group ID. On successive calls, all group names and group IDs can be obtained. error := GROUP_GETINFO_ ( group-name:group-maxlen ,group-curlen ,[ groupid ] ); error, INT returned value 0 No error. 11 Record not in file. There are no more groups, or the specified group name is undefined. 22 Parameter out of bounds.
Procedure Calls Summary (G-N) GROUPMEMBER_GETNEXT_ Returns a user name or alias associated with a group ID. On successive calls, all user names and aliases associated with a given group ID can be obtained. error := GROUPMEMBER_GETNEXT_ ( groupid ,member-name:member-maxlen ,member-curlen ); error, INT returned value 0 No error. 11 Record not in file. The specified group has no more members or is undefined. 22 Parameter out of bounds.
Procedure Calls Summary (G-N) HALTPOLL Stops continuous polling. CALL HALTPOLL ( filenum ); filenum, INT:value input < (CCL) An error occurred (call FILEINFO). = (CCE) The HALTPOLL procedure executed successfully. HEADROOM_ENSURE_ Allows you to check that the current stack has enough room for the needs of your process. This procedure can help you, for example, when specifying parameters for the PROCESS_LAUNCH_ procedure. Note. This procedure can be called only from a TNS/R native process.
Procedure Calls Summary (G-N) HEAPSORT Sorts an array of equal-sized elements in place. CALL HEAPSORT ( array ,num-elements ,size-of-element ,compare-proc ); array, INT:ref:* input, output num-elements, INT:value input size-of-element, INT:value input compare-proc, INT PROC input HEAPSORTX_ Sorts an array of equal-sized elements in place.
Procedure Calls Summary (G-N) HIST_FORMAT_ Produces an ASCII text representation of the process state whose context is established by a previous call to the HIST_INIT_ procedure or HIST_GETPRIOR_ procedure. ?SOURCE $SYSTEM.SYSTEM.HHISTRY ret-val := HIST_FORMAT_ ( workspace ,text ,limit ); ret-val, INT returned value -2 HIST_BAD_WIDTH The value of the limit parameter is less than the minimum width for output defined by the Hist_MinWidth literal in the HHISTRY header file.
Procedure Calls Summary (G-N) 0 HIST_OK The procedure executed successfully. -8 HIST_ERROR The stack tracing mechanism failed. -9 HIST_BAD_WORKSPACE The workspace structure has an invalid version identifier. This error can occur if HIST_GETPRIOR_ is called without first calling the HIST_INIT_ procedure or if the workspace structure has become corrupted. workspace, INT .EXT:ref:(HIST_WORKSPACE_TEMPLATE) input, output HIST_INIT_ Initializes a process history display or stack trace.
Procedure Calls Summary (G-N) -7 HIST_INIT_ERROR An error occurred during an attempt to initialize the stack trace. -8 HIST_ERROR The stack tracing mechanism failed while attempting to trace back to the calling procedure. -11 HIST_MISSING_HOOK This error is not returned in the D40 release. workspace, INT.
Procedure Calls Summary (G-N) <11> HO_NoSuppress enables the display of transition frames, including the shells by which TNS code calls TNS/R native procedures, the system procedure that calls a signal handler, and some transitions within low-level system software. By default, transition frames are not displayed. <10> HO_ShowProtected enables the display of protected context when a signal is generated within protected code.
Procedure Calls Summary (G-N) maxfiles, INT:value input errorabend, INT:value input nowait-option, INT:value input 0 Don’t use double buffering on any file. 1 Use double buffering on all files that the user opens for nowait I/O before calling OPENEDIT_ (or OPENEDIT). 2 Use double buffering on all files opened for nowait I/O, whether by the user or by OPENEDIT_ (or OPENEDIT).
Procedure Calls Summary (G-N) <13> If 1, CALL MONITORNET (-1). <14> If 1, CALL MONITORCPUS (-1). <15> If 1, CALL ARMTRAP (-1,-1). timelimit, INT(32):value input >= 0D The timelimit parameter specifies the maximum amount of time (in units of 0.01 second) that INITIALIZER is to wait on $RECEIVE. = -1D INITIALIZER is to wait indefinitely. < -1D INITIALIZER calls ABEND.
Procedure Calls Summary (G-N) julian-day-num, INT(32):value input year, INT:ref:1 output month, INT:ref:1 output day, INT:ref:1 output INTERPRETTIMESTAMP Converts a 64-bit Julian timestamp into a Gregorian (the common civil calendar) date and time of day. ret-date-time := INTERPRETTIMESTAMP ( julian-timestamp ,date-n-time ); ret-date-time, INT(32) returned value julian-timestamp, FIXED:value input date-n-time, INT:ref:8 output [0] The Gregorian year (yyyy).
Procedure Calls Summary (G-N) 0 Current GMT. 1 System-load GMT. 2 SYSGEN GMT. 3 Microseconds since system cold load. tuid, INT:ref:1 output error, INT output node, INT input KEYPOSITION[X] (Superseded by FILE_SETKEY_) Positions by primary or alternate key within a structured file. CALL KEYPOSITION[X] ( filenum ,key-value ,[ key-specifier ] ,[ length-word ] ,[ positioning-mode ] ); filenum, INT:value key-value, input STRING .ref:* (use with KEYPOSITION) input STRING .
Procedure Calls Summary (G-N) retvalue, INT returned value 1 Tape-label processing is enabled. 0 Tape-label processing is not enabled. <0 File-system error expressed as a negative value. sysnum, INT:value input LASTADDR (Superseded by ADDRESS_DELIMIT_) Returns the 'G'[0] relative address of the last word in the application process’s data area.
Procedure Calls Summary (G-N) LASTRECEIVE (Superseded by FILE_GETRECEIVEINFO_) Obtains the four-word process ID and the message tag associated with the last message read from the $RECEIVE file. CALL LASTRECEIVE ( [ process-id ] ,[ message-tag ] ); process-id, INT:ref:4 output message-tag, INT:ref:1 output < (CCL) $RECEIVE is not open. = (CCE) LASTRECEIVE was successful.
Procedure Calls Summary (G-N) LOCKFILE Excludes other processes from accessing a file (and any records within that file). This procedure operates only on Guardian objects. CALL LOCKFILE ( filenum ,[ tag ] ); filenum, INT:value input tag, INT(32):value output < (CCL) An error occurred (call FILEINFO). = (CCE) LOCKFILE was successful. > (CCG) The file is not a disk file. LOCKINFO (Superseded by FILE_GETLOCKINFO_) Provides information about locks (held or pending) on a DP2 disk volume.
Procedure Calls Summary (G-N) LOCKREC Excludes other processes from accessing a record at the current position. This procedure operates only on Guardian objects. CALL LOCKREC ( filenum ,[ tag ] ); filenum, INT:value input tag, INT(32):value input < (CCL) An error occurred (call FILEINFO). = (CCE) LOCKREC was successful. > (CCG) The file is not a disk file. LONGJMP_ Performs a nonlocal goto. It restores the state of the calling process with context saved in a jump buffer by the SETJMP_ procedure.
Procedure Calls Summary (G-N) < (CCL) The specified process name is not in the directory, or the remote system could not be accessed. = (CCE) The specified name was found. > (CCG) The specified entry number exceeds the last table entry. MBCS_ANY_KATAKANA_ Checks a string of Tandem Kanji characters for any Katakana characters.
Procedure Calls Summary (G-N) testmbcschar, STRING .EXT:ref:* input charset, INT:value input when result is nonzero: 1 Tandem Kanji 9 Tandem Hangul 10 Tandem Chinese Big 5 11 Tandem Chinese PC 12 Tandem KSC5601 charinfo, INT .EXT:1 input, output MBCS_CHARSIZE_ Returns the display size (in columns) and the storage size (in bytes) of multibyte character set (MBCS) characters from the character set specified by the charset parameter.
Procedure Calls Summary (G-N) MBCS_CHARSTRING_ Tests the contents of a data string for the exclusive use of MBCS characters of known internal character sets. result := MBCS_CHARSTRING_ ( testmbcsstring ,bytecount ,index ,[ charset ] ,[ charinfo ] ); result, INT:value input 0 indicates that the charset parameter contains an unknown MBCS identifier or contains a known MBCS identifier but the test of testmbcsstring for valid characters failed.
Procedure Calls Summary (G-N) <6> reserved <7> JIS Kanji <8> reserved <9> Tandem Hangul <10> Chinese Big 5 <11> Chinese PC (5550C) <12> Tandem KSC5601 (with KIPS extensions) MBCS_DEFAULTCHARSET_ Returns the default multibyte character set (MBCS) identification.
Procedure Calls Summary (G-N) 0 Successful completion of the translation -1 Translation truncated due to lack of destination buffer space -2 Unknown translation requested -3 Invalid source string length -4 Invalid character in Kanji-only source string -5 Control string parameter too long -6 Translation truncated due to lack of space in screen field 29 Required parameter missing source-string, INT(32) .EXT:ref:1 input, output destination-string, INT(32) .
Procedure Calls Summary (G-N) MBCS_FORMAT_CRT_FIELD Formats Kanji only or mixed data types for specific terminal types.
Procedure Calls Summary (G-N) last-column, INT:value input max-data-size, INT .EXT:ref:1 input, output screen-start-col, INT .EXT:ref:1 input, output shift-to-DBCS, STRING .EXT:ref:* input shift-to-one-byte, STRING .EXT:ref:* input startmode, INT:value input MBCS_FORMAT_ITI_BUFFER_ Formats ITI buffers for specific terminal types.
Procedure Calls Summary (G-N) maximum-length, INT .EXT:ref:1 input intermediate, INT:value input terminal-type, INT:value input 0 IBM 3274-series 1 IBM Emulation on IBM5550 with one-byte Katakana 2 IBM Emulation on IBM5550 with lowercase alphabet 4 Fujitsu F-6650 with lowercase alphabet 5 Fujitsu F-6650 with one-byte Katakana maximum-col-count, INT:value input finished-length, INT .EXT:ref:1 output screen-col-count, INT .EXT:ref:1 output shift-to-DBCS, STRING .
Procedure Calls Summary (G-N) charinfo, INT .EXT:ref:1 output MBCS_REPLACEBLANK_ Replaces nonstandard blanks. CALL MBCS_REPLACEBLANK_ ( bytestring ,bytecount ,[ charset ] ,[ charinfo ] ); bytestring, STRING .EXT:ref:* input bytecount, INT:value input charset, INT:value input charinfo, INT .EXT:ref:1 input, output MBCS_SB_TO_MB_ Converts 1-byte ASCII characters to the corresponding multibyte characters.
Procedure Calls Summary (G-N) MBCS_SHIFTSTRING_ Upshifts or downshifts all alphabetic characters in a multibyte character set (MBCS) string. CALL MBCS_SHIFTSTRING_ ( bytestring ,bytecount ,casebit ,[ charset ] ,[ charinfo ] ); bytestring, STRING .EXT:ref:* input bytecount, INT:value input casebit, INT:value input charset, INT:value input charinfo, INT .EXT:ref:1 output MBCS_TANDEM_TO_EXTERNAL_ Translates a text string from Tandem internal format to a specified external text format.
Procedure Calls Summary (G-N) -5 Control string parameter too long -6 Translation truncated due to lack of space in screen field 29 Required parameter missing source-string, INT(32) .EXT:ref:1 input, output destination-string, INT(32) .EXT:ref:1 input, output source-length, INT:value input maximum-length, INT .
Procedure Calls Summary (G-N) 0 1-byte character 1 First byte of a multibyte character 2 Intermediate byte of a multibyte character 3 Last byte of a multibyte character buffer, STRING .EXT:ref:* input bytecount, INT:value input testindex, INT .EXT:ref:1 input, output charset, INT:value input charinfo, INT .EXT:ref:1 output MBCS_TRIMFRAGMENT_ Detects and trims trailing multibyte character fragments from text strings.
Procedure Calls Summary (G-N) message-tag, INT:value input MESSAGESYSTEMINFO Measures the number of XLBs used by a process, so it can warn when a limit is nearly reached. error := MESSAGESYSTEMINFO ( itemcode ,value ); error, INT 0 Successful, no error 2 Bad itemcode 21 Bad value 22 Bounds error 29 Missing parameter output itemcode, INT:value input value, INT .EXT:ref:1 output 0 The current limit on the number of messages to this process, as set by CONTROLMESSAGESYSTEM.
Procedure Calls Summary (G-N) MONITORCPUS Notifies the application process when a designated processor module fails or is returned to an operable state. CALL MONITORCPUS ( cpu-mask ); cpu-mask, INT:value input MONITORNET Enables or disables the receipt of system messages concerning the status of processors in remote systems. CALL MONITORNET ( enable ); enable, INT:value 0 Disable the receipt of messages. 1 Enable the receipt of messages.
Procedure Calls Summary (G-N) MOVEX Moves data between extended data segments without the need for absolute addressing; it serves both privileged and nonprivileged users. error := MOVEX ( [ source-seg-id ] ,source ,[ dest-seg-id ] ,dest ,byte-count ); error, INT returned value 0 Successful call; the specified data was moved. 2 Either source-seg-id or dest-seg-id specified a nonexistent extended data segment, or the destination data segment has read-only access.
Procedure Calls Summary (G-N) MYPID (Superseded by PROCESSHANDLE_GETMINE_ and PROCESSHANDLE_DECOMPOSE_ ) Gives a process its own processor and PIN number. cpu,pin := MYPID; cpu,pin, INT:value returned value MYPROCESSTIME Returns the process execution time of the calling process. process-time := MYPROCESSTIME; process-time, FIXED returned value MYSYSTEMNUMBER (Superseded by NODENAME_TO_NODENUMBER_ or PROCESSHANDLE_GETMINE_ and PROCESSHANDLE_DECOMPOSE_) Gives a process its own system number.
Procedure Calls Summary (G-N) NEWPROCESS (Superseded by PROCESS_CREATE_ and PROCESS_LAUNCH_) Creates a new Guardian process. CALL NEWPROCESS ( filenames ,[ priority ] ,[ memory-pages ] ,[ processor ] ,[ process-id ] ,[ error ] ,[ name ] ,[ hometerm ] ,[ flags ] ,[ jobid ] ,[ errinfo ] ,[ pfs-size ] ); filenames, INT:ref:12 INT:ref:38 input priority, INT:value input <0> =1 A code breakpoint is set on the first executable instruction of the program’s MAIN procedure.
Procedure Calls Summary (G-N) <10> =0 =1 Use the DEFINE mode of caller. Use value in flags.<12>. <12> =0 =1 DEFINEs disabled. DEFINEs enabled. <14> =1 =0 Saveabend file creation. No saveabend file creation. <15> =1 =0 Inspect. Debug. jobid, INT:value input errinfo, INT .EXT:ref:2 output pfs-size, INT(32):value input NEWPROCESSNOWAIT (Superseded by PROCESS_CREATE_and PROCESS_LAUNCH_) Creates a new Guardian process using the nowait option.
Procedure Calls Summary (G-N) memory-pages, INT:value input processor, INT:value input process-id, INT:ref:4 unused error, INT:ref:1 output name, INT:ref:3 input hometerm, INT:ref:12 input flags, INT:value input <10> =0 =1 Use the DEFINE mode of caller. Use value in flags.<12>. <12> =0 =1 DEFINEs disabled. DEFINEs enabled. <14> =1 =0 Saveabend file creation. No saveabend file creation. <15> =1 =0 Inspect. Debug. jobid, INT:value input errinfo, INT .
Procedure Calls Summary (G-N) NO^ERROR Is called internally by sequential I/O (SIO) procedures. NO^ERROR implements error handling and retries within the SIO procedure environment. If the file was opened by OPEN^FILE, then file-system procedures can call NO^ERROR directly. no-retry := NO^ERROR ( state ,file-fcb ,good-error-list ,retryable ); no-retry, INT 0 The operation should be retried. <>0 The operation should not be retried.
Procedure Calls Summary (G-N) 0 File name successfully retrieved. 1 Reserved. 2 Parameter error. 3 Bounds error. 4 Unable to communicate with node. 5 The nodename parameter designates a C-series system. filename:maxlen, STRING .EXT:ref:*,INT:value output:input filename-length, INT .EXT:ref:1 output nodename:length, STRING .EXT:ref:*,INT:value input:input NODENAME_TO_NODENUMBER_ Converts a node name (system name) to the corresponding node number (system number).
Procedure Calls Summary (G-N) NUMBEREDIT Renumbers the lines of an EDIT file that are in a specified range. NUMBEREDIT is an IOEdit procedure and can be used only with files that have been opened by OPENEDIT or OPENEDIT_. error := NUMBEREDIT ( filenum ,first ,last ,[ start ] ,[ increment ] ); error, INT returned value -6 Exhausted valid line numbers. -10 Unable to complete renumbering; file is unchanged.
Procedure Calls Summary (G-N) 1 Nonexistent number 0 Valid conversion -1 Illegal integer or illegal syntax NUMOUT Converts unsigned integer values to their ASCII equivalents, right-justified in an array. Any preceding blanks are filled with zeroes.
7 Procedure Calls Summary (O-Q) This section lists procedure calls in alphabetic order and briefly describes the syntax of each. For additional information about the procedure calls, refer to the Guardian Procedure Calls Reference Manual. OBJFILE_GETINFOLIST_ Obtains information about the object file or user library file of the calling process.
Procedure Calls Summary (O-Q) Attribute Code Attribute Description Value Representation 1 Binder timestamp INT (3 words) 2 minimum tos version INT 3 Inspect length INT(32) 4 Binder length INT(32) 5 Inspect on INT 6 high PIN INT 7 high requesters INT 8 run named INT 9 PFS size INT(32) 10 target processor INT 11 accelerator timestamp INT (4 words) 12 compilation mode (accelerated or not accelerated) INT 13 run mode (will or will not run accelerated) INT OLDFILENAME_T
Procedure Calls Summary (O-Q) error, INT returned value 0 Message successfully converted. 1 File-system error; error-detail contains the file-system error number. 2 Parameter error; error-detail contains the number of the first parameter found to be in error, where 1 designates the first parameter on the left. 3 Bounds error; error-detail contains the number of the first parameter found to be in error, where 1 designates the first parameter on the left.
Procedure Calls Summary (O-Q) OPEN (Superseded by FILE_OPEN_) Establishes a communication path between an application process and a file. OPEN returns a file number to the application process. This procedure operates only on Guardian objects.
Procedure Calls Summary (O-Q) Flag Flag in Octal Meaning <7> %400 Must be 0 (reserved) <8> %200 For process files, indicates that the open message is sent nowait and must be completed with a call to AWAITIO[X]. OPEN returns a valid file number.
Procedure Calls Summary (O-Q) OPEN^FILE Allows access to a file. error := OPEN^FILE ( common-fcb ,file-fcb ,[ block-buffer ] ,[ block-bufferlen ] ,[ flags ] ,[ flags-mask ] ,[ max-recordlen ] ,[ prompt-char ] ,[ error-file-fcb ] ); error, INT returned value common-fcb, INT:ref:* input file-fcb, INT:ref:* input block-buffer, INT:ref:* input block-bufferlen, INT:value input flags, INT(32):value input Note. Combine selected values using signed addition because bit 0 is not used.
Procedure Calls Summary (O-Q) WRITE^FOLD %10000D WRITE^PAD %20000D WRITE^TRIM %4000D flags-mask, INT(32):value input max-recordlen, INT:value input prompt-char, INT:value input error-file-fcb, INT:ref:* input OPENEDIT (Superseded by OPENEDIT_) Allocates and initializes data blocks in the EDIT file segment (EFS) so that the specified file can be accessed later by the IOEdit procedures. It optionally creates and opens the specified file through the file system.
Procedure Calls Summary (O-Q) 31 Unable to obtain buffer space; indicates that the file’s directory does not fit into IOEdit’s extended data segment and OPENEDIT is unable to enlarge the segment. 34 Unable to obtain memory space for control block; indicates that the number of IOEdit files already open is equal to the maximum number specified or assumed when INITIALIZEEDIT was called.
Procedure Calls Summary (O-Q) 16 File has not been opened, wrong file type; indicates that the file is not an EDIT file (that is, the file type is not unstructured or the file code is not 101 or 102). 31 Unable to obtain buffer space; indicates that the file’s directory does not fit into IOEdit’s extended data segment and OPENEDIT is unable to enlarge the segment.
Procedure Calls Summary (O-Q) 5 Primary opener lost; backup promoted to primary 6 Openers lost; table entry now free 7 Message is not a relevant status-change message message:length, STRING .EXT:ref:*,INT:value -2 Local processor failure -8 Network status change -100 Remote processor failure -110 Connection to remote system lost table, INT .EXT:ref:* input index, INT .
Procedure Calls Summary (O-Q) 0 Read/write. 1 Read only. 2 Write only. exclusion, INT:ref:1 0 Shared. 1 Exclusive. 3 Protected. output syncdepth, INT:ref:1 output filename, INT:ref:12 output accessid, INT:ref:1 output validmask, INT:ref:1 output <0> The value of pricrtpid is valid. <1> The value of backcrtpid is valid. <2> The value of accessmode is valid. <3> The value of exclusion is valid. <4> The value of syncdepth is valid. <5> The value of filename is valid.
Procedure Calls Summary (O-Q) PACKEDIT Converts a line image from unpacked format into EDIT packed line format. PACKEDIT is an IOEdit procedure and can be used only with files that have been opened by OPENEDIT or OPENEDIT_. PACKEDIT ( unpacked-line ,unpacked-length ,packed-line ,packed-limit ,packed-length ,[ full-length ] ); unpacked-line, STRING .EXT:ref:* input unpacked-length, INT:value input packed-line, STRING .EXT:ref:* output packed-limit, INT:value input packed-length, INT .
Procedure Calls Summary (O-Q) 4020 A prefix within pathname refers to a file other than a directory. The corresponding OSS errno value is ENOTDIR. 4022 pathname is invalid. The corresponding OSS errno value is EINVAL. 4131 The pathname or a component of the pathname is longer than PATH_MAX characters. (PATH_MAX is a symbolic constant defined in the OSS limitsh header file.) The corresponding OSS errno value is ENAMETOOLONG. 4202 The root fileset is not mounted.
Procedure Calls Summary (O-Q) POOL_DEFINE_ Designates a portion of a user's stack or an extended data segment for use as a pool. error := POOL_DEFINE_ ( pool ,pool-size ,[ alignment ] ,[ priv-only ] ); error, INT returned value 0 No error. 2 Required parameter missing. The pool and pool-size parameters must be specified. 3 Bounds error.
Procedure Calls Summary (O-Q) error INT returned value 0 No error. 2 Required parameter missing. The error-detail parameter contains the number of the first parameter found to be in error, where 1 designates the first parameter on the left. 3 Bounds error. The error-detail parameter contains the number of the first parameter found to be in error, where 1 designates the first parameter on the left. 9 Corrupt pool header. pool, INT .EXT:ref:* input error-detail, INT .
Procedure Calls Summary (O-Q) 4 Invalid block size. The value of block-size is not within the valid range. 9 Corrupt pool header. 10 Unable to allocate space. POOL_PUTSPACE_ Returns a block of memory to a buffer pool. error := POOL_PUTSPACE_ ( pool ,block ); error, INT returned value 0 No error. 2 Required parameter missing. 3 Bounds error. The block parameter is not within the pool boundaries. 9 Corrupt pool header. 11 Corrupt allocated block.
Procedure Calls Summary (O-Q) 9 Corrupt pool header. 11 Corrupt allocated blocks. Data is probably written beyond the allocated block. 12 Corrupt free list blocks. Data is probably written into a returned block. 13 Unable to shrink pool. pool, INT .EXT:ref:* input new-pool-size, INT(32):value input POSITION (Superseded by FILE_SETPOSITION_) Positions by primary key within relative and entry-sequenced files. For unstructured files, it specifies a new current position.
Procedure Calls Summary (O-Q) PRIORITY (Superseded by PROCESS_SETINFO_, PROCESS_GETINFO_, and PROCESS_GETINFOLIST_) Enables a process to examine or change its initial priority and current priority. old-priority := PRIORITY ( [ new-priority ] ,[ init-priority ] ); old-priority, INT returned value new-priority, INT:value input init-priority, INT:ref:1 output PROCESS_ACTIVATE_ Returns a suspended process or process pair to the ready state.
Procedure Calls Summary (O-Q) PROCESS_CREATE_ (Superseded by PROCESS_LAUNCH_) Creates a new Guardian process and, optionally, assigns a symbolic process name to it.
Procedure Calls Summary (O-Q) name:length, STRING .EXT:ref:*,INT:value input:input process-descr:maxlen, STRING .EXT:ref:*,INT:value output:input process-descr-len, INT .EXT:ref:1 output nowait-tag, INT(32):value input hometerm:length, STRING .
Procedure Calls Summary (O-Q) <13> =1 =0 If the process traps, create a saveabend file. If the process traps, do not create a saveabend file. <14> =1 =0 Use debugger specified in bit 15 and saveabend option specified in bit 13 regardless of program-file flag setting. Use standard rules for debugger selection. =1 =0 Use Inspect. Use Debug. <15> pfs-size, INT(32):value input PROCESS_DEBUG_ Invokes the debug facility for the calling process or another process.
Procedure Calls Summary (O-Q) PROCESS_GETINFO_ Obtains a limited set of information about a specified process.
Procedure Calls Summary (O-Q) process-time, FIXED .EXT:ref:1 output creator-access-id, INT .EXT:ref:1 output process-access-id, INT .EXT:ref:1 output gmom's-processhandle, INT .EXT:ref:10 output jobid, INT .EXT:ref:1 output program-file:maxlen, STRING .EXT:ref:*,INT:value output:input program-len, INT .EXT:ref:1 output swap-file:maxlen, STRING .EXT:ref:*,INT:value output:input swap-len, INT .EXT:ref:1 output error-detail, INT .EXT:ref:1 output proc-type, INT .
Procedure Calls Summary (O-Q) 0 Information is returned for the specified process or processes; error-detail contains the number of processes for which information has been returned (might be more than one process if in search mode). 1 File-system error; error-detail contains the error number. 2 Parameter error; error-detail contains the number of the first parameter found to be in error, where 1 designates the first parameter on the left.
Procedure Calls Summary (O-Q) 0 Return information for only the process specified by nodename, cpu, pin or by processhandle. 1 Start a search at nodename, cpu, pin and return information for the first matching process. 2 Start a search at nodename, cpu, pin and return information for as many matching processes as will fit in ret-values-list. 3 Return information for only the OSS process specified by nodename, oss-pid. srch-attr-list, INT .
Procedure Calls Summary (O-Q) Attribute Code Value Representation * 34 swap file INT bytelength, STRING 35 context changes INT 36 DEFINE mode INT 37 licenses INT 38 PIN INT * 39 file name INT bytelength, STRING * 40 mom's process handle INT (10 words) 41 process file security INT 42 current priority INT 43 initial priority INT 44 remote creator INT 45 logged-on state INT 46 extended data segment swap file INT bytelength, STRING 47 primary INT 48 process handle
Procedure Calls Summary (O-Q) Attribute Code Value Representation 73 applicable attributes INT 80 effective group ID INT(32) 81 saved set-group-ID INT(32) 82 login name INT bytelength, STRING <= 32 chars 83 group list INT n, INT(32) [0:n-1] 84 saved set-user-ID INT(32) * 90 OSS process ID (OSS process only) INT(32) 91 OSS command (OSS process only) INT bytelength, STRING <= 80 chars 92 OSS arguments (OSS process only) INT bytelength, STRING <= 80 chars 93 OSS program pathname
Procedure Calls Summary (O-Q) Attribute Code Value Representation 115 TNS/R native shared run-time library: buffer size required for attribute 116 INT 116 TNS/R native shared run-time library file-name information (in a variablesized array) INT number of file names, INT flags INT file-name length, STRING file name 117 TNS/R native shared run-time library: buffer size required for attribute 118 INT 118 TNS/R native shared run-time library name information (in a variable-sized array).
Procedure Calls Summary (O-Q) 6 Information is returned for a process pair where the caller is the current backup. 7 No information is returned; process is unnamed (can be the calling process). 8 No information is returned; search is complete. 9 Specified process does not exist. 10 Unable to communicate with the node where the process resides. 11 Process is an I/O process, but the option to allow I/O processes was not selected.
Procedure Calls Summary (O-Q) PROCESS_LAUNCH_ Creates a new process and, optionally, assigns a number of process attributes. You can use this procedure to create only Guardian processes, although you can call it from a Guardian process or an OSS process. The program file must contain a program for execution in the Guardian environment. The program file and any user library file must reside in the Guardian name space; that is, they must not be OSS files.
Procedure Calls Summary (O-Q) error, INT returned value processhandle, INT .EXT:ref:10 input specifier, INT:value input 0 Act upon the specified process only. 1 Act upon both members if processhandle specifies a member of a named process pair. set-attr-code, INT:value input set-value, INT .EXT:ref:* input set-value-len, INT:value input old-value, INT .EXT:ref:* output old-value-maxlen, INT:value input old-value-len, INT .EXT:ref:1 output Note.
Procedure Calls Summary (O-Q) PROCESS_SETSTRINGINFO_ Alters a single string-form attribute of a specified process, and optionally returns the prior value of the attribute. error := PROCESS_SETSTRINGINFO_ ( [ processhandle ] ,[ specifier ] ,set-attr-code ,[ set-value:length ] ,[ old-value:maxlen ] ,[ old-value-len ] ); error, INT returned value processhandle, INT .EXT:ref:10 input specifier, INT:value input 0 Act upon the specified process only.
Procedure Calls Summary (O-Q) oss-pid, INT(32) .EXT:ref:1 returned value oss-program-file, STRING .EXT:ref:* input fdinfo, STRING .EXT:ref:(ZSYS^DDL^FDINFO) input argv, EXTADDR .EXT:ref:1 input envp, EXTADDR .EXT:ref:1 input inheritance, STRING .EXT:ref:(ZSYS^DDL^INHERITANCE) input inheritance-length, INT(32):value input prcoess-extension, STRING .EXT:ref:(ZSYS^DDL^PROCESSEXTENSION) input process-results, STRING .
Procedure Calls Summary (O-Q) <0:14> Reserved (specify 0) <15> Normal termination (STOP) 1 Abnormal termination (ABEND) completion-code, INT:value input termination-info, INT:value input spi-ssid, INT .EXT:ref:6 input text:length, STRING .EXT:ref:*,INT:value input:input PROCESS_SUSPEND_ Places a process or process pair into the suspended state. error := PROCESS_SUSPEND_ ( processhandle ,[ specifier ] ); error, INT returned value 0 Process has been successfully suspended.
Procedure Calls Summary (O-Q) <0:7> Group number <8:15> User number PROCESSFILESECURITY (Superseded by PROCESS_SETINFO_, PROCESS_GETINFO_, or PROCESS_GETINFOLIST_) Examines or sets the file security for the current process. old-security := PROCESSFILESECURITY ( security ); old-security, INT returned value security, INT:value input <0:3> 0. <4:6> ID code allowed for read. <7:9> ID code allowed for write. <10:12> ID code allowed for execute. <13:15> ID code allowed for purge.
Procedure Calls Summary (O-Q) 0 Process handles are unrelated. 1 Process handles are not identical but designate a process pair. 2 Process handles are identical. processhandle-1, INT .EXT:ref:10 input processhandle-2, INT .EXT:ref:10 input PROCESSHANDLE_DECOMPOSE_ Returns one or more parts of a process handle.
Procedure Calls Summary (O-Q) 0 Information returned successfully. 3 Parameter address out of bounds. processhandle, INT .EXT:ref:10 output PROCESSHANDLE_NULLIT_ Initializes a process handle to a null value. error := PROCESSHANDLE_NULLIT_ ( processhandle ); error, INT 0 Operation was successful. 22 Parameter is out of bounds. 29 Parameter is missing. processhandle, INT .
Procedure Calls Summary (O-Q) PROCESSHANDLE_TO_FILENAME_ Converts a process handle to a process file name. error := PROCESSHANDLE_TO_FILENAME_ ( processhandle ,filename:maxlen ,filename-length ,[ options ] ); error, INT returned value processhandle, INT .EXT:ref:10 input filename:maxlen, STRING .EXT:ref:*,INT:value output:input filename-length, INT .EXT:ref:1 output options, INT:value input <0:14> Not currently used (specify 0).
Procedure Calls Summary (O-Q) PROCESSINFO (Superseded by PROCESS_GETINFO_ and PROCESS_GETINFOLIST_) Obtains process status information.
Procedure Calls Summary (O-Q) home-terminal, INT:ref:12 input, output sysnum, INT:value input search-mode, INT:value input <0> =1 =0 Must match process-id for 3 words. No search. <1> =1 =0 Must match creator-access-id. No search. <2> =1 =0 Must match process-access-id. No search. <3> =1 =0 Must be greater than or equal to priority. No search. <4> =1 =0 Must match program-filename. No search. <5> =1 =0 Must match home-terminal. No search. <6> =1 =0 Must match jobid. No search.
Procedure Calls Summary (O-Q) <4:5> Reserved. <6> MAB in system code. <7> Process not accepting any messages. <8> Temporary system process. <9> Process has logged on (called VERIFYUSER). <10> In a pending process state. <11:15> The process state, where. 0 Unallocated. 1 Starting. 2 Runnable. 3 Suspended. 4 Debug mab. 5 Debug breakpoint. 6 Debug trap. 7 Debug request. 8 Inspect mab. 9 Inspect breakpoint. 10 Inspect trap. 11 Inspect request. 12 Saveabend.
Procedure Calls Summary (O-Q) PROCESSNAME_CREATE_ Returns a unique process name that is suitable for passing to the PROCESS_CREATE_ procedure. error := PROCESSNAME_CREATE_ ( name:maxlen ,namelen ,[ name-type ] ,[ nodename:length ] ,[ options ] ); error, INT returned value 0 Process name is returned successfully. 44 No names of the specified type are available. 201 Unable to communicate with the specified node. 590 Parameter or bounds error. name:maxlen, STRING .
Procedure Calls Summary (O-Q) PROCESSOR_GETINFOLIST_ Obtains configuration information and statistics about a processor. error := PROCESSOR_GETINFOLIST_ ( [ nodename:length ] ,[ cpu ] ,ret-attr-list ,ret-attr-count ,ret-values-list ,ret-values-maxlen ,ret-values-len ,[ error-detail ] ); error, INT returned value 0 Information is returned for the specified process. 1 File-system error; error-detail contains the error number.
Procedure Calls Summary (O-Q) Code Attribute Value Representation 2 processor type INT 3 software version INT 4 page size INT(32) 5 memory size INT(32) 6 first virtual page INT(32) 7 swappable pages INT(32) 8 free pages INT(32) 9 current locked memory INT(32) 10 maximum locked memory INT(32) 11 high locked memory INT(32) 12 page faults INT(32) 13 scans per memory manager call INT(32) 14 memory clock cycles INT(32) 15 memory pressure INT 16 memory queue length
Procedure Calls Summary (O-Q) Code Attribute Value Representation 40 sequenced sends INT(32) 41 unsequenced sends INT(32) 42 CME events INT(32) 43 pages created INT(32) 44 interpreter busy FIXED 45 interpreter transitions INT(32) 46 transactions INT(32) 47 processor model INT 48 processor name INT bytelength, STRING 49 processor full name INT bytelength, STRING 56 base time FIXED 57 memory-management attributes INT(32) 58 segments in use INT(32) 59 maximum segment
Procedure Calls Summary (O-Q) 22 Parameter or buffer out of bounds. 29 Missing parameter. 201 Unable to communicate over this path. 590 Parameter value bad or inconsistent. cpu-number, INT:value input name:maxlen, STRING .
Procedure Calls Summary (O-Q) processor-status, INT(32) returned value PROCESSORTYPE Returns the processor type of a specified system and processor. type := PROCESSORTYPE ( [ cpu ] ,[ sysid ] ); type, INT returned value -2 This feature is not supported for the system named in sysid. -1 Unable to communicate with processor (either it does not exist or the network is down). 0 Tandem NonStop 1+ processor (no longer supported). 1 Tandem NonStop II processor (no longer supported).
Procedure Calls Summary (O-Q) PROCESSSTRING_SCAN_ Scans an input string for a process string and returns the corresponding process handle or a single component of the process string converted to internal form. error := PROCESSSTRING_SCAN_ ( string:length ,[ length-used ] ,[ processhandle ] ,[ stringtype ] ,[ name:maxlen ] ,[ namelen ] ,[ cpu ] ,[ pin ] ,[ options ] ); error, INT returned value string:length, STRING .EXT:ref:*,INT:value input:input length-used, INT .
Procedure Calls Summary (O-Q) PROCESSTIME (Superseded by PROCESS_GETINFO_ and PROCESS_GETINFOLIST_) Returns the process execution time of any process in the network. process-time := PROCESSTIME ( [ cpu,pin ] ,[ sysid ] ); process-time, FIXED returned value -1F The process does not exist. -2F The system is unavailable or does not exist. >=0F PROCESSTIME was successful.
Procedure Calls Summary (O-Q) PUTPOOL (Superseded by POOL_CHECK_, POOL_DEFINE_, POOL_GETINFO_, POOL_GETSPACE_, POOL_PUTSPACE_, and POOL_RESIZE_) Returns a block of memory to a buffer pool. CALL PUTPOOL ( pool-head ,pool-block ); pool-head, INT .EXT:ref:19 input, output pool-block, STRING .EXT:ref:* input < (CCL) The data structures are invalid or pool-block is not a block in the buffer pool. = (CCE) The operation is successful.
8 Procedure Calls Summary (R-Z) This section lists procedure calls in alphabetic order and briefly describes the syntax of each. For additional information about the procedure calls, refer to the Guardian Procedure Calls Reference Manual. RAISE Note. This procedure can be called only from TNS/R native processes. RAISE_ is the pTAL procedure name for the C raise() function. The C raise() function complies with the POSIX.1 standard. See the $SYSTEM.SYSTEM.
Procedure Calls Summary (R-Z) < (CCL) An error occurred (call FILEINFO). < (CCL) Also returned following a successful read with an insertion-ordered alternate key path if the alternate key value of the current record is equal to the alternate key value in the following record along that path. A call to FILE_GETINFO_ or FILEINFO shows that error 551 occurred; this error is advisory only and does not indicate an unsuccessful read operation. = (CCE) The READ[X] is successful.
Procedure Calls Summary (R-Z) READEDIT Reads one line from a specified EDIT file and returns it to the caller in unpacked format. READEDIT is an IOEdit procedure and can be used only with files that have been opened by OPENEDIT or OPENEDIT_.
Procedure Calls Summary (R-Z) error, INT returned value packed-line, STRING .EXT:ref:* output packed-limit, INT:value input packed-length, INT .EXT:ref:1 output READLOCK[X] Sequentially locks and reads records in a disk file, exactly like the combination of LOCKREC and READ[X]. This procedure operates only on Guardian objects. CALL READLOCK[X] ( filenum ,buffer ,read-count ,[ count-read ] ,[ tag ] ); filenum, INT:value input buffer, output INT:ref:* (Use with READLOCK) STRING .
Procedure Calls Summary (R-Z) READUPDATE[X] Reads data from a disk or process file in anticipation of a subsequent write to the file. CALL READUPDATE[X] ( filenum ,buffer ,read-count ,[ count-read ] ,[ tag ] ); filenum, INT:value input buffer, output INT:ref:* (Use with READUPDATE) STRING .EXT:ref:* (Use with READUPDATEX) read-count, INT:value input count-read, output INT:ref:1 (Use with READUPDATE) INT .
Procedure Calls Summary (R-Z) filenum, INT:value input buffer output INT:ref:* (Use with READUPDATELOCK) STRING .EXT:ref:* (Use with READUPDATELOCKX) read-count, INT:value input count-read, output INT:ref:1 (Use with READUPDATELOCK) INT .EXT:ref:1 (Use with READUPDATELOCKX) tag, INT(32):value input < (CCL) An error occurred (call FILEINFO). = (CCE) The READUPDATELOCK[X] is successful.
Procedure Calls Summary (R-Z) 0 Not a data message 1 Sender called WRITE 2 Sender called READ 3 Sender called WRITEREAD < (CCL) $RECEIVE is not open. = (CCE) RECEIVEINFO is successful. REFPARAM_BOUNDSCHECK_ Checks the validity of parameter addresses passed to the procedure that calls it. Bounds checking performed by the system is enough for most applications. This procedure, however, provides additional checks for those few applications that might need it.
Procedure Calls Summary (R-Z) 3 The address area is in bounds in an extensible segment, but disk space for the extensible segment could not be allocated. If you try to write to this area, the effect depends on whether your process is a TNS process or a TNS/R native process: A TNS process might terminate with a “no memory available” trap (trap 12); a TNS/R native process might receive a SIGNOMEM signal.
Procedure Calls Summary (R-Z) status, INT(32) returned value sysnum, INT:value input REMOTETOSVERSION Provides an identifying letter and number indicating which version of the Guardian operating system is running on a remote system. tos-version := REMOTETOSVERSION [ ( sysid ) ]; tos-version, INT returned value <0:7> The uppercase ASCII letter that indicates system level: A TOS B 1.0 C 1.1 D 1.1 and Expand E 1.
Procedure Calls Summary (R-Z) filenum, INT:value input new-name, INT:ref:12 input < (CCL) An error occurred (call FILEINFO). = (CCE) The RENAME is successful. > (CCG) The file is not a disk file. REPLY[X] Sends a reply to a message received earlier in a corresponding call to READUPDATE[X] on the $RECEIVE file. CALL REPLY[X] ( [ ,[ ,[ ,[ ,[ buffer ] write-count ] count-written ] message-tag ] error-return ] ); buffer, input INT:ref:* (Use with REPLY) STRING .
Procedure Calls Summary (R-Z) < (CCL) An error occurred (call FILE_GETINFO_ or FILEINFO). = (CCE) The REPLY[X] is successful. > (CCG) A warning occurred (call FILE_GETINFO_ or FILEINFO). REPOSITION (Superseded by FILE_RESTOREPOSITION_) Positions a disk file to a saved position (the positioning information was saved by a call to the SAVEPOSITION procedure).
Procedure Calls Summary (R-Z) error := RESIZEPOOL ( pool-head ,new-pool-size ); error, INT returned value 0 Successful call; the size of the specified pool had been changed to new-pool-size. 12 The call would shrink the pool too much, leaving less area than that reserved by GETPOOL; the reserved blocks must be returned by a PUTPOOL. 21 An invalid new-pool-size was specified. 22 One of the parameters specifies an address that is out of bounds. 29 A required parameter was not supplied.
Procedure Calls Summary (R-Z) 21 An invalid new-segment-size was specified. 24 The seg-id parameter specified a privileged segment ID (greater than 2047) and the caller was not privileged. 29 A required parameter was not supplied. 43 Disk space could not be allocated to accommodate the new-segment-size specified. 45 The existing permanent swap file for the extended segment is not large enough to back up the requested new-segment-size.
Procedure Calls Summary (R-Z) SEGMENT_ALLOCATE_ Allocates an extended data segment for use by the calling process. error := SEGMENT_ALLOCATE_ ( segment-id ,[ segment-size ] ,[ filename:length ] ,[ error-detail ] ,[ pin ] ,[ segment-type ] ,[ base-address ] ,[ max-size ] ,[ alloc-options ] ); error, INT returned value 0 No error. 1 File-system error related to the creation or open of filename;.error-detail contains the file-system error number.
Procedure Calls Summary (R-Z) error-detail INT .EXT:ref:1 output pin INT:value input segment-type INT:value input base-address INT(32) .EXT:ref:1 output max-size INT(32):value input alloc-options INT:value input <0:13> Reserved (specify 0) <14> =0 =1 Allocate a selectable segment. Allocate a flat segment. If not running on a system that supports flat segments allocate a selectable segment. <15> =0 =1 Return the base-address in the base address parameter.
Procedure Calls Summary (R-Z) error, INT returned value 0 Segment successfully deallocated. 1 Segment deallocated, but an I/O error occurred when writing to the segment's permanent swap file; error-detail contains the file-system error number. 2 Parameter error; error-detail contains the number of the first parameter found to be in error, where 1 designates the first parameter on the left. 3 Bounds error. 4 Segment not deallocated; error-detail contains the reason for failure.
Procedure Calls Summary (R-Z) segment-id, INT:value input flags, INT:value input <0:14> Reserved (specify 0) <15> = 1 Dirty pages in memory are not to be written to the swap file. = 0 Dirty pages in memory are to be written to the swap file. error-detail, INT .EXT:ref:1 output SEGMENT_GETBACKUPINFO_ Retrieves information about an extended segment that is allocated by the backup process in a named process pair.
Procedure Calls Summary (R-Z) filename-len, INT .EXT:ref:1 output error-detail, INT .EXT:ref:1 output base-address, INT(32) .EXT:ref:1 output SEGMENT_GETINFO_ Retrieves information about a currently allocated extended segment. error := SEGMENT_GETINFO_ ( segment-id ,[ segment-size ] ,[ filename:maxlen ] ,[ filename-len ] ,[ error-detail ] ,[ base-address ] ,[ usage-flags ] ); error, INT returned value 0 No error.
Procedure Calls Summary (R-Z) <0:8> (Bits are reserved; 0 is returned) <9> Segment is a flat segment. <10> Segment is a resident cache segment. <11> Segment is a shared segment. <12> Segment is the currently in-use segment for the process. <13> Segment is writeback-inhibit. Changes made to the segment are not written to the swap files. <14> Segment is extensible. <15> Segment is resident.
Procedure Calls Summary (R-Z) SEGMENTSIZE (Superseded by SEGMENT_GETBACKUPINFO_ and SEGMENT_GETINFO_) Returns the size of the specified segment in bytes. seg-size := SEGMENTSIZE ( segment-id ); seg-size, INT(32) returned value segment-id, INT:value input SENDBREAKMESSAGE (Superseded by BREAKMESSAGE_SEND_) Allows user processes to send BREAK messages to other processes. error := SENDBREAKMESSAGE ( process-id ,[ breaktag ] ); error, INT returned value process-id, INT .
Procedure Calls Summary (R-Z) Note. For more information, please see Section 10, SET^FILE Operations. SETJMP_ Saves process context in a jump buffer. This context is used when a nonlocal goto is performed by a corresponding call to the LONGJMP_ procedure. ?SOURCE $SYSTEM.SYSTEM.HSETJMP retval := SETJMP_ ( env ); retval INT(32) ! o returned value 0D Indicates that the SETJMP_ procedure was called directly.
Procedure Calls Summary (R-Z) SETMODE Sets device-dependent functions. CALL SETMODE ( filenum ,function ,[ param1 ] ,[ param2 ] ,[ last-params ] ); filenum, INT:value input function, INT:value input param1, INT:value input param2, INT:value input last-params, INT:ref:2 output < (CCL) An error occurred (call FILEINFO). = (CCE) The SETMODE is successful. > (CCG) The SETMODE function is not allowed for this device type. Note. For more information, please see Section 11, SETMODE Operations.
Procedure Calls Summary (R-Z) < (CCL) An error occurred (call FILEINFO). = (CCE) The SETMODENOWAIT is successful. > (CCG) The SETMODENOWAIT function is not allowed for this device type. SETMYTERM (Superseded by PROCESS_SETINFO_) Permits a process to change the terminal it uses as its home terminal. CALL SETMYTERM ( terminal-name ); terminal-name, INT:ref:12 input < (CCL) The terminal cannot be reassigned, terminal-name is invalid, or terminalname is not a terminal or a named process.
Procedure Calls Summary (R-Z) 7 Set or override the closed user’s group (CUG) number to be used in the next callrequest packet. 8 Set or fetch the protocol ID field in the outgoing call-request packet. 9 Fetch the reason why circuit disconnected, and learn the current link status. 20 Reset and retrieve the called data-terminal equipment (DTE) address buffer. 21 Provide a count of the number of 64-byte segments that can be sent and received by a subdevice.
Procedure Calls Summary (R-Z) SETSYNCINFO (Superseded by FILE_SETSYNCINFO_) Is used by the backup process of a process pair to pass the process pair’s latest synchronization block to the file system. CALL SETSYNCINFO ( filenum ,sync-block ); filenum, INT:value input sync-block, INT:ref:* input < (CCL) An error occurred (call FILEINFO). = (CCE) SETSYNCINFO is successful. > (CCG) The file is not a disk file. SETSYSTEMCLOCK Changes the system clock if you are a super-group ID (255,255).
Procedure Calls Summary (R-Z) SHIFTSTRING (Superseded by STRING_UPSHIFT_) Puts all the alphabetic characters in a string in lowercase or uppercase. Nonalphabetic characters remain unchanged. CALL SHIFTSTRING ( string ,count ,casebit ); string, STRING:ref:* input, output count, INT:value input casebit, INT:value input <15> = 0 Puts the specified string in uppercase. = 1 Puts the specified string in lowercase. SIGACTION_ Note. This procedure can be called only from TNS/R native processes.
Procedure Calls Summary (R-Z) handler, PROCADDR:ref:1 input SIGACTION_RESTORE_ Note. This procedure can be called only from TNS/R native processes. Restores the signal-handling state saved by a previous call to the SIGACTION_SUPPLANT_ procedure. ?SOURCE $SYSTEM.SYSTEM.HTDMSIG error := SIGACTION_RESTORE_ ( signal-buffer ); error, INT(32) 0D -1D returned value Indicates a successful outcome. Indicates an error.
Procedure Calls Summary (R-Z) 0D -1D indicates a successful outcome indicates an error. The reason for the error is given in the errno variable: FE_EFAULT The address in signal-buffer is out of bounds. FE_EINVAL SIG_ The IGN or SIG_ERR is passed to the handler. FE_ERANGE The value of length is less than the minimum required. Use the ERRNO_GET_ procedure to obtain the value of errno in a Guardian process. handler, PROCADDR:value input signal-buffer, INT .
Procedure Calls Summary (R-Z) SIGJMP_MASKSET_ Saves a signal mask in a jump buffer that has already been initialized by the SIGSETJMP_ procedure. Note. This procedure can be called only from TNS/R native processes. ?SOURCE $SYSTEM.SYSTEM.HTDMSIG error := SIGJMP_MASKSET_ ( env ,signal-mask ); error, INT(32) 0D -1D returned value Indicates a successful outcome. Indicates an error. The reason for the error is given in the errno variable: FE_EINVAL The jump buffer has not been initialized.
Procedure Calls Summary (R-Z) SIGNAL_ SIGNAL_ is the pTAL procedure name for the C signal() function. See the $SYSTEM.SYSTEM.HSIGNAL header file for the pTAL prototype definitions. For a discussion of each parameter and procedure considerations, see the signal(3) function reference page either online or in the Open System Services Library Calls Reference Manual. Note. This procedure can be called only from TNS/R native processes. SIGNALPROCESSTIMEOUT Sets a timer based on process execution time.
Procedure Calls Summary (R-Z) param1, INT:value input param2, INT(32):value input tag, INT:ref:1 output < (CCL) SIGNALTIMEOUT cannot allocate a time-list element (TLE). = (CCE) SIGNALTIMEOUT finished successfully. > (CCG) The given timeout value is illegal. SIGPENDING_ SIGPENDING_ is the pTAL procedure name for the C sigpending() function. See the $SYSTEM.SYSTEM.HSIGNAL header file for the pTAL prototype definitions.
Procedure Calls Summary (R-Z) Indicates that the SIGSETJMP_ procedure was called directly. Indicates that SIGSETJMP_ is returning as a result of a call to the SIGLONGJMP_ procedure. The returned value is specified by SIGLONGJMP_. 0D <>0D env, INT .EXT:ref:(SIGJMP_BUF_TEMPLATE) output mask, INT(32):value input Specifies that the current signal mask is not to be saved. Specifies that the current signal mask is to be saved. This mask is reinstated by a corresponding call to the SIGLONGJMP_ procedure.
Procedure Calls Summary (R-Z) STOP (Superseded by PROCESS_STOP_) Deletes a process or a process pair and signals that the deletion was caused by a normal condition. (A STOP system message is sent to the deleted process’s creator.
Procedure Calls Summary (R-Z) 2 Parameter error. 3 Bounds error. 4 String too large to fit in out-string. in-string:length,STRING .EXT:ref:*,INT:value input:input out-string:maxlen, STRING .EXT:ref:*,INT:value output:input SUSPENDPROCESS (Superseded by PROCESS_SUSPEND_) Puts a process or process pair into the suspended state. CALL SUSPENDPROCESS ( process-id ); process-id, INT:ref:4 input < (CCL) SUSPENDPROCESS failed, or process-id does not exist.
Procedure Calls Summary (R-Z) SYSTEMENTRYPOINTLABEL Returns either the procedure label of the named entry point or a zero if no label is found. label := SYSTEMENTRYPOINTLABEL ( name ,len ); label, INT returned value name, STRING:ref:* input len, INT:value input TAKE^BREAK Enables BREAK monitoring for a file. TAKE^BREAK is a sequential I/O (SIO) procedure and can be used only with files that have been opened by OPEN^FILE.
Procedure Calls Summary (R-Z) TIME Provides the current date and time in integer form. CALL TIME ( date-and-time ); date-and-time, INT:ref:7 [0] year (yyyy). [1] month (1-12). [2] day (1-31). [3] hour (0-23). [4] minute (0-59). [5] second (0-59). [6] 0.01 sec (0-99). output TIMESTAMP Provides the internal form of the processor interval clock where the application is running.
Procedure Calls Summary (R-Z) D 1.1 + Expand E 1.1 + Expand + TMF K Ann releases L Bnn releases M Cnn releases N Dnn releases P Fnn releases Q Gnn releases <8:15> The revision number of the system in binary format UNLOCKFILE Unlocks a disk file and any records in the file that are currently locked by the caller. CALL UNLOCKFILE ( filenum ,[ tag ] ); filenum, INT:value input tag, INT(32):value input < (CCL) An error occurred (call FILEINFO). = (CCE) UNLOCKFILE was successful.
Procedure Calls Summary (R-Z) UNPACKEDIT Converts a line image from EDIT packed line format into unpacked format. UNPACKEDIT is an IOEdit procedure and can be used only with files that have been opened by OPENEDIT or OPENEDIT_. UNPACKEDIT ( packed-line ,packed-length ,unpacked-line ,unpacked-limit ,unpacked-length ,[ spacefill ] ,[ full-length ] ); packed-line, STRING .EXT:ref:* input packed-length, INT:value input unpacked-line, STRING .
Procedure Calls Summary (R-Z) error, INT returned value 0 No error. 13 Invalid termname parameter. 22 Parameter out of bounds. An input parameter is not within the valid range, or return information does not fit into the length of the space provided, or an output parameter overlays the stack marker that was created by calling this procedure. 29 Missing parameter.
Procedure Calls Summary (R-Z) status Description 0 No status. 8 Password is valid but it is about to expire. Caller should return caution message. Values returned for error = 48: status Description 1 User does not exist or password is incorrect. 2 Cannot authenticate with Guardian user ID because options bit 12 is set to 1. 3 $CMON rejected logon. 5 Authentication record frozen. 6 Authentication record expired. 10 Password expired: user cannot log on.
Procedure Calls Summary (R-Z) Values returned for error = 70: status Description 4 Caller should set inputtext to a password in the next call to USER_AUTHENTICATE_ to either log on or begin a password change. 9 Caller should set inputtext to a password in the next call to USER_AUTHENTICATE_ to change the password. 11 Caller must set inputtext to a password in the next call to USER_AUTHENTICATE_ to change the password, because the password has expired but the grace period is in effect.
Procedure Calls Summary (R-Z) USER_GETINFO_ Returns the default attributes of the specified user. The user can be identified by user name; by Guardian user ID; or, if Safeguard is running, by alias.
Procedure Calls Summary (R-Z) initdir-len, INT .EXT:ref:1 output initprog:initprog-maxlen, STRING .EXT:ref:*,INT:value output:input initprog-len, INT .EXT:ref:1 output default-security, INT .
Procedure Calls Summary (R-Z) 22 Parameter out of bounds. An input parameter is not within the valid range, or return information does not fit into the length of the space provided, or an output parameter overlays the stack marker that was created by calling this procedure. 29 Missing parameter. This procedure was called without specifying all the parameters. 590 Bad parameter value.
Procedure Calls Summary (R-Z) <0:3> Unused. <4:6> Read. <7:9> Write. <10:12> Execute. <13:15> Purge. 0 = A (any local user). 1 = G (any local group member). 2 = O (only the local owner). 3 = not used. 4 = N (any network user). 5 = C (any network group/community user). 6 = U (only the network owner). 7 = - (only the local super ID (255,255)). < (CCL) A required parameter is missing, a buffer is out of bounds, or an I/O error occurred on the user ID file ($SYSTEM.SYSTEM.
Procedure Calls Summary (R-Z) USERNAMETOUSERID (Superseded by USER_GETINFO_) Returns the user ID, from $SYSTEM.SYSTEM.USERID, that is associated with a designated user name. CALL USERNAMETOUSERID ( name-id ); name-id, INT:ref:8 input, output < (CCL) The value of name-id is out of bounds, or an I/O error occurred in the $SYSTEM.SYSTEM.USERID file. = (CCE) The designated user ID returned. > (CCG) The specified user name is undefined.
Procedure Calls Summary (R-Z) user-name-or-id, INT:ref:12 input logon, INT:value input 0 Verify the user but do not log on. <> 0 Verify the user and log on. default, INT:ref:18 [0:3] = Group name, blank-filled. [4:7] = User name, blank-filled. [8] = Group ID. = User ID. <0:7> <8:15> output [9:12] = Default volume, blank-filled. [13:16] = Default subvolume, blank-filled. [17].<0:15> = Default file security, as follows: <0:3> <4:6> <7:9> <10:12> <13:15> = Unused. = Read. = Write.
Procedure Calls Summary (R-Z) WAIT^FILE Waits or checks for the completion of an outstanding I/O operation. WAIT^FILE is a sequential I/O (SIO) procedure and can be used only with files that have been opened by OPEN^FILE. error := WAIT^FILE ( file-fcb ,[ count-read ] ,[ time-limit ] ); error, INT returned value 0 No error. 1 End of file. 6 System message (only if user requested system messages through SET^SYSTEMMESSAGES or SET^SYSTEMMESSAGESMANY).
Procedure Calls Summary (R-Z) filenum, INT:value input buffer, input INT:ref:* (Use with WRITE) STRING .EXT:ref:* (Use with WRITEX) write-count, INT:value input count-written, output INT:ref:1 (Use with WRITE) INT .EXT:ref:* (Use with WRITEX) tag, INT(32):value input < (CCL) An error occurred (call FILEINFO). = (CCE) The WRITE[X] is successful. WRITE^FILE Writes a file sequentially. The file must be open and have write or read/write access.
Procedure Calls Summary (R-Z) WRITEEDIT Accepts a line in unpacked format, converts it into EDIT packed line format, and writes it to the specified file. WRITEEDIT is an IOEdit procedure and can only be used with files that have been opened by OPENEDIT or OPENEDIT_. error := WRITEEDIT ( filenum ,[ record-number ] ,unpacked-line ,unpacked-length ,[ full-length ] ,[ new-record-number ] ); error, INT returned value 10 File already includes a line with the specified record number.
Procedure Calls Summary (R-Z) WRITEEDITP Accepts a line in EDIT packed line format and writes it to the specified file. WRITEEDITP is an IOEdit procedure and can be used only with files that have been opened by OPENEDIT or OPENEDIT_. error := WRITEEDITP ( filenum ,[ record-number ] ,packed-line ,packed-length ); error, INT returned value 10 File already includes a line with the specified record number. 45 All of the file’s possible extents are allocated and full.
Procedure Calls Summary (R-Z) filenum, INT:value input buffer, input, output INT:ref:* (Use with WRITEREAD) STRING .EXT:ref:* (Use with WRITEREADX) write-count, INT:value input read-count, INT:value input count-read, output INT:ref:1 (Use with WRITEREAD) INT .EXT:ref:1 (Use with WRITEREADX) tag, INT(32):value input < (CCL) An error occurred (Call FILEINFO). = (CCE) The WRITEREAD[X] is successful. > (CCG) CNTRL-Y is pressed on the terminal.
Procedure Calls Summary (R-Z) INT:ref:1 (Use with WRITEUPDATE) INT .EXT:ref:1 (Use with WRITEUPDATEX) tag, INT(32):value input < (CCL) An error occurred (call FILEINFO). = (CCE) WRITEUPDATE[X] was successful. WRITEUPDATEUNLOCK[X] Performs random processing of records in a disk file. This procedure operates only on Guardian objects.
Procedure Calls Summary (R-Z) XBNDSTEST (Superseded by REFPARAM_BOUNDSCHECK_) Checks stack limits and/or parameter addresses. status := XBNDSTEST ( param ,bytelen ,flags ,constants ); status, INT returned value 1 In bounds, but in a read-only segment or (on TNS/R systems only) in the system library. 0 In bounds and writable. -1 Out of bounds or illegal address. -2 Incorrectly aligned on word boundary. -3 Undefined flag value.
Procedure Calls Summary (R-Z) XSTACKTEST (Superseded by HEADROOM_ENSURE_) Checks stack limits, ensures that adequate stack space is available, and returns a set of constants to be used with the XBNDSTEST procedure. status := XSTACKTEST ( firstparm ,stackwords ,flags ,constants ); status, INT returned value 0 Adequate stack space available. 2 Undefined flags value. 21 The value of stackwords is less than 1. 22 Bounds error on firstparm or constants. 632 Insufficient stack space available.
Procedure Calls Summary (R-Z) Guardian Programming Reference Summary for pTAL and TAL —522631-001 8- 56
9 CONTROL Operations For additional information about the CONTROL procedure call, refer to the Guardian Procedure Calls Reference Manual. Table 9-1.
CONTROL Operations Table 9-1.
CONTROL Operations Table 9-2. CONTROL Operations 2 - 27 Operation Description Description of 2 Write end of file on unstructured disk or magnetic tape (if disk, write access is required). A write end of file (EOF) to an unstructured disk file sets EOF to point to the relative byte address indicated by the next-record pointer and writes the new EOF setting in the file label on disk. If this new EOF setting is out of bounds, EOF is set to the last possible position.
CONTROL Operations Table 9-2. CONTROL Operations 2 - 27 Operation Description Description of 21 Disk, allocate or deallocate extents (write access is required). 0: deallocate all extents past the end-of-file extent 1: maximum-extents number of extents to allocate for a nonpartitional file (for DP2 disk files only) 1:16* number of partitions number of extents to allocate for a partitioned file 22 Cancel an AM3270 I/O operation. None 24 Magnetic tape, force end-of-volume (EOV).
10 SET^FILE Operations For additional information about the SET^FILE procedure call, refer to the Guardian Procedure Calls Reference Manual. Table 10-1. SET^FILE Operations That Set Values Description of Operation Requested new-value Parameter Entered (Optional) old-value Parameter Entered (Optional) State of File ASSIGN^ BLOCK BUFLEN or ASSIGN^ BLOCK LENGTH Specifies the block length, in bytes, for the file. newblocklen blocklen Closed ASSIGN^ FILECODE Specifies the file code for the file.
SET^FILE Operations Table 10-1. SET^FILE Operations That Set Values Parameter (Required) Description of Operation Requested new-value Parameter Entered (Optional) old-value Parameter Entered (Optional) State of File ASSIGN^ SECEXT or ASSIGN^ SECONDARY EXTENTSIZE Specifies the secondary extent size (in units of 2048-byte blocks) for the file. new-secext-size sec-extsize Closed INIT^FILEFCB Specifies that the file FCB be initialized.
SET^FILE Operations Table 10-1. SET^FILE Operations That Set Values Parameter (Required) Description of Operation Requested new-value Parameter Entered (Optional) old-value Parameter Entered (Optional) State of File SET^ BREAKHIT Sets or clears break hit for the file. This is used only if the user is handling BREAK independently of the SIO procedures, or if the user has requested BREAK system messages through SET^SYSTEMMESSAGES or SET^SYSTEMMESSAGES MANY.
SET^FILE Operations Table 10-1. SET^FILE Operations That Set Values Parameter (Required) Description of Operation Requested new-value Parameter Entered (Optional) old-value Parameter Entered (Optional) State of File SET^ERROR Sets file-system error code value for the file. This is used only if nowait I/O is in effect and the user makes the call to AWAITIO for the file. This is the error parameter value returned from FILEINFO.
SET^FILE Operations Table 10-1. SET^FILE Operations That Set Values Parameter (Required) Description of Operation Requested new-value Parameter Entered (Optional) old-value Parameter Entered (Optional) State of File SET^ RCVUSER OPENREPLY Sets user-will-reply for the $RECEIVE file. This is used if the SIO procedures are to maintain the opener's directory, thereby limiting opens to a single process or a process pair but keeping the option to reject opens.
SET^FILE Operations Table 10-1. SET^FILE Operations That Set Values Parameter (Required) Description of Operation Requested new-value Parameter Entered (Optional) old-value Parameter Entered (Optional) State of File SET^SYSTEM MESSAGES Sets system message reception for the $RECEIVE file. Setting a bit in the sys-msg-mask indicates that the corresponding message is to pass back to the user. Default action is for the SIO procedures to handle all system messages. sys-msg-mask [0] .
SET^FILE Operations Table 10-1. SET^FILE Operations That Set Values Parameter (Required) Description of Operation Requested new-value Parameter Entered (Optional) old-value Parameter Entered (Optional) State of File SET^TRACE BACK Sets or clears the traceback feature. When traceback is active, the SIO facility appends the caller's P-relative address to all error messages. new-state old-state SET^ USERFLAG Sets user flag for the file.
SET^FILE Operations Table 10-2. SET^FILE Operations That Set Addresses Parameter (Required) Description of Operation Requested Parameter Entered (Optional) Parameter Entered (Optional) State of File ASSIGN^ FILENAME Specifies the physical name of the file to be opened. For example: CALL SET^FILE (in^file, ASSIGN^FILENAME,@in^ filename); @filename filename FOR 12 words Closed ASSIGN^ LOGICAL FILENAME Specifies the logical name of the file to be opened.
SET^FILE Operations Table 10-2. SET^FILE Operations That Set Addresses Parameter (Required) Description of Operation Requested Parameter Entered (Optional) Parameter Entered (Optional) State of File SET^ OPENERS PHANDLE Sets the allowable opener’s processhandle for $RECEIVE file. This is used to restrict the openers of this process to a specified process. A typical example is using the SIO procedures to read the startup message.
SET^FILE Operations Table 10-2. SET^FILE Operations That Set Addresses Parameter (Required) Description of Operation Requested SET^SYSTEM MESSAGES MANY Sets system message reception for the $RECEIVE file. sys-msg-maskwords is a four-word mask. Setting a bit in sys-msgmask-words indicates that the corresponding message is to pass back to the user. Default action is for the SIO procedures to handle all system messages. SET^SYSTEM MESSAGES MANY (continued: word 0) sys-msg-mask-words[0] .
SET^FILE Operations Table 10-2. SET^FILE Operations That Set Addresses Parameter (Required) Description of Operation Requested SET^SYSTEM MESSAGES MANY (continued: word 1) sys-msg-mask-words[1] .<0:3> = unused .<4> = BREAK message .<5> = unused .<6> = tme signal message (NonStop II systems only) .<7> = memory lock completion message (NonStop II systems only) .<8> = memory lock failure message (NonStop II systems only) .<9:13> = unused .<14> = open message .
SET^FILE Operations Guardian Programming Reference Summary for pTAL and TAL —522631-001 10 -12
11 SETMODE Operations For additional information about the SETMODE procedure call, refer to the Guardian Procedure Calls Reference Manual. function Parameters and Effect 1 Disk: Set file security param1 <0> = 1 for program files only, sets accessor's ID to program file's ID when program file is run (PROGID option). <1> = 1 sets CLEARONPURGE option to on. This means that all data in the file is physically erased from the disk (set to zeros) when the file is purged.
SETMODE Operations function Parameters and Effect 3 Disk: Set write verification param1.<15> = 0 verified writes off (default). = 1 verified writes on. The param2 parameter is used with DP2 disk files only. param2 = 0 change the open option setting of the verify writes option (default). = 1 change the file label default value of the verify writes option.
SETMODE Operations function Parameters and Effect 5 Line printer: Set system automatic perforation skip mode (assumes standard VFU function in channel 2) param1.<15> = 0 off, 66 lines per page = 1 on, 60 lines per page (default) For the 5530 line printer: param1 = 0 disable automatic perforation skip. = 1 enable automatic perforation skip (default). The value of param2 is not used with function 5.
SETMODE Operations function Parameters and Effect 11 Terminal: Set break ownership param1 = 0 means BREAK disabled (default setting). = any positive value means enable BREAK. Terminal access mode after BREAK is typed: param2 = 0 normal mode (any type file access is permitted) = 1 BREAK mode (only BREAK-type file access is permitted) Refer to the discussion of “Communicating With Terminals” in the Guardian Programmer’s Guide. 12 Terminal: Set terminal access mode param1.
SETMODE Operations function Parameters and Effect 18 Terminal: Set statistics threshold, flag fill, and window size 19 Terminal: Set transaction parameters and set extended control field size 20 Terminal: Set system echo mode (default is configured) param1.<15> = 0 system does not echo characters as read = 1 system echoes characters as read The param2 parameter is not used with function 20. Note. SETMODEs 15, 16, 17, 18 and 19 are described in the EnvoyACP/XF Reference Manual.
SETMODE Operations Parameters and Effect 22 Line printer (subtype 3, 4, 6, and 32) or terminal: Set baud rate param1 = 0 baud rate = 50 1 baud rate = 75 2 baud rate = 110 3 baud rate = 134.
SETMODE Operations Parameters and Effect 22 (continued) You can specify split baud rates with the LIU-4 controller as follows. Note that the values for param1 all have bit 0 set to 1: param1 = 128 TX baud rate = 50 129 TX baud rate = 75 130 TX baud rate = 110 131 TX baud rate = 134.
SETMODE Operations Parameters and Effect 23 Terminal: Set character size param1 = 0 character size = 5 bits 1 character size = 6 bits 2 character size = 7 bits 3 character size = 8 bits The param2 parameter is not used with function 23. 24 Terminal: Set parity generation by system param1 = 0 parity = odd 1 parity = even 2 parity = none The param2 parameter is not used with function 24.
SETMODE Operations Parameters and Effect 29 Line printer (subtype 3, 4, 6, or 32): Set automatic answer mode or control answer mode. param1.<15> = 0 CTRLANSWER = 1 AUTOANSWER (default) The default mode is what was specified at SYSGEN; if no mode is specified at SYSGEN, then AUTOANSWER is used. The param2 parameter is not used with function 29. Note: SETMODE function 29 remains in effect even after the file is closed. SETMODE 29 is the only SETMODE function not affected by a SETMODE 28.
SETMODE Operations Parameters and Effect 32 Set X.25 call setup parameters param1 .<0> = 0 do not accept charge. = 1 accept charge. .<1> = 0 do not request charge. = 1 request charge. .<2> = 0 is normal outgoing call. = 1 is priority outgoing call. .<8:15>= port number (0-99) 33 To determine the actual value for port number, refer to specifications on your own network.
SETMODE Operations Parameters and Effect 37 Line printer (subtype 1, 4, 5, or 6): Get device status The param1 parameter is not used with function 37. The param2 parameter is not used with function 37. last-params = status of device Status values are: last-params for printer (subtype 1 or 5) (only last-params [0] is used) All other bits are undefined. .<5> = DOV, data overrun 0 = no overrun 1 = overrun occurred .<7> = CLO, connector loop open 0 = not open 1 = open (device unplugged) .
SETMODE Operations Parameters and Effect 37 (continued) last-params for printer (subtype 4) last-params [0] = primary status returned from printer: .<9:11> = full status field 0 = partial status 1 = full status 2 = full status / VFU fault 3 = reserved for future use 4 = full status / data parity error 5 = full status / buffer overflow 6 = full status / bail open 7 = full status / auxiliary status available .<12> = buffer full 0 = not full 1 = full .<13> = paper out 0 = OK 1 = paper out .
SETMODE Operations Parameters and Effect 37 (continued) Primary status bits are: [0].<0:8> = 0 undefined .<9> = 1 reserved .<10:12> = 0 no faults = 1 printer idle = 2 paper out = 3 end of ribbon = 4 data parity error = 5 buffer overflow = 6 cover open = 7 auxiliary status available .<13> = 0 buffer not full = 1 buffer full .<14> = 0 OK = 1 device power on error .<15> = 0 OK = 1 device not ready If primary status last-params [0].<10:12> = 7, auxiliary status word is: [1].<0:7>= undefined .
SETMODE Operations Parameters and Effect 38 Terminal: Set special line-termination mode and character param1 =0 sets special line-termination mode. The value of param2 is the new linetermination character. The line-termination character is not counted in the length of a read. No system-supplied carriage return or line feed is issued at the end of a read (see note on cursor movement below). =1 sets special line-termination mode.
SETMODE Operations Parameters and Effect 50 Enable/disable 3270 COPY param1= = 0 suppress COPY = 1 allow COPY 51 Get/set 3270 status param1 status flags mask to set The param2 parameter is not used with function 51. Refer to the Device-Specific Access Methods–AM3270/TR3271 manual for the flags mask information. 52 Tape drive: Set short write mode param1 = 0 allow writes shorter than 24 bytes; a record shorter than 24 bytes is padded with zeros to a length of 24 bytes (default).
SETMODE Operations Parameters and Effect 57 Disk: Set serial writes option param1 = 0 system automatically selects serial or parallel writes (default). = 1 change the file label default value of the serial writes option. The param2 parameter is used with DP2 disk files only. param2 = 0 change the open option setting of the serial writes option (default). = 1 change the file label default value of the serial writes option.
SETMODE Operations Parameters and Effect 72 Force system buffering for nowait files param1 = 1 force use of intermediate buffer in PFS for read operations. (Nowait write operations always require the data to remain unchanged until completion of the information. = 0 allow the system to make transfers directly from user buffers. The default value for files opened by FILE_OPEN_ is 0; for files opened by OPEN, it is 1. The param2 parameter is not used and its value should be zero if supplied.
SETMODE Operations Parameters and Effect 91 Disk: Set cache and sequential option (Function 91 is not applicable for alternate-key files.) param1 = 0 system managed (default). DP2 will detect sequential access; when detected, it will set LRU access to sequential and perform key-sequenced sequential splits. = 1 direct I/O, bypass disk cache. = 2 random access, LRU-chain buffer. = 3 sequential access, reuse buffer. Directs DP2 to set cache.
SETMODE Operations Parameters and Effect 95 Disk: Flush dirty cache buffers The param1 parameter is not used with function 95. The param2 parameter is not used with function 95.
SETMODE Operations Parameters and Effect 110 Set Shift In/Shift Out (SISO) code extension technique for an individual subdevice Note: SETMODE 110 is supported in AM6520 for CRT protocol when used for 6530 terminals, ITI protocol for 6530 terminals, and PRT protocol for 5520 printers. param1 = 0 disable SISO (default setting) = 1 enable SISO Theparam2 parameter is not used with function 110.
SETMODE Operations Parameters and Effect 117 Process files: Set TRANSID forwarding param1 = 0 normal mode (default for process subtypes other than 30 and 31): If a transaction identifier is in effect at the time of a write, read, or writeread on the process file, it is sent with the request so that the receiver will operate under the transaction.
SETMODE Operations Parameters and Effect 141 DP2 disk file: Enable/disable large transfers param1 = 1 enable large transfers = 0 disable large transfers (This is the default value when the file is opened.) The param2 parameter is not used with function 141. Thelast-params parameter [0] contains the previous setting of the large transfer mode flag. Thelast-params parameter [1] if param1 is 1, this contains the value of the file's broken flag after the cache has been flushed.
SETMODE Operations Parameters and Effect 141 (continued) If the file is audited and structured, the file must be opened with an access mode of read-only. The exclusion mode can be shared, protected, or exclusive. If the exclusion mode is shared, updates done by other openers of the file might not be seen by this opener. If the file is audited and unstructured, only read operations can be performed on the file after this SETMODE is issued with param1 set to 1.
SETMODE Operations Parameters and Effect 141 (continued) The length of the transfer cannot be more than 57,344 bytes. The length must be a multiple of 2K bytes. Although up to 56K bytes are transferred to the disk process in one operation, the actual transfer to the disk might not be 56K bytes at once. The disk process must do the actual data transfer to the disk in smaller pieces if more than one file extent is crossed or the controller is not a 3107 or 3108.
SETMODE Operations Parameters and Effect 144 Sets LU character set and double-byte character code Theparam1 parameter must be omitted for function 144. Theparam2 parameter must be omitted for function 144. last-params [0].<0> = 0 no translation =1SNAX does EBCDIC/ASCII translation .<1:7>=IBM device type 1=IBM-3277 2=not 3277 or 3276 3=IBM-3276 .<8:15>=value of LU attribute ALLOWEDMIX [1].<0:7>=LU character set 0=ASCII (USASCII) 9=EBCDIC (IBM EBCDIC) 14 =KATAKANA EBCDIC .
SETMODE Operations Parameters and Effect 152 Disk: Skip cache flushing when closing nonaudited file (C30.00 and later releases only) param1 .<15> = 1 for nonaudited disk files, causes the cache not to be flushed when the file is closed unless the close is either for the last open with write access or for the last open with a nonzero sync-depth value. = 0 disables the effect of SETMODE 152 with param1 = 1. The param2 parameter is not used with function 152. If it is supplied, it must be 0.
SETMODE Operations Parameters and Effect 163 SNAX:Enhanced CDI mode param1 = 0 enables normal mode (disables all enhanced CDI support). = 1 enables enhanced CDI mode. = 2 enables special WRITEREAD mode (allows applications to determine the setting of CDI by using the WRITEREAD procedure; using WRITEREAD causes the outbound data buffer to be sent with CDI enabled). The param2 parameter is not used with function 163.
SETMODE Operations Parameters and Effect 260 Printer: Enable PostScript printing param1 = 1 The FASTP print process sends the PCL command to switch the printer to PostScript mode. At the end of the job and before the next job prints, the printer is returned to PCL mode. = 0 The FASTP print process sends the PCL command to switch the printer back to PCL mode. The param2 parameter is not used with function 260. Function 260 applies only to 5577 printers.
12 Completion Codes For a more detailed description of the completion codes, refer to the Guardian Procedure Calls Reference Manual. Completion Code Definition 0 Normal, voluntary termination with no errors. 1 Normal, voluntary termination with WARNING diagnostics. 2 Abnormal, voluntary termination with FATAL errors or diagnostics. 3 Abnormal, voluntary, but premature termination with FATAL errors or diagnostics. 4 A process associated with a RUN statement never started.
Completion Codes Completion Code Definition -7 An OSS process terminated as a result of a corrupted stack frame or register state. -8 An OSS process terminated because of insufficient user stack space for signal recovery. -9 An OSS process terminated because of insufficient PRIV stack space for signal recovery. -10 An OSS process terminated because it was unable to obtain resources for signal delivery. -11 An OSS process terminated because it attempted to resume from a nonresumable signal.
13 Traps For a more detailed description of the traps, refer to the Guardian Procedure Errors and Messages Manual.
Traps Guardian Programming Reference Summary for pTAL and TAL —522631-001 13- 2
14 Interprocess Messages Interprocess Command Interpreter Messages For a complete description of the command interpreter interprocess messages, refer to the Guardian Programmer’s Guide. Unless otherwise specified, file name are in internal (expanded) format. Note that the user ID of a user who is logged off is 0 and the user ID of the null user (0.0) is 0.
Interprocess Messages -2 ASSIGN STRUCT ci^assign; BEGIN INT msg^code; STRUCT logicalunit; BEGIN STRING prognamelen; STRING progname[0:30]; STRING filenamelen; STRING filename[0:30]; END; INT(32) fieldmask; STRUCT physicalunit; BEGIN INT volume [0:3]; INT subvol [0:3]; END; INT primaryextent; INT secondaryextent; INT filecode; INT exclusionspec; INT accessspec; INT recordsize; INT blocksize; END; ! ! ! ! ! ! ! ! word [0] -2 target program name target file specifier [1] program name byte length program na
Interprocess Messages -3 PARAM STRUCT ci^param; BEGIN INT msg^code; ! [0] -3 INT numparams; ! [1] number of parameters STRING parameters [0:1023] ! [2] parameters END; The field “parameters” in the above message format is composed of “numparams” records of the following form (offsets are given in bytes): param[0] = length n, in bytes, of parameter-name param[1] for n = parameter-name param[n+1] = length v, in bytes, of parameter-value param[n+2] for v = parameter-value -20 WAKEUP STRUCT wakeup^msg
Interprocess Messages -51 LOGOFF STRUCT logoff^msg; BEGIN INT msgcode; INT userid; INT cipri; INT ciinfile [0:11]; INT cioutfile [0:11]; END; ! ! ! ! ! [0] -51 [1] user’s logon ID [2] TACL execution priority [3] TACL input file [15] TACL output file ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! [0] -52 [1] user’s logon ID [2] TACL execution priority [3] TACL input file [15] TACL output file [27] internal format program file name [39] PRI parameter default: 0 [40] CPU parameter default: 0 [41] IN parameter file
Interprocess Messages -54 ADD USER STRUCT adduser^msg; BEGIN INT msgcode; INT userid; INT cipri; INT ciinfile [0:11]; INT cioutfile [0:11]; INT groupname [0:3]; INT username [0:3]; INT group^id; INT user^id; END; ! ! ! ! ! ! ! ! ! [0] -54 [1] user’s logon ID [2] TACL execution priority [3] TACL input file [15] TACL output file [27] new user group name [31] new user user name [35] new user group number [36] new user user number ! ! ! ! ! ! [0] -55 [1] user’s logon ID [2] TACL execution priority [3] TACL
Interprocess Messages -57 PASSWORD STRUCT password^msg; BEGIN INT msgcode; INT userid; INT cipri; INT ciinfile [0:11]; INT cioutfile [0:11]; END; ! ! ! ! ! [0] -57 [1] user’s logon ID [2] TACL execution priority [3] TACL input file [15] TACL output file ! ! ! ! ! ! ! [0] -58 [1] user’s logon ID [2] TACL execution priority [3] TACL input file [15] TACL output file [27] remote password for this system ! ! ! ! ! ! ! ! ! [0] -59 [1] user’s logon ID [2] TACL execution priority [3] TACL input file [15] TAC
Interprocess Messages -60 CONFIGURATION STRUCT config^msg; BEGIN INT msgcode; INT userid; INT cipri; INT ciinfile [0:11]; INT cioutfile [0:11]; END; ! ! ! ! ! [0] -60 [1] user’s logon ID [2] TACL execution priority [3] TACL input file [15] TACL output file Guardian Programming Reference Summary for pTAL and TAL —522631-001 14- 7
Interprocess Messages Interprocess System Messages For a complete description of the interprocess messages, refer to the Guardian Procedure Errors and Messages Manual.
Interprocess Messages -21 3270 DEVICE STATUS RECEIVED Word Description sysmsg[0] -21 sysmsg[1] Response ID sysmsg[2] Actual TR3271 status bytes, in which the sense byte is <0:7> and the status byte is <8:15> sysmsg[3] Translation of the device status to status bits; the application might pass this word directly to TR3271 by way of SETMODE 51 to post the status on a TR3271 subdevice.
Interprocess Messages -32 PROCESS CONTROL Word Description sysmsg[0] -32 sysmsg[1] Operation for CONTROL sysmsg[2] Operation parameter for CONTROL -33 PROCESS SETMODE Word Description sysmsg[0] -33 sysmsg[1] Function for SETMODE or SETMODENOWAIT sysmsg[2] Function parameter 1 for SETMODE or SETMODENOWAIT sysmsg[3] Function parameter 2 for SETMODE or SETMODENOWAIT If the receiving process can handle requests for last parameter information (by setting param1.
Interprocess Messages -37 PROCESS SETPARAM Word Description sysmsg[0] -37 sysmsg[1] Function parameter for SETPARAM sysmsg[2] Flags word: .<14> 1 if parameter array was supplied .
Interprocess Messages -101 PROCESS DELETION Word Description sysmsg[0] -101 sysmsg[1] for 10 Process phandle of terminated process sysmsg[11] for 4 Process processor time in microseconds (a FIXED value) sysmsg[15] Process job ID; 0 if the process is not part of a job sysmsg[16] Completion code sysmsg[17] Termination information (0 if none supplied) sysmsg[18] for 4 SPI subsystem organization name sysmsg[22] SPI subsystem number sysmsg[23] SPI subsystem version sysmsg[24] for 10 Process
Interprocess Messages Word Description sysmsg[15] Length of process descriptor of new process in bytes sysmsg[16] for 4 Reserved sysmsg[20] for n Process descriptor of new process of length sysmsg[15] -103 PROCESS OPEN Word Description sysmsg[0] -103 sysmsg[1] Access mode (access FILE_OPEN_ parameter) sysmsg[2] Exclusion mode (exclusion FILE_OPEN_ parameter) sysmsg[3] Nowait depth (from the nowait FILE_OPEN_ parameter) sysmsg[4] Sync depth (sync-or-receive-depth FILE_OPEN_ parameter) sy
Interprocess Messages Word Description sysmsg[30] for n The qualifier portion of the name used to open the process, in external form (for example, “#PORT2.CTL”). The length of this item is in sysmsg[18]. It is zero length if no qualifier was given. sysmsg[ ] for n For a named opener, this is the process name in external process descriptor form (system, name, and sequence number). If the opening process is unnamed, the length is zero.
Interprocess Messages -107 SUBORDINATE NAME INQUIRY Word Description sysmsg[0] -107 sysmsg[1] Flags: .<15> Skip if same; if set and the start name given below exists, skip it and return the following name. If equal to 0, return the start name if it exists. .
Interprocess Messages Word Description sysmsg[3] for 5 Information (device type, and so on) having the same layout as that of the entityinfo parameter of FILENAME_FINDNEXT_. If sysmsg[2] <> 0, the value of this field is undefined.
Interprocess Messages -113 REMOTE CPU UP Word Description sysmsg[0] -113 sysmsg[1] for 2 Node identifier sysmsg[3] processor number sysmsg[4] Length of node name in bytes sysmsg[5] for 3 Reserved sysmsg[8] for n Node name (including the backslash “\”) -141 PROCESS SPAWN Word Description sysmsg[0] -141 sysmsg[1] for 13 Reserved sysmsg[14] for 2 nowait-tag supplied to PROCESS_SPAWN_ sysmsg[16] for 2 ZSYS-DDL-PROCESSRESULTS.
Interprocess Messages -147 CONFIG GETINFO (G-Series Only) Word Description sysmsg[0] -147 sysmsg[1] Message version (must be equal to ZSYS-VAL-SMSG-CONFIGINFO-VERS) sysmsg[2] for 4 Device name for which configuration info is needed; blankfilled (can be all blanks) sysmsg[6] for 4 Subdevice name; blank-filled (can be all blanks) sysmsg[10] for 4 Secondary subdevice name qualifier; blank-filled (can be all blanks) Guardian Programming Reference Summary for pTAL and TAL —522631-001 14 -18
15 Error Codes This section contains a list of error codes that are returned by Guardian procedure calls and the file system. For a full description of the error codes, refer to the Guardian Procedure Errors and Messages Manual.
Error Codes Code Description 25 AWAITIO or CANCEL was attempted on a wait file 26 AWAITIO or CANCEL was attempted on a file with no outstanding operations 27 WAIT operation attempted when outstanding requests pending 28 Number of outstanding NOWAIT operations would exceed that specified, or attempt to open a disk file or $RECEIVE with maximum number of concurrent operations greater than 1, or attempt to add more than the configured maximum subdevices for an I/O process 29 Missing parameter 30
Error Codes Code Description 56 I/O error on volume label 57 Disk free space table is full 58 Disk free space table is marked bad 59 File is bad 60 File resides on removed volume, device downed or not open, or server has failed and been replaced by a different process with the same name since it was opened 61 No more file opens permitted on this volume or device 62 Volume has been mounted, but mount order has not been given, file open not permitted 63 Volume has been mounted and mount is i
Error Codes Code Description 89 Remote device has no buffer available 90 Transaction aborted by system because its parent process died 91 Transaction aborted by system due to database ID inconsistency 92 Distributed transaction aborted by system due to network partition 93 Transaction spanning too many audit files aborted by system 94 Transaction aborted by operator command 95 Transaction aborted because of disk process takeover by BACKUP 96 Transaction aborted because it exceeded the AUTO
Error Codes Code Description 132 Seek incomplete from disk 133 Access not ready on disk 134 Address compare error on disk 135 Write protect violation with disk 136 Unit ownership error (dual-port disk) 137 Controller buffer parity error 138 Interrupt overrun 139 Controller error 140 Modem error (communication link not yet established, modem failure, momentary loss of carrier, or disconnect) or FOX link to an EXPAND line handler is down 148 Invalid read or write from/to an optical disk
Error Codes Code Description 169 WACK received on line bid or auto-call unit set “abandon call and retry” or station disabled or station not defined 170 No ID sequence received during circuit assurance mode or invalid MCW entry number on write 171 No response received on bid/poll/select, or reply invalid 172 Reply not proper for protocol 173 Maximum allowable NAKs received (transmission error) or invalid MCW on write or invalid request ID 174 WACK received or CLB frame aborted 175 Incorrect
Error Codes Code Description 211 Processor performing operation failed during operation 213 Channel data parity error 214 Channel timeout 215 I/O attempted to absent memory page 216 Memory breakpoint encountered during this I/O 217 Memory parity error during this I/O 218 Interrupt timeout 219 Illegal device reconnect 220 Protect violation 221 Controller handshake violation 222 Bad channel status from EIO instruction 223 Bad channel status from IIO instruction 224 Controller error
Error Codes Code Description 561 The system did not recognize an item code in a list 563 Buffer too small 564 The system detected an operation that is not allowed for this file type 565 Illegal request 566 Illegal reply 567 DEFINE used is incompatible for use with target system’s TOS version 573 Requested process handle cannot be returned 578 The block size specified is too large 579 The record size specified is too large for the given block size, file type, and format 580 An open fail
Error Codes Code Description 5002 Creation of logical file rejected pending deletion of volume from storage pool. (device type: 3.36, 25.0, or 52.0) 5007 SMF access violation: insufficient SMF-privilege to access file. (device type: 3.36, 25.0, or 52.0) 5010 An error occurred during SMF lock manager processing. (device type: 3.36, 25.0, or 52.0) 5011 An error occurred during access of the ANT table. (device type: 3.36) 5012 An error occurred during access of the PENDOPS table. (device type: 3.
Error Codes Sequential I/O Error Codes Code Description 512 Invalid parameter 513 Missing file name 514 Device not supported 515 Invalid access 516 Invalid buffer address 517 Invalid file code 518 Buffer too small 519 Invalid block length 520 Invalid record length 521 Invalid EDIT file 522 File already open 523 EDITREAD or EDITREADINIT error occurred 524 File is closed; check, read, set, write, or wait error 525 Access violation 526 No stack space 527 Temporary buffer requi
Error Codes DEFINE Error Codes Code Description 0 Successful completion 2049 A syntax error occurred in the DEFINE name 2050 The DEFINE name already exists 2051 The DEFINE name does not exist 2052 Unable to obtain file-system buffer space 2053 Unable to obtain physical memory 2054 There was a bounds error in a parameter 2055 An attribute is not allowed for the current CLASS 2056 An attribute is missing 2057 Required attribute missing from current CLASS in working set 2058 Working set
Error Codes NEWPROCESS and NEWPROCESSNOWAIT Error Codes A NEWPROCESS or NEWPROCESSNOWAIT error is returned to the calling process in a word containing two 8-bit fields. The lefthand part of the error word, bits <0:7>, contains one of the error codes shown below. The righthand part, bits <8:15>, can contain either an error subcode or a file-system error code. Refer to the Guardian Procedure Errors and Messages Manual for further information.
Error Codes 28 DSC error: unable to lock the main stack of a native IOP 29 Security inheritance failure 30 Unable to allocate native globals 31 Unable to lock native globals 32 Main stack maximum value too large 33 Heap maximum value too large 34 Space guarantee value too large 35 Duplicate SRL 36 Unknown SRL specified by program 37 Unknown SRL specified by another SRL 38 Too many SRLs 39 Program file requires fixup 40 SRL requires fixups 41 Program file security violation 42 S
Error Codes PROCESS_CREATE_ Error Codes Code Description 0 No error 1 Error while accessing program file 2 Parameter error 3 Bounds violation 4 Error while accessing library file 5 Error while accessing swap file 6 Error while accessing extended swap file 7 File-system error on PFS 8 Illegal home terminal 9 I/O error on home terminal 10 Unable to communicate with system monitor process 11 Process name error 12 Illegal program file format 13 Illegal library file format 14 Unde
Error Codes Code Description 36 Child's PFS error 37 Unable to allocate global data for the process 38 Unable to lock global IOP data for the process 40 The main stack maximum value, specified either by the procedure call or by the object file, is too large. 41 The heap maximum value, specified either by the procedure call or by the object file, is too large. 42 The space guarantee value, specified either by the procedure call or by the object file, is too large.
Error Codes Code Description 104 Unable to create OSS process 106 OSS start interpreter error 107 OSS static variable error 108 Not running on an OSS system error 110 OSS current working directory error 111 OSS file descriptor dup error 112 OSS file descriptor open error 113 OSS file descriptor open timeout error 114 Cannot create OSS priv process 115 Unable to allocate global data or heap for the process (PROCESS_SPAWN_ only) 116 Unable to propagate SRL data (PROCESS_SPAWN_ only) 3
Error Codes PROCESS_GETPAIRINFO_ Error Codes Code Description 0 No error 2 Parameter error 3 Bounds error 4 Single named process 5 Caller’s pair: caller is current primary 6 Caller’s pair: caller is current backup 7 Process is unnamed 8 Search is complete 9 Process does not exist 10 Unable to communicate with node 11 Target is a process controlling a device or volume, but bit 15 was not set 13 Limited information is returned for a process that is not started Guardian Programming R
Error Codes PROCESS_SPAWN_ Open System Services (OSS) Error Codes Code Description 0 NO ERROR 4002 NO SUCH FILE OR DIRECTORY 4005 I/O ERROR 4007 ARGUMENT LIST TOO LONG 4008 EXEC FORMAT ERROR 4009 BAD FILE DESCRIPTOR 4011 NO MORE PROCESSES 4012 INSUFFICIENT USER MEMORY 4013 PERMISSION DENIED 4014 BAD ADDRESS 4020 NOT A DIRECTORY 4022 INVALID FUNCTION ARGUMENT 4126 CONNECTION TIMED OUT 4131 FILE NAME TOO LONG 4203 OSS NOT RUNNING OR NOT INSTALLED 4212 AN ERROR OCCURRED DURING
Error Codes SEGMENT_ALLOCATE_ Error Codes Code Description 0 No error 1 Error creating or opening segment swap file 2 Parameter error 3 Bounds violation 4 Illegal segment ID 5 Illegal segment size 6 Unable to allocate segment space 7 Unable to allocate segment page table space 8 Security violation 9 PIN does not exist 10 No segment allocated to PIN 11 Trying to share segment with self 12 Requested shared segment is incompatible 13 Requested segment already allocated 14 Unable
Error Codes Subsystem Programmatic Interface (SPI) Error Codes Code Description 0 No error -1 Invalid buffer format -2 Illegal parameter value -3 Missing parameter -4 Illegal parameter address -5 Buffer full -6 Invalid checksum -7 Internal error -8 Token not found -9 Illegal token code or map -10 Invalid subsystem ID -11 Operation not supported -12 Insufficient stack space -13 File-system error -14 Guardian procedure error -15 Invalid template file -16 More text is availa
Error Codes IOEdit Error Codes In addition to the error codes shown here, the IOEdit procedures can also return filesystem error codes. Some of the file-system error codes have special meanings when returned by IOEdit. Refer to the Guardian Procedure Errors and Messages Manual for details.
Error Codes Guardian Programming Reference Summary for pTAL and TAL —522631-001 15 -22
16 ASCII Character Set Character Left Right Hexadecimal Decimal Meaning NUL 000000 000000 00 0 Null SOH 000400 000001 01 1 Start of heading STX 001000 000002 02 2 Start of text ETX 001400 000003 03 3 End of text EOT 002000 000004 04 4 End of transmission ENQ 002400 000005 05 5 Enquiry ACK 003000 000006 06 6 Acknowledge BEL 003400 000007 07 7 Bell BS 004000 000010 08 8 Backspace HT 004400 000011 09 9 Horizontal tabulation LF 005000 000012 A
ASCII Character Set Character Left Right Hexadecimal Decimal Meaning RS 017000 000036 1E 30 Record separator US 017400 000037 1F 31 Unit separator SP 020000 000040 20 32 Space ! 020400 000041 21 33 Exclamation point " 021000 000042 22 34 Quotation mark # 021400 000043 23 35 Number sign $ 022000 000044 24 36 Dollar sign % 022400 000045 25 37 Percent sign & 023000 000046 26 38 Ampersand ' 023400 000047 27 39 Apostrophe ( 024000 000050 28 4
ASCII Character Set Character Left Right Hexadecimal Decimal Meaning ? 037400 000077 3F 63 Question mark @ 040000 000100 40 64 Commercial at sign A 040400 000101 41 65 Uppercase A B 041000 000102 42 66 Uppercase B C 041400 000103 43 67 Uppercase C D 042000 000104 44 68 Uppercase D E 042400 000105 45 69 Uppercase E F 043000 000106 46 70 Uppercase F G 043400 000107 47 71 Uppercase G H 044000 000110 48 72 Uppercase H I 044400 000111 49 73
ASCII Character Set Character Left Right Hexadecimal Decimal Meaning ` 060000 000140 60 96 Grave accent a 060400 000141 61 97 Lowercase a b 061000 000142 62 98 Lowercase b c 061400 000143 63 99 Lowercase c d 062000 000144 64 100 Lowercase d e 062400 000145 65 101 Lowercase e f 063000 000146 66 102 Lowercase f g 063400 000147 67 103 Lowercase g h 064000 000150 68 104 Lowercase h i 064400 000151 69 105 Lowercase i j 065000 000152 6A 106 L
17 TNS Instruction Set TNS Alphabetical List of Instructions The mnemonics and opcodes for the TNS instruction set are listed in alphabetical order in the following table. For complete information about these instructions, refer to the Himalaya S-Series Server Description Manual. TNS/R instructions are not documented in this manual. A single asterisk following an instruction description denotes a privileged instruction, and a double asterisk denotes an instruction intended for operating system use only.
TNS Alphabetical List of Instructions TNS Instruction Set Mnemonic Octal Code Description BLSS -14--- Branch if Less BNDW 000450 Bounds Test Words * BNEQ -15--- Branch if Not Equal BNOC -17--- Branch if No Carry BNOV -164-- Branch if No Overflow BOX -1-4-- Branch on X BPT 000451 Instruction Breakpoint Trap BSUB -174-- Branch to Subprocedure BTST 000007 Byte Test BUN -l04-- Branch CAQ 000262 Convert ASCII to Quad CAQV 000261 Convert ASCII to Quad with Initial Value CC
TNS Alphabetical List of Instructions TNS Instruction Set Mnemonic Octal Code Description CFIR 000310 Floating to Integer (Round) CFQ 000320 Floating to Quadrupleword CFQR 000321 Floating to Quadrupleword (Round) CID 000327 Convert Integer to Doubleword CIE 000332 Convert Integer to Extended Float CIF 000331 Convert Integer to Floating CIQ 000266 Convert Integer to Quad CLQ 000267 Convert Logical to Quad CMBX 000422 Compare Bytes Extended CMPI 001--- Compare Immediate CMRW
TNS Alphabetical List of Instructions TNS Instruction Set Mnemonic Octal Code Description DLLS 1300-- Double Logical Left Shift DLRS 1301-- Double Logical Right Shift DLTE 000054 Delete Element from List * DMPY 000222 Double Multiply DNEG 000224 Double Negate DOFS 000057 Disk Record Offset ** DPCL 000032 Dynamic Procedure Call DPF 000014 Deposit Field DSUB 000221 Double Subtract DTL 000207 Determine Time Left for Element * DTST 000031 Double Test DXCH 000005 Double Ex
TNS Alphabetical List of Instructions TNS Instruction Set Mnemonic Octal Code Description ICMP 000215 Integer Compare IDIV 000213 Integer Divide IDX1 000344 Calculate Index, 1 Dimension IDX2 000345 Calculate Index, 2 Dimension IDX3 000346 Calculate Index, 3 Dimension IDXD 000317 Calculate Index, Bounds in Data Space IDXP 000347 Calculate Index, Bounds in Code SpaceIDXP IIO 000061 Interrogate I/O * IMPY 000212 Integer Multiply INEG 000214 Integer Negate INSR 000055 Insert
TNS Alphabetical List of Instructions TNS Instruction Set Mnemonic Octal Code Description LDXI 10---- Load X Immediate LLS 0300-- Logical Left Shift LMPY 000202 Logical Multiply LNEG 000204 Logical Negate LOAD -4---- Load LOR 000011 Logical OR LQAS 000445 Load Quadrupleword via A from SG * LQX 000414 Load Quadrupleword Extended LRS 0301-- Logical Right Shift LSUB 000201 Logical Subtract LWA 000360 Load Word via A LWAS 000350 Load Word via A from System LWP -2---- L
TNS Alphabetical List of Instructions TNS Instruction Set Mnemonic Octal Code Description ORLI 0044-- OR Left Immediate ORRI 004--- OR Right Immediate ORS 000035 OR to SG Memory ORX 000047 OR to Extended Memory PCAL 027--- Procedure Call POP 124--- Pop from Stack PSEM 000076 “P” a Semaphore * PUSH 024--- Push to Stack QADD 00024 Quad Add QCMP 000245 Quad Compare QDIV 000243 Quad Divide QDWN 00025- Quad Scale Down QLD 00023- Quad Load QMPY 000242 Quad Multiply Q
TNS Alphabetical List of Instructions TNS Instruction Set Mnemonic Octal Code Description RXBL 000426 Read Extended Base and Limit * SBA 000365 Store Byte via A SBAR 00017- Subtract A from a Register SBAS 000355 Store Byte via A into System SBRA 00015- Subtract Register from A SBU 1266-- Scan Bytes Until SBW 1264-- Scan Bytes While SBX 000407 Store Byte Extended SBXX 0257--, 0267-- Store Byte Extended, Indexed SCMP 000454 Set Code Map SCPV 000463 Set Current Process Vari
TNS Alphabetical List of Instructions TNS Instruction Set Mnemonic Octal Code Description STRP 00010- Set RP SVMP 000441 Save Map Entries * SWA 000361 Store Word via A SWAS 000351 Store Word via A into System SWX 000411 Store Word Extended SWXX 0255--, 0265 Store Word Extended, Indexed SXBL 000427 Set Extended Base and Limit * TOTQ 000056 Test OUTQ ** TRCE 000217 Add Entry to Trace Table * ULKX 000431 Unlock Extended Memory * VSEM 000077 "V" a Semaphore * WIOC 000511
TNS Alphabetical List of Instructions TNS Instruction Set TNS Categorized List of Instructions The mnemonics and opcodes for the instruction set are grouped by type of instruction in the following tables. For complete information about these instructions, refer to the Himalaya S-Series Server Description Manual. A single asterisk following an instruction description denotes a privileged instruction, and a double asterisk denotes an instruction intended for operating system use only.
TNS Alphabetical List of Instructions TNS Instruction Set 32-Bit Signed Arithmetic CDI 000307 Convert Double to Integer CID 000327 Convert Integer to Double DADD 000220 Double Add DSUB 000221 Double Subtract DMPY 000222 Double Multiply DDIV 000223 Double Divide DNEG 000224 Double Negate DCMP 000225 Double Compare DTST 000031 Double Test MOND 000001 (Load) Minus One Double ZERD 000002 (Load) Zero Double ONED 000003 (Load) One Double 16-Bit Signed Arithmetic (Register Sta
TNS Alphabetical List of Instructions TNS Instruction Set Decimal Arithmetic Scaling and Rounding QUP 00025- Quadruple Scale Up QDWN 00025- Quadruple Scale Down QRND 000263 Quadruple Round Decimal Arithmetic Conversions CQI 000264 Convert Quad to Integer CQL 000246 Convert Quad to Logical CQD 000247 Convert Quad to Double CQA 000260 Convert Quad to ASCII CIQ 000266 Convert Integer to Quad CLQ 000267 Convert Logical to Quad CDQ 000265 Convert Double to Quad CAQ 000262 Conver
TNS Alphabetical List of Instructions TNS Instruction Set Floating-Point Conversions CEF 000276 Convert Extended to Floating CEFR 000277 Convert Extended to Floating, Rounded CFI 000311 Convert Floating to Integer CFIR 000310 Convert Floating to Integer, Rounded CFD 000312 Convert Floating to Double CFDR 000313 Convert Floating to Double, Rounded CED 000314 Convert Extended to Double CEDR 000315 Convert Extended to Double, Rounded CEI 000337 Convert Extended to Integer CEIR 000
TNS Alphabetical List of Instructions TNS Instruction Set Register Stack Manipulation EXCH 000004 Exchange A with B DXCH 000005 Double Exchange DDUP 000006 Double Duplicate STAR 00011- Store A in a Register NSAR 00012- Nondestructive Store A in a Register LDRA 00013- Load A from a Register LDI 100--- Load Immediate LDXI 10---- Load Index Immediate LDLI 005--- Load Left Immediate LAND 000010 Logical AND LOR 000011 Logical OR XOR 000012 Exclusive OR NOT 000013 NOT ORRI
TNS Alphabetical List of Instructions TNS Instruction Set BYTE Test BTST 000007 Byte Test Memory Stack to/from Register Stack LWP -2---- Load Word from Program LBP -2-4-- Load Byte from Program PUSH 024--- Push Registers to Memory POP 124--- Pop Memory to Registers LWXX 0254--, 0264-- Load Word Extended, Indexed SWXX 0255--, 0265-- Store Word Extended, Indexed LBXX 0256--, 0266-- Load Byte Extended, Indexed SBXX 0257--, 0267-- Store Byte Extended, Indexed LDX -3---- Load Index
TNS Alphabetical List of Instructions TNS Instruction Set Load and Store via Address on Register Stack ANS 000034 AND to SG Memory ORS 000035 OR to SG Memory ANG 000044 AND to Current Data ORG 000045 OR to Current Data ANX 000046 AND to Extended Memory ORX 000047 OR to Extended Memory LWUC 000342 Load Word from User Code Segment LWAS 000350 Load Word via A from System LWA 000360 Load Word via A SWAS 000351 Store Word via A into System SWA 000361 Store Word via A LDAS 0003
TNS Alphabetical List of Instructions TNS Instruction Set Branching BIC -10--- Branch if Carry BUN -104-- Branch Unconditionally BOX -1-4-- Branch on Index BGTR -11--- Branch if CC Greater BEQL -12--- Branch if CC Equal BGEQ -13--- Branch if CC Greater or Equal BLSS -14--- Branch if CC Less BAZ -144-- Branch if A Zero BNEQ -15--- Branch if CC Not Equal BANZ -154-- Branch if A Not Zero BLEQ -16--- Branch if CC Less or Equal BNOV -164-- Branch if no Overflow BNOC -17---
TNS Alphabetical List of Instructions TNS Instruction Set Program Register Control SETL 000020 Set L Register SETS 000021 Set S Register SETE 000022 Set ENV Register SETP 000023 Set P Register RDE 000024 Read ENV Register RDP 000025 Read P Register STRP 00010- Set Register Pointer ADDS 002--- Add to S Register CCL 000015 Set CC Less CCE 000016 Set CC Equal CCG 000017 Set CC Greater PCAL 027--- Procedure Call XCAL 127--- External Procedure Call SCMP 000454 Set Code
TNS Alphabetical List of Instructions TNS Instruction Set Input/Output RSW 000026 Read Switch Register SSW 000027 Set Switch Register EIO 000060 Execute I/O * IIO 000061 Interrogate I/O * HIIO 000062 High-Priority Interrogate I/O * RCHN 000447 Reset I/O Channel * LIOC 000457 Load IOC * SIOC 000460 Store IOC * XIOC 000462 Exchange IOC entries * RIOC 000510 Read EIOC table entry * WIOC 000511 Write EIOC table entry * EIOC 000512 Exchange EIOC table entries * NOP 000000
TNS Alphabetical List of Instructions TNS Instruction Set Resource Management MXON 000040 Mutual Exclusion On * MXFF 000041 Mutual Exclusion Off * SNDQ 000052 Signal a Send Is Queued * SFRZ 000053 System Freeze * DOFS 000057 Disk Record Offset ** DLEN 000070 Disk Record Length ** HALT 000074 Processor Halt * PSEM 000076 "P" a Semaphore * VSEM 000077 "V" a Semaphore * VWCS 000401 Verify LCS * WWCS 000400 Write LCS * RWCS 000402 Read LCS * FRST 000405 Firmware Reset *
TNS Alphabetical List of Instructions TNS Instruction Set Memory Management MAPS 000042 Map In a Segment * SMAP 000067 Set Map * CRAX 000423 Convert Relative to Absolute Extended * RSPT 000424 Read Segment Page Table Entry * WSPT 000425 Write Segment Page Table Entry * RXBL 000426 Read Extended Base and Limit * SXBL 000427 Set Extended Base and Limit * LCKX 000430 Lock Down Extended Memory * ULKX 000431 Unlock Extended Memory * CMRW 000432 Correctable Memory Error Read/Write *
TNS Instruction Set TNS Alphabetical List of Instructions Guardian Programming Reference Summary for pTAL and TAL —522631-001 17 -22
