HP 3000 Manuals HP 3000 Manuals
HPFOPEN (contd.)
Table 4-22. HPFOPEN Itemnum/Item Values
-----------------------------------------------------------------------------------------------
| | | |
| Itemnum | Mnemonic | Item Description |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| 46 | I32 | Inhibit buffering: |
| | | |
| | | Passes a value enabling/disabling automatic operataing |
| | | systembuffering. If NOBUF is specified, I/O is allowed to take place |
| | | directly between the data area and the applicable hardware device. |
| | | |
| | | The following values are valid: |
| | | |
| | | |
| | | 0 Allow normal buffering (BUF) |
| | | |
| | | 1 Inhibit buffering (NOBUF) |
| | | |
| | | Default: 0 |
| | | |
| | | NOBUF access is oriented to physical block transfer rather than |
| | | logical record transfer. If NOBUF and a variable-length record |
| | | structure are specified in itemnum=6 and the file does not have a |
| | | variable-length record format, then the format is changed internally |
| | | to an undefined-length record format. When performing an FWRITE, set |
| | | up the variable structure. |
| | | |
| | | With NOBUF access, responsibility for blocking and deblocking of |
| | | records in the file belongs to the program. To be consistent with |
| | | files built using buffered I/O, records should begin on half word |
| | | boundaries. When the information content of the record is less than |
| | | the defined record length, you must pad the record with blanks if the |
| | | file is ASCII, or with zeros if the file is binary. |
| | | |
| | | The record size and block size for files manipulated with NOBUF |
| | | specified follow the same rules as those files that are created using |
| | | buffering. The default blocking factor for a file created under |
| | | NOBUF is one. |
| | | |
| | | If a file is opened NOBUF without multirecord mode specified in |
| | | itemnum=15, then transfer a maximum of only one block of data per |
| | | read or write. |
| | | |
| | | The end-of-file (EOF) marker, next record pointer, and record |
| | | transfer count are maintained in terms of logical records for all |
| | | files. The number of logical records affected by each transfer is |
| | | determined by the size of the transfer. |
| | | |
| | | Transfers always begin on a block boundary. Those transfers that do |
| | | not transfer whole blocks leave the next record pointer set to the |
| | | first record in the next block. The EOF marker always points at the |
| | | last record in the file. |
| | | |
| | | For files you have opened NOBUF, the FREADDIR, FWRITEDIR, and FPOINT |
| | | intrinsics treat the recnum parameter as a block number. |
| | | |
| | | Indicate non-RIO access to an RIO file by specifying the file NOBUF. |
| | | Use the physical block size from FFILEINFO to determine the maximum |
| | | transfer length. |
| | | |
| | | For message files, the file system normally resets itemnum=46 to |
| | | zero. However, a message file can be opened with NOBUF if itemnum=17 |
| | | is set to 1; this determines access to the file record-by-record or |
| | | by block. |
| | | |
| | | If writing to a message file, open it NOBUF if itemnum=17 to access |
| | | the file block-by-block. |
| | | |
| | | Native byte stream access opens NOBUF (1) regardless of the value |
| | | specified for this itemnum. This itemnum is ignored for directories |
| | | since a physical block transfer interface is not provided for |
| | | directories. |
| | | |
| | | (ASC) Not used for asynchronous devices. |
| | | |
-----------------------------------------------------------------------------------------------
Table 4-22. HPFOPEN Itemnum/Item Values (cont.)
-----------------------------------------------------------------------------------------------
| | | |
| Itemnum | Mnemonic | Item Description |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| 47 | I32 | Numextents: |
| | | |
| | | Passes a value in the range 1..32 that determines the number of |
| | | extents for the file. If a value of 1 is specified, the file is |
| | | created as one contiguous extent of disk space. If a value greater |
| | | than 1 is specified, a variable number of extents (with varying |
| | | extent sizes) is allocated on a need basis. This option is |
| | | applicable only at file creation. |
| | | |
| | | (ASC) Not used for asynchronous devices. |
| | | |
| | | Default: 1 |
| | | |
| | | This itemnum may not be specified when creating hierarchical |
| | | directories. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| 48 | I32 | Reverse VT: |
| | | |
| | | Passes a value indicating whether or not the given device name is to |
| | | be allocated on a remote machine. Specify the remote environment in |
| | | the same open request, using either the formal designator option or |
| | | the remote environment option. Reverse VT behaves nearly the same as |
| | | a terminal opened through remote file access, except that no session |
| | | is required on the remote machine. |
| | | |
| | | The following values are valid: |
| | | |
| | | |
| | | 0 No reverse VT |
| | | |
| | | 1 Reverse VT |
| | | |
| | | Default: 0 |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| 49 | | Reserved for the operating system |
| | | |
-----------------------------------------------------------------------------------------------
Table 4-22. HPFOPEN Itemnum/Item Values (cont.)
-----------------------------------------------------------------------------------------------
| | | |
| Itemnum | Mnemonic | Item Description |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| 50 | I32 | Final disposition: |
| | | |
| | | Passes a value indicating the final disposition of the file at close |
| | | time (significant only for files on disk and magnetic tape). A |
| | | corresponding parameter in a FILE command can override this option, |
| | | unless file equations are disallowed with itemnum=9. |
| | | |
| | | The following values are valid: |
| | | |
| | | |
| | | 0 No change. The disposition remains as it was before the file |
| | | was opened. If the file is new, it is deleted by FCLOSE; |
| | | otherwise, the file is assigned to the domain it belonged to |
| | | previously. An unlabeled tape file is rewound. If the file |
| | | resides on a labeled tape, the tape is rewound and unloaded. |
| | | |
| | | 1 Permanent file. If the file is a disk file, it is saved in the |
| | | system file domain. A new or temporary file on disk has an |
| | | entry created for it in the system (permanent) file directory. |
| | | If a file of the same name already exists in the directory, an |
| | | error code is returned at close time and the file remains open. |
| | | If the file is a permanent file on disk, this domain disposition |
| | | has no effect. If the file is stored on magnetic tape, the tape |
| | | is rewound and unloaded. |
| | | |
| | | 2 Temporary job file (rewound). The file is retained in your |
| | | temporary (job/session) file domain and can be requested by any |
| | | process within your job/session. If the file is a disk file, |
| | | the uniqueness of the file name is checked. If a file of the |
| | | same name already exists in the temporary file domain, an error |
| | | code is returned at close time and the file remains open. When |
| | | a file resides on unlabeled magnetic tape, the tape is rewound. |
| | | However, if the file resides on labeled magnetic tape, the tape |
| | | is backspaced to the beginning of the presently opened file. |
| | | |
| | | 3 Temporary job file (not rewound). This value has the same |
| | | effect as specifying final disposition option itemnum=2, except |
| | | that tape files are not rewound. In the case of unlabeled |
| | | magnetic tape, if the FCLOSE is the last done on the device |
| | | (with no other FOPEN/HPFOPEN calls outstanding), the tape is |
| | | rewound and unloaded. If the file resides on a labeled magnetic |
| | | tape, the tape is positioned to the beginning of the next file |
| | | on the tape. |
| | | |
| | | 4 Released file. The file is deleted from the system. |
| | | |
| | | 5 Convert a permanent file to a temporary file. The file is |
| | | removed from the permanent file directory and placed in the |
| | | temporary file directory. (Privileged mode capability is |
| | | required to use this option.) |
| | | |
| | | Default: 0 |
| | | |
| | | For more information on file disposition at close time, refer to the |
| | | description of the FCLOSE intrinsic. |
| | | |
| | | (ASC) Not used for asynchronous devices. |
| | | |
-----------------------------------------------------------------------------------------------
Table 4-22. HPFOPEN Itemnum/Item Values (cont.)
-----------------------------------------------------------------------------------------------
| | | |
| Itemnum | Mnemonic | Item Description |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| 51 | String | Pascal XL string: |
| | | |
| | | Passes a formal file designator that follows MPE/iX file naming |
| | | conventions, using the Pascal XL STRING type format. This option is |
| | | identical to itemnum=2 except for the type of item. No delimiters |
| | | are needed. |
| | | |
| | | Default: No string passed |
| | | |
| | | When you use HPFOPEN to open a file, you may use either itemnum=2 or |
| | | you may use itemnum=51; you may not use both. |
| | | |
| | | As the default, the formal file designator is interpreted according |
| | | to MPE-escaped semantics. To choose another syntax, use itemnum 41. |
| | | |
| | | |
| | | The file referred to by formaldesig can be either an MPE file (i.e., |
| | | one that uses MPE syntax) or it can follow HFS syntax. If |
| | | formaldesig follows MPE syntax, the file name can include password, |
| | | group, and account specifications. The file name can backreference a |
| | | file equation and optionally be preceded by an asterisk. If |
| | | formaldesig follows HFS syntax, the file name must start with either |
| | | a dot (.) or a slash (/). |
| | | |
| | | The file referred to by formaldesig may reside either in an MPE group |
| | | or in an HFS directory. For files located in HFS directories, |
| | | traverse directory entries (TD) access is required to all directories |
| | | specified in formaldesig. If there is no TD access, HPFOPEN fails |
| | | and a value of -180 is returned in the status.info parameter. If you |
| | | are using HPFOPEN to create a file or hierarchical directory and you |
| | | lack of create directory entry (CD) access, status.info will return a |
| | | value of -179. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| 52 | CA | File equation string: |
| | | |
| | | Passes a character string that matches the file equation |
| | | specification syntax exactly. (Refer to the FILE command in the |
| | | MPE/iX Commands Reference Manual Volumes 1 and 2 (32650-90003 and |
| | | 32650-90364).) This option allows the specification of options |
| | | available in the FILE command. |
| | | |
| | | The formaldesig parameter and filereference parameter can contain |
| | | embedded command interpreter variables and expressions. However, |
| | | there cannot be more than 8-characters in each of these components |
| | | (filename, lockword, groupname, accountname) including the command |
| | | interpreter variable and expression characters. |
| | | |
| | | Default: No string passed |
| | | |
| | | A character placed in the first element designates the delimiter used |
| | | by HPFOPEN to search for the end of the character array. The |
| | | delimiter can appear again only following the last valid character of |
| | | the character array, for example: |
| | | %fileequation% (% is the delimiter, fileequation is the |
| | | designator) |
| | | fabcxyzf (f is the delimiter, abcxyz is the designator) |
| | | |
| | | The formaldesignator in the file equation string must belong to the |
| | | MPE name space. The filerefence in the file equation string is |
| | | interpreted using MPE-escaped semantics. Both the formaldesignator |
| | | and the filereference in the file equation string may also contain |
| | | embedded command interpreter variables or expressions. |
| | | |
-----------------------------------------------------------------------------------------------
Table 4-22. HPFOPEN Itemnum/Item Values (cont.)
-----------------------------------------------------------------------------------------------
| | | |
| Itemnum | Mnemonic | Item Description |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| 53 | I32 | ASCII/binary: |
| | | |
| | | Passes a value indicating whether ASCII or binary code is to be used |
| | | for a new file when it is written to a device that supports both |
| | | codes. For disk files, this affects padding that can occur when |
| | | issuing a direct-write intrinsic call (FWRITEDIR) to a record that |
| | | lies beyond the current logical end-of-file indicator. By default, |
| | | magnetic tape and files are treated as ASCII files. This option is |
| | | applicable only at file creation. |
| | | |
| | | The following values are valid: |
| | | |
| | | |
| | | 0 Binary file |
| | | |
| | | 1 ASCII file |
| | | |
| | | Default: 0 |
| | | |
| | | (ASC) Not used for asynchronous devices. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| 54 | REC | KSAM parm: |
| | | |
| | | Passes a record that defines the keys for a new KSAM file. |
| | | |
| | | (KSAM XL) For KSAM XL files, refer to the parm parameter discussion |
| | | in the Using KSAM XL (32650-90168). |
| | | |
| | | (KSAM/3000) The record must be at least 34 bytes in size. For |
| | | details, refer to the ksamparam parameter discussion in the KSAM/3000 |
| | | Reference Manual (30000-90079). |
| | | |
| | | Default: No record passed |
| | | |
| | | (ASC) Not used for asynchronous devices. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| 55 | | Reserved for the operating system |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| 56 | I32 | Object class: |
| | | |
| | | Passes a user object class number, in the range 0..10, that is |
| | | associated with the file. |
| | | |
| | | Default: Determined by the file code for system and subsystem files, |
| | | and by the file type and record type for normal user files. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| 57 | | Reserved for the operating system |
| | | |
-----------------------------------------------------------------------------------------------
Table 4-22. HPFOPEN Itemnum/Item Values (cont.)
-----------------------------------------------------------------------------------------------
| | | |
| Itemnum | Mnemonic | Item Description |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| 58 | | Reserved for the operating system |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| 59 | | Reserved for the operating system |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| 60 | | Reserved for the operating system |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| 61 | | Reserved for the operating system |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| 64 | BA | Access Control Definition: |
| | | |
| | | Passes a byte array defining the access control definition (ACD) to |
| | | be attached to a new file. The byte array has a length of 1 to 279 |
| | | bytes. Unlike other HPFOPEN options that expect a delimiter at both |
| | | the beginning and the end of the byte array, this option only expects |
| | | a trailing carriage return character as a delimiter, for example, |
| | | |
| | | (X:@.@;R,W:MGR.SYS;RACD:JOHN.SMITH)<cr> |
| | | |
| | | Where, the <cr> is the carriage return character (13, 0x0D). |
| | | |
| | | The ACD assigned to a newly created file or directory may be |
| | | different from the ACD specified as the value of this itemnum. If a |
| | | process' file mode creation mask (cmask) is initialized, it modifies |
| | | the ACD. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| 74 | | Header/Trailer: |
| | | |
| | | Enable/disable standard headers/trailers: |
| | | |
| | | |
| | | 0 Enable header and trailer (default) |
| | | |
| | | 1 Disable header |
| | | |
| | | 2 Disable trailer |
| | | |
| | | 3 Disable header and trailer |
| | | |
| | | Provides a standard way for the spooler to control the printing |
| | | banners. |
| | | |
| | | Valid only for the initial HPFOPEN call to the printer and prevents |
| | | the header from being printed. On the last FCLOSE, the trailer is |
| | | not printed. |
| | | |
-----------------------------------------------------------------------------------------------
Table 4-22. HPFOPEN Itemnum/Item Values (cont.)
-----------------------------------------------------------------------------------------------
| | | |
| Itemnum | Mnemonic | Item Description |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| 77 | I32 | Data format |
| | | |
| | | Allows the caller to select a different format to view the data in |
| | | the file. The current valid values for this item are: |
| | | |
| | | |
| | | 0 Use the standard record based view of accessing |
| | | the file. This is the default value for all |
| | | opens. For conventional files, the file is |
| | | record based. For directories, the standard |
| | | non-privileged directory information is |
| | | returned when the HPDIRREAD intrinsic is |
| | | called. When this value is specified with a |
| | | byte stream file, access to the file is |
| | | emulated to appear like a buffered variable |
| | | record file. This is the default. |
| | | |
| | | 1 When this value is specified, calls to |
| | | HPDIRREAD returns privileged directory |
| | | information including the UFID and link ID of |
| | | the entry. Note that this value is only |
| | | applicable to directory files. This value is |
| | | ignored for all other file types. In order to |
| | | specify this value, the caller must be |
| | | executing in system code. |
| | | |
| | | 2 When this value is specified, the system |
| | | attempts to let the caller access the file as a |
| | | native byte stream file. Byte stream emulation |
| | | is supported for ordinary fixed and variable |
| | | length record files as well as for files with |
| | | the byte stream record type. If this value is |
| | | requested against a file type that does not |
| | | support byte stream access, an error is |
| | | returned. |
| | | |
| | | Specifying any value other than the values described above will |
| | | result in an error. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| 79 | I32 | POSIX Non-Block Mode |
| | | |
| | | Specifying this itemnum allows the caller to open a file with the |
| | | POSIX Non-Block mode. This item is useful for a subset of files |
| | | (including pipes and FIFO's) and is ignored for all other files. The |
| | | behavior of the HPFOPEN call with this option is dependent on the |
| | | type of file being opened. |
| | | |
| | | The current valid values for this item are: |
| | | |
| | | |
| | | 0 This value indicates that Non-Block mode is |
| | | off. This is the default value. |
| | | |
| | | 1 This value indicates that Non-Block mode is on. |
| | | |
| | | |
| | | Specifying any value other than those described above will result in |
| | | error. |
| | | |
-----------------------------------------------------------------------------------------------
Table 4-22. HPFOPEN Itemnum/Item Values (cont.)
-----------------------------------------------------------------------------------------------
| | | |
| Itemnum | Mnemonic | Item Description |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| 80 | I32 | Reserved for the operating system. |
| | | |
-----------------------------------------------------------------------------------------------
| | | |
| 81 | I32 | Symbolic link option: |
| | | |
| | | This itemnum allows the caller to specify different options when |
| | | traversing through or opening a symbolic link. The valid values for |
| | | this itemnum are described below: |
| | | |
| | | |
| | | 0 Follow symbolic links. This is the default |
| | | value for this option. When a symbolic link is |
| | | encountered it is traversed according to the |
| | | path specified in the symbolic link. |
| | | |
| | | 1 Does not follow symbolic links. If the final |
| | | component of a path is a symbolic link, then no |
| | | traversal is done and the symbolic link is |
| | | opened. Symbolic links that occur prior to the |
| | | last component is traversed. |
| | | |
| | | Specifying any value other than those above will result in error. |
| | | |
-----------------------------------------------------------------------------------------------
Operation Notes
Enables creation of a new file on a shareable device and defines the
physical characteristics of that file prior to access. Enables access to
existing files. Returns a file number to the calling process that
uniquely identifies the file. Use the file number to reference the file
in calls to other intrinsics.
Related Information
Intrinsics FOPEN
Commands None
Manuals Accessing Files Programmer's Guide (32650-90017),
Using KSAM XL (32650-90168), and KSAM/3000
Reference Manual (30000-90079)