HP 3000 Manuals

HPFOPEN (contd) [ MPE/iX Intrinsics Reference Manual ] MPE/iX 5.0 Documentation


MPE/iX Intrinsics Reference Manual

HPFOPEN (contd) 

          Table 4-21.  HPFOPEN Itemnum/Item Values 

-----------------------------------------------------------------------------------------------
|          |          |                                                                       |
| Itemnum  | Mnemonic |                           Item Description                            |
|          |          |                                                                       |
-----------------------------------------------------------------------------------------------
|          |          |                                                                       |
|    18    |   @32    | Short-mapped:                                                         |
|          |          |                                                                       |
|          |          | Returns a short pointer to the beginning of the data area of the      |
|          |          | file.  This option maps the file into short pointer space.  A         |
|          |          | short-mapped file can be 4 megabytes in length.  The calling process  |
|          |          | can have up to 6 megabytes of short-mapped files open at a time.  Use |
|          |          | the pointer as a large array of any type to efficiently access the    |
|          |          | file.                                                                 |
|          |          |                                                                       |
|          |          | A file previously opened normally (not mapped) or with the            |
|          |          | long-mapped option is not accessible with the short-mapped option.    |
|          |          | If this option is specified with the file already opened into long    |
|          |          | pointer space, an error results.                                      |
|          |          |                                                                       |
|          |          | A loaded program file or a loaded library file is not accessible with |
|          |          | the short-mapped option.  A file cannot be loaded that is currently   |
|          |          | opened with the short-mapped option.                                  |
|          |          |                                                                       |
|          |          | Sharing of short pointer files is provided through normal file system |
|          |          | sharing mechanisms, for example, use of the exclusive option.  With   |
|          |          | the short-mapped file, all file system intrinsics, applicable to the  |
|          |          | file, can be used.  FREAD and FWRITE calls can be mixed with the      |
|          |          | short-mapped access.                                                  |
|          |          |                                                                       |
|          |          | Standard (STD) type disk files of fixed or undefined record length    |
|          |          | can be accessed short-mapped with the access type option set to any   |
|          |          | value.  Standard type disk files of variable record length can be     |
|          |          | accessed short-mapped only if the access type option is set to        |
|          |          | read-only access.  KSAM files can be accessed short-mapped only if    |
|          |          | the access type option is set to read-only access and the copy mode   |
|          |          | option is set to 1.                                                   |
|          |          |                                                                       |
|          |          | Directories may not be opened using short-mapped access.              |
|          |          |                                                                       |
|          |          | Default:  No short pointer returned                                   |
|          |          |                                                                       |
|          |          | (ASC) Not used for asynchronous devices.                              |
|          |          |                                                                       |
-----------------------------------------------------------------------------------------------
|          |          |                                                                       |
|    19    |   I32    | Record size:                                                          |
|          |          |                                                                       |
|          |          | Passes the size, in bytes, of the logical records in the file.  Valid |
|          |          | range is dependent upon both storage format (ASCII or binary) and     |
|          |          | record format.  For fixed-length and undefined-length ASCII files, a  |
|          |          | record size can be specified in the range 1..32,767.  For             |
|          |          | variable-length ASCII files, and for fixed-length, variable-length,   |
|          |          | and undefined-length binary files, a record size can be specified in  |
|          |          | the range 1..32,766.                                                  |
|          |          |                                                                       |
|          |          | HPFOPEN rounds up odd values to the next highest even number          |
|          |          | (equivalent to the nearest half word boundary) if the file is ASCII   |
|          |          | with variable-length record format, binary with fixed-length,         |
|          |          | variable-length, or undefined-length record format.                   |
|          |          |                                                                       |
|          |          | For example, if a record size of 105 is specified for a fixed-length  |
|          |          | binary file, HPFOPEN sets the record size to 106; if a record size of |
|          |          | 233 is specified for a fixed-length ASCII file, the record size       |
|          |          | remains the same as it was when specified.                            |
|          |          |                                                                       |
|          |          | The value specified for this itemnum is ignored when a byte stream    |
|          |          | file or hierarchical directory is created.  Byte stream files are     |
|          |          | created with a logical record size of one byte (1).  Hierarchical     |
|          |          | directories are created with a logical record size of 32 bytes (32).  |
|          |          |                                                                       |
|          |          |                                                                       |
|          |          | Default:  256                                                         |
|          |          |                                                                       |
|          |          | (ASC) For terminal and printer files, no rounding up occurs if a      |
|          |          | record size consisting of an odd number of bytes is specified.  The   |
|          |          | record size can be different from the port configuration.  The        |
|          |          | default is the configured record size (normally 40 words for          |
|          |          | terminals, 66 words for printers).                                    |
|          |          |                                                                       |
-----------------------------------------------------------------------------------------------

          Table 4-21.  HPFOPEN Itemnum/Item Values (cont.) 

-----------------------------------------------------------------------------------------------
|          |          |                                                                       |
| Itemnum  | Mnemonic |                           Item Description                            |
|          |          |                                                                       |
-----------------------------------------------------------------------------------------------
|          |          |                                                                       |
|    20    |    CA    | Device name:                                                          |
|          |          |                                                                       |
|          |          | Passes the logical device number, in ASCII form, of a specific        |
|          |          | device.  The file is assumed to be permanent.  If the device name     |
|          |          | option is specified, the nonshareable device should be ready prior to |
|          |          | the HPFOPEN call (otherwise, an error results).                       |
|          |          |                                                                       |
|          |          | Only one of the following options can be in effect when a file is     |
|          |          | opened:                                                               |
|          |          |        itemnum=20                                                     |
|          |          |        itemnum=22                                                     |
|          |          |        itemnum=23                                                     |
|          |          |        itemnum=42                                                     |
|          |          |                                                                       |
|          |          | Default:  Disk file located on the volume class DISC associated with  |
|          |          | the group in which file resides.                                      |
|          |          |                                                                       |
|          |          | A character placed in the first element designates the delimiter used |
|          |          | by HPFOPEN to search for the end of the character array.  The         |
|          |          | delimiter can appear again only following the last valid character of |
|          |          | the character array, for example:                                     |
|          |          |         %devname%  (% is the delimiter, devname is the designator)    |
|          |          |        fabcxyzf (f is the delimiter, abcxyz is the designator)        |
|          |          |                                                                       |
-----------------------------------------------------------------------------------------------
|          |          |                                                                       |
|    21    |   @64    | Long-mapped:                                                          |
|          |          |                                                                       |
|          |          | Returns a long-pointer to the beginning of data of the file.  This    |
|          |          | option maps the file into long pointer space.  A long-mapped file can |
|          |          | be up to 2-gigabytes in size.  There is no limit to the number of     |
|          |          | long-mapped files a process can have open at one time.  The pointer   |
|          |          | can be used as a large array of any type to access the file.          |
|          |          |                                                                       |
|          |          | A loaded program file or a loaded library file is not accessible, and |
|          |          | a file cannot be loaded with this option.                             |
|          |          |                                                                       |
|          |          | Sharing long-pointer files is provided through normal file system     |
|          |          | file sharing mechanisms.  All file system intrinsics applicable to    |
|          |          | the file can be used.  FREAD and FWRITE calls can be mixed with this  |
|          |          | option.                                                               |
|          |          |                                                                       |
|          |          | Standard (STD) disk files of fixed or undefined record length can be  |
|          |          | accessed with this option.  Standard disk files of variable record    |
|          |          | length can be accessed only if itemnum=11 (read-only access).         |
|          |          | Standard disk files of variable record length and KSAM files can be   |
|          |          | accessed only if itemnum=11 (read-only access) and itemnum=17 (set to |
|          |          | 1).                                                                   |
|          |          |                                                                       |
|          |          | Directories may not be opened using long-mapped access.               |
|          |          |                                                                       |
|          |          | Default:  Not returned                                                |
|          |          |                                                                       |
|          |          | (ASC) Not used for asynchronous devices.                              |
|          |          |                                                                       |
-----------------------------------------------------------------------------------------------

          Table 4-21.  HPFOPEN Itemnum/Item Values (cont.) 

-----------------------------------------------------------------------------------------------
|          |          |                                                                       |
| Itemnum  | Mnemonic |                           Item Description                            |
|          |          |                                                                       |
-----------------------------------------------------------------------------------------------
|          |          |                                                                       |
|    22    |    CA    | Volume class:                                                         |
|          |          |                                                                       |
|          |          | Passes a character array representing a volume class name where the   |
|          |          | file space is to be restricted.  This option is applicable only at    |
|          |          | file creation.                                                        |
|          |          |                                                                       |
|          |          | A volume class is a subset of volumes within a volume set.  The       |
|          |          | volume class name must be a valid volume class name residing on the   |
|          |          | volume set bound to the volume (the volume set is an attribute of the |
|          |          | group in which the file resides).                                     |
|          |          |                                                                       |
|          |          | Only one of the following options can be in effect when a file is     |
|          |          | opened with this option:                                              |
|          |          |        itemnum=20                                                     |
|          |          |        itemnum=22                                                     |
|          |          |        itemnum=23                                                     |
|          |          |        itemnum=42                                                     |
|          |          |                                                                       |
|          |          | Default:  A disk file located on the volume class DISC associated     |
|          |          | with the group in which file resides.                                 |
|          |          |                                                                       |
|          |          | A character placed in the first element designates the delimiter used |
|          |          | by HPFOPEN to search for the end of the character array.  The         |
|          |          | delimiter can appear again only following the last valid character of |
|          |          | the character array, for example:                                     |
|          |          |         %volclass%  (% is the delimiter, volclass is the designator)  |
|          |          |        fabcxyzf (f is the delimiter, abcxyz is the designator)        |
|          |          |                                                                       |
|          |          | This itemnum may not be specified when creating hierarchical          |
|          |          | directories.                                                          |
|          |          |                                                                       |
|          |          | (ASC) Not used for asynchronous devices.                              |
|          |          |                                                                       |
-----------------------------------------------------------------------------------------------
|          |          |                                                                       |
|    23    |    CA    | Volume name:                                                          |
|          |          |                                                                       |
|          |          | Passes a character array representing a volume name that restricts    |
|          |          | the file specified to a specific volume.  The volume must reside      |
|          |          | within the volume set of the group where the file resides.  This      |
|          |          | option is applicable only at file creation.                           |
|          |          |                                                                       |
|          |          | Only one of the following options can be in effect when a file is     |
|          |          | opened with this option:                                              |
|          |          |        itemnum=20                                                     |
|          |          |        itemnum=22                                                     |
|          |          |        itemnum=23                                                     |
|          |          |        itemnum=42                                                     |
|          |          |                                                                       |
|          |          | Default:  A disk file located on the volume class DISC associated     |
|          |          | with the group in which the file resides.                             |
|          |          |                                                                       |
|          |          | This itemnum may not be specified when creating hierarchical          |
|          |          | directories.                                                          |
|          |          |                                                                       |
|          |          | (ASC) Not used for asynchronous devices.                              |
|          |          |                                                                       |
-----------------------------------------------------------------------------------------------
|          |          |                                                                       |
|    24    |   I32    | Density:                                                              |
|          |          |                                                                       |
|          |          | Passes the tape density required when writing to a tape file.  This   |
|          |          | option is applicable only when writing to a tape on a drive that      |
|          |          | supports more than one density.  When reading from a tape, the        |
|          |          | density of the tape overrides this option                             |
|          |          |                                                                       |
|          |          | Default:  The highest density available on the device opened.         |
|          |          |                                                                       |
|          |          | (ASC) Not used for asynchronous devices.                              |
|          |          |                                                                       |
-----------------------------------------------------------------------------------------------

          Table 4-21.  HPFOPEN Itemnum/Item Values (cont.) 

-----------------------------------------------------------------------------------------------
|          |          |                                                                       |
| Itemnum  | Mnemonic |                           Item Description                            |
|          |          |                                                                       |
-----------------------------------------------------------------------------------------------
|          |          |                                                                       |
|    25    |    CA    | Printer environment:                                                  |
|          |          |                                                                       |
|          |          | Passes the name of a file that contains a printer environment.  This  |
|          |          | option is valid only for specified printer devices.                   |
|          |          |                                                                       |
|          |          | If opening an Hewlett-Packard 268x page printer file, specify an      |
|          |          | optional printing environment for the job.  The printing environment  |
|          |          | is defined as all of the characteristics of the printed page that are |
|          |          | not part of the data itself, including the page size, the margin      |
|          |          | width, the character set, the orientation (horizontal or vertical),   |
|          |          | and the name of forms to use.  If an environment file is not          |
|          |          | specified, the file system selects a default printer environment.     |
|          |          |                                                                       |
|          |          | Any environment selected remains active until replaced by a new       |
|          |          | environment, or until a call to FCLOSE (close the printer).           |
|          |          |                                                                       |
|          |          | Default:  No printer environment file specified                       |
|          |          |                                                                       |
|          |          | 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,                                     |
|          |          |         %envname%  (% is the delimiter, envname is the designator)    |
|          |          |        fabcxyzf (f is the delimiter, abcxyz is the designator)        |
|          |          |                                                                       |
-----------------------------------------------------------------------------------------------
|          |          |                                                                       |
|    26    |    CA    | Remote environment:                                                   |
|          |          |                                                                       |
|          |          | Passes the node name of the remote computer where the file is         |
|          |          | located.  This option is used when referencing a file located on a    |
|          |          | remote computer.                                                      |
|          |          |                                                                       |
|          |          | Default:  No node name passed (local file access)                     |
|          |          |                                                                       |
|          |          | 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,                                     |
|          |          |         %envname%  (% is the delimiter, envname is the designator)    |
|          |          |        fabcxyzf (f is the delimiter, abcxyz is the designator)        |
|          |          |                                                                       |
|          |          | A remote environment cannot be specified when creating or opening     |
|          |          | files in the HFS name space or in byte stream files.                  |
|          |          |                                                                       |
-----------------------------------------------------------------------------------------------
|          |          |                                                                       |
|    27    |   I32    | Output priority:                                                      |
|          |          |                                                                       |
|          |          | Passes the output priority to be attached to the file for spooled     |
|          |          | output.  This option is applicable only to spooled devices.  The      |
|          |          | output priority must be a number between 1 (lowest priority) and 13   |
|          |          | (highest priority), inclusive.  If the value specified is less than   |
|          |          | the current outfence set by the system operator, file printing is     |
|          |          | deferred until the operator raises the output priority of the file or |
|          |          | lowers the outfence.  This option can be specified for a file already |
|          |          | opened (for example, $STDLIST), where the highest value supplied      |
|          |          | before the last FCLOSE takes effect.  This option is ignored for      |
|          |          | nonspooled devices.                                                   |
|          |          |                                                                       |
|          |          | Default:  8                                                           |
|          |          |                                                                       |
-----------------------------------------------------------------------------------------------

          Table 4-21.  HPFOPEN Itemnum/Item Values (cont.) 

-----------------------------------------------------------------------------------------------
|          |          |                                                                       |
| Itemnum  | Mnemonic |                           Item Description                            |
|          |          |                                                                       |
-----------------------------------------------------------------------------------------------
|          |          |                                                                       |
|    28    |    CA    | Spooled message:                                                      |
|          |          |                                                                       |
|          |          | Passes a spooler message associated with a spoolfile.  For example, a |
|          |          | message is passed that can be used for telling the system operator    |
|          |          | what type of paper to use in the line printer.  This message must be  |
|          |          | displayed to the system operator and verified before the file can be  |
|          |          | printed on a line printer.  The number of characters allowed <=48;    |
|          |          | any quantity > 48 characters is truncated.                            |
|          |          |                                                                       |
|          |          | Default:  No spooled message specified                                |
|          |          |                                                                       |
|          |          | 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:                                     |
|          |          |         %message%  (% is the delimiter, message is the designator)    |
|          |          |        fabcxyzf (f is the delimiter, abcxyz is the designator)        |
|          |          |                                                                       |
-----------------------------------------------------------------------------------------------
|          |          |                                                                       |
|    29    |   I32    | Privileged access:                                                    |
|          |          |                                                                       |
|          |          | Passes a value that temporarily restricts access to the file number   |
|          |          | returned from HPFOPEN to a calling process whose execution level is   |
|          |          | equal to or less than the value specified in this option.  This       |
|          |          | restriction lasts until the file associated with the restricted file  |
|          |          | number is closed.  Do not specify a value less than the execution     |
|          |          | level of the calling process.                                         |
|          |          |                                                                       |
|          |          | The following values are valid:                                       |
|          |          |                                                                       |
|          |          |                                                                       |
|          |          | 0    Privilege level zero (most privileged level)                     |
|          |          |                                                                       |
|          |          | 1    Privilege level one                                              |
|          |          |                                                                       |
|          |          | 2    Privilege level two                                              |
|          |          |                                                                       |
|          |          | 3    Privilege level three (least privileged level)                   |
|          |          |                                                                       |
|          |          | Default:  The execution level of the calling process                  |
|          |          |                                                                       |
-----------------------------------------------------------------------------------------------
|          |          |                                                                       |
|    30    |   I32    | Labeled tape type:                                                    |
|          |          |                                                                       |
|          |          | Passes a value that indicates tape label type information.  This      |
|          |          | option is valid only for labeled tapes.  The following values are     |
|          |          | valid:                                                                |
|          |          |                                                                       |
|          |          |                                                                       |
|          |          | 0    ANSI standard labels                                             |
|          |          |                                                                       |
|          |          | 1    IBM standard labels                                              |
|          |          |                                                                       |
|          |          | Default:  0                                                           |
|          |          |                                                                       |
|          |          | (ASC) Not used for asynchronous devices.                              |
|          |          |                                                                       |
-----------------------------------------------------------------------------------------------

          Table 4-21.  HPFOPEN Itemnum/Item Values (cont.) 

-----------------------------------------------------------------------------------------------
|          |          |                                                                       |
| Itemnum  | Mnemonic |                           Item Description                            |
|          |          |                                                                       |
-----------------------------------------------------------------------------------------------
|          |          |                                                                       |
|    31    |    CA    | Labeled tape expiration:                                              |
|          |          |                                                                       |
|          |          | Passes the date of the expiration of the file or the date after which |
|          |          | the information in the file is no longer useful, in the format        |
|          |          | MM/DD/YY. The file can be overwritten after this date.  If the        |
|          |          | default is specified, the file can be overwritten immediately.  In a  |
|          |          | volume set, file expiration dates must always be equal to or earlier  |
|          |          | than the date on the previous file.                                   |
|          |          |                                                                       |
|          |          | Default:  No expiration date specified                                |
|          |          |                                                                       |
|          |          | 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,                                     |
|          |          |         %expdate%  (% is the delimiter, expdate is the designator)    |
|          |          |        fabcxyzf (f is the delimiter, abcxyz is the designator)        |
|          |          |                                                                       |
|          |          | (ASC) Not used for asynchronous devices.                              |
|          |          |                                                                       |
-----------------------------------------------------------------------------------------------
|          |          |                                                                       |
|    32    |    CA    | Labeled tape sequence:                                                |
|          |          |                                                                       |
|          |          | Passes one of the following character arrays indicating the position  |
|          |          | of the file in relation to other files on the tape:                   |
|          |          |                                                                       |
|          |          |                                                                       |
|          |          | 0    Causes a search of all volumes until the file is found.          |
|          |          |                                                                       |
|          |          | 1.. 9999cifies the position of the file relative to the current file  |
|          |          |      on the tape.                                                     |
|          |          |                                                                       |
|          |          |                                                                       |
|          |          |                                                                       |
|          |          | ADDF Causes the tape to be positioned so as to add a new file at the  |
|          |          |      end of the volume or last volume in a multivolume set.           |
|          |          |                                                                       |
|          |          | NEXT Positions the tape at the next file on the tape.  If this is not |
|          |          |      the first HPFOPEN/FOPEN for the file and a rewind occurred on    |
|          |          |      the last close, then the position remains at the beginning of    |
|          |          |      the previous file.                                               |
|          |          |                                                                       |
|          |          | Default:  No array passed (no sequence indicated)                     |
|          |          |                                                                       |
|          |          | 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,                                     |
|          |          |         %position%  (% is the delimiter, position is the designator)  |
|          |          |        fabcxyzf (f is the delimiter, abcxyz is the designator)        |
|          |          |                                                                       |
|          |          | (ASC) Not used for asynchronous devices.                              |
|          |          |                                                                       |
-----------------------------------------------------------------------------------------------
|          |          |                                                                       |
|    33    |   I32    | User labels:                                                          |
|          |          |                                                                       |
|          |          | Passes the number, in the range 0..254, of user-label records to be   |
|          |          | created for the file.  Applicable for new disk files only.            |
|          |          |                                                                       |
|          |          | Default:  0                                                           |
|          |          |                                                                       |
|          |          | This itemnum may not be specified when creating hierarchical          |
|          |          | directories.                                                          |
|          |          |                                                                       |
|          |          | (ASC) Not used for asynchronous devices.                              |
|          |          |                                                                       |
-----------------------------------------------------------------------------------------------

          Table 4-21.  HPFOPEN Itemnum/Item Values (cont.) 

-----------------------------------------------------------------------------------------------
|          |          |                                                                       |
| Itemnum  | Mnemonic |                           Item Description                            |
|          |          |                                                                       |
-----------------------------------------------------------------------------------------------
|          |          |                                                                       |
|    34    |   I32    | Spooler copies:                                                       |
|          |          |                                                                       |
|          |          | Passes a value in the range 1..127 indicating the number of copies of |
|          |          | the entire file to be produced by the spooling facility.  This option |
|          |          | is applicable to spooled devices only.  This option can be specified  |
|          |          | for a file already opened (for example, $STDLIST), where the highest  |
|          |          | value supplied before the last FCLOSE takes effect.  The copies do    |
|          |          | not appear continuously if the system operator intervenes or if a     |
|          |          | file of higher output priority becomes READY before the last copy is  |
|          |          | complete.  This option is ignored for nonspooled output devices.      |
|          |          |                                                                       |
|          |          | Default:  1                                                           |
|          |          |                                                                       |
-----------------------------------------------------------------------------------------------
|          |          |                                                                       |
|    35    |   I32    | File size:                                                            |
|          |          |                                                                       |
|          |          | Passes the maximum file capacity:                                     |
|          |          |    *   For variable-length records, the capacity is expressed in      |
|          |          |        blocks (blockitem#=recordsize * blockfactor).                  |
|          |          |    *   For fixed-length and undefined-length records, the capacity is |
|          |          |        expressed in logical records.                                  |
|          |          |    *   The maximum file size for standard and KSAM XL files is        |
|          |          |        4,294,901,759 bytes (4 gigabytes less 64K bytes).              |
|          |          |    *   The maximum file size for a CM KSAM data file is 2 gigabytes   |
|          |          |        and for a CM KSAM key file, 2 gigabytes.                       |
|          |          |    *   The maximum file size of 500 megabytes, for RIO and circular   |
|          |          |        is dependent upon both the record size and the number of       |
|          |          |        extents defined for the file:                                  |
|          |          |           *   For circular and RIO files, recsize=256 bytes and       |
|          |          |               numextent=32.                                           |
|          |          |                                                                       |
|          |          | This option is applicable only at file creation.                      |
|          |          |                                                                       |
|          |          | Default:  2 gigabytes                                                 |
|          |          |                                                                       |
|          |          | This itemnum may not be specified when creating hierarchical          |
|          |          | directories.                                                          |
|          |          |                                                                       |
|          |          | (ASC) Not used for asynchronous devices.                              |
|          |          |                                                                       |
-----------------------------------------------------------------------------------------------
|          |          |                                                                       |
|    36    |   I32    | Initial allocation:                                                   |
|          |          |                                                                       |
|          |          | Passes a positive integer value indicating the number of records to   |
|          |          | be allocated to the file initially.  This option is applicable only   |
|          |          | at file creation.                                                     |
|          |          |                                                                       |
|          |          | Default:  0                                                           |
|          |          |                                                                       |
|          |          | This itemnum may not be specified when creating hierarchical          |
|          |          | directories.                                                          |
|          |          |                                                                       |
|          |          | (ASC) Not used for asynchronous devices.                              |
|          |          |                                                                       |
-----------------------------------------------------------------------------------------------

          Table 4-21.  HPFOPEN Itemnum/Item Values (cont.) 

-----------------------------------------------------------------------------------------------
|          |          |                                                                       |
| Itemnum  | Mnemonic |                           Item Description                            |
|          |          |                                                                       |
-----------------------------------------------------------------------------------------------
|          |          |                                                                       |
|    37    |   I32    | File code:                                                            |
|          |          |                                                                       |
|          |          | Passes a value that can be used as a file code to identify the type   |
|          |          | of file.  This code is recorded in the file label and is accessible   |
|          |          | through the FFILEINFO intrinsic.  This option is applicable only at   |
|          |          | file creation (except when opening an old file that has a negative    |
|          |          | file code).                                                           |
|          |          |                                                                       |
|          |          | If the program is running in user mode, specify a file code in the    |
|          |          | range 0..32,767 to indicate the file type being created.  Programs    |
|          |          | running in user mode can access files with positive file codes only.  |
|          |          |                                                                       |
|          |          |                                                                       |
|          |          | If the program is running in privileged mode, specify a file code in  |
|          |          | the range -32,768..32,767.  Programs running in privileged mode can   |
|          |          | access files with a file code in the range -32,768..32,767.  If an    |
|          |          | old file is opened that has a negative file code in its file label,   |
|          |          | the file code specified must match the file code in the file label    |
|          |          | (otherwise, an error results).                                        |
|          |          |                                                                       |
|          |          | File codes cannot be specified for hierarchical directories.          |
|          |          | Negative file codes may be used only for files in MPE groups.  A      |
|          |          | status.info of -315 is returned when negative file codes are          |
|          |          | specified for files outside MPE groups.                               |
|          |          |                                                                       |
|          |          | Default:  0                                                           |
|          |          |                                                                       |
|          |          | (ASC) Not used for asynchronous devices.                              |
|          |          |                                                                       |
-----------------------------------------------------------------------------------------------
|          |          |                                                                       |
|    38    |   I32    | File privilege:                                                       |
|          |          |                                                                       |
|          |          | Passes a value that determines a permanent privilege level to be      |
|          |          | associated with a newly created file.  This option permanently        |
|          |          | restricts file access to a process whose execution level is less than |
|          |          | or equal to the specified value.  A value cannot be specified for     |
|          |          | less than the execution level of the calling process.  This option is |
|          |          | applicable only at file creation.                                     |
|          |          |                                                                       |
|          |          | The following values are valid:                                       |
|          |          |                                                                       |
|          |          |                                                                       |
|          |          | 0    Privilege level zero (most privileged level)                     |
|          |          |                                                                       |
|          |          | 1    Privilege level one                                              |
|          |          |                                                                       |
|          |          | 2    Privilege level two                                              |
|          |          |                                                                       |
|          |          | 3    Privilege level three (least privileged level)                   |
|          |          |                                                                       |
|          |          | Default:  3                                                           |
|          |          |                                                                       |
-----------------------------------------------------------------------------------------------

          Table 4-21.  HPFOPEN Itemnum/Item Values (cont.) 

-----------------------------------------------------------------------------------------------
|          |          |                                                                       |
| Itemnum  | Mnemonic |                           Item Description                            |
|          |          |                                                                       |
-----------------------------------------------------------------------------------------------
|          |          |                                                                       |
|    39    |   I32    | Access type:                                                          |
|          |          |                                                                       |
|          |          | Passes a value indicating how to use the file, either sequentially or |
|          |          | randomly.  The file system uses this information to determine the     |
|          |          | most efficient prefetching algorithm to improve the performance of    |
|          |          | the file access.                                                      |
|          |          |                                                                       |
|          |          | The following values are valid:                                       |
|          |          |                                                                       |
|          |          |                                                                       |
|          |          | 0    Access the file sequentially                                     |
|          |          |                                                                       |
|          |          | 1    Access the file randomly                                         |
|          |          |                                                                       |
|          |          | Default:  0                                                           |
|          |          |                                                                       |
|          |          | (ASC) Not used for asynchronous devices.                              |
|          |          |                                                                       |
-----------------------------------------------------------------------------------------------
|          |          |                                                                       |
|    40    |   I32    | Block factor:                                                         |
|          |          |                                                                       |
|          |          | Passes the number of logical records to be contained in one physical  |
|          |          | record (block).  This value is used to calculate the physical record  |
|          |          | size (block size) for disk and magnetic tape files.  Valid ranges are |
|          |          | 1..32,767.  This option is applicable only at file creation.          |
|          |          |                                                                       |
|          |          | For fixed-length records, this option specifies the actual number of  |
|          |          | records in a block.  For variable-length records, this option is      |
|          |          | interpreted as a multiplier used to compute the block size (record    |
|          |          | size option * block factor option).  For undefined-length records,    |
|          |          | this option is always one logical record per block.                   |
|          |          |                                                                       |
|          |          | This itemnum may not be specified when creating hierarchical          |
|          |          | directories.                                                          |
|          |          |                                                                       |
|          |          | Default:  1 for files opened NOBUF; for files opened BUF, it is       |
|          |          | calculated by dividing the specified records into the block size      |
|          |          | configured for the device.                                            |
|          |          |                                                                       |
|          |          | (ASC) Not used for asynchronous devices.                              |
|          |          |                                                                       |
-----------------------------------------------------------------------------------------------
|          |          |                                                                       |
|    41    |   I32    | Name syntax:                                                          |
|          |          |                                                                       |
|          |          | Specifies which of three name semantics will be used to interpret the |
|          |          | filename passed to HPFOPEN:                                           |
|          |          |                                                                       |
|          |          |                                                                       |
|          |          | 0                     MPE-escaped semantics                           |
|          |          |                                                                       |
|          |          | 1                     MPE-only sematics                               |
|          |          |                                                                       |
|          |          | 2                     POSIX semantics                                 |
|          |          |                                                                       |
|          |          | MPE-escaped name semantics is the default value for this itemnum.     |
|          |          | The selected name semantics do not apply to file equations specified  |
|          |          | through itemnum 52 or system-defined file references specified        |
|          |          | through itemnum 5.                                                    |
|          |          |                                                                       |
-----------------------------------------------------------------------------------------------

          Table 4-21.  HPFOPEN Itemnum/Item Values (cont.) 

-----------------------------------------------------------------------------------------------
|          |          |                                                                       |
| Itemnum  | Mnemonic |                           Item Description                            |
|          |          |                                                                       |
-----------------------------------------------------------------------------------------------
|          |          |                                                                       |
|    42    |    CA    | Device class:                                                         |
|          |          |                                                                       |
|          |          | Passes a device class where the file resides.  The file system uses   |
|          |          | the device class name to select a nonshareable device from a          |
|          |          | configured list of available devices.  The name can have a length of  |
|          |          | up to eight alphanumeric characters, beginning with a letter (for     |
|          |          | example, TAPE). If a device class is specified, the file is allocated |
|          |          | to any available device in that class.                                |
|          |          |                                                                       |
|          |          | Only one of the following options can be in effect when a file is     |
|          |          | opened:                                                               |
|          |          |        itemnum=20                                                     |
|          |          |        itemnum=22                                                     |
|          |          |        itemnum=23                                                     |
|          |          |        itemnum=42                                                     |
|          |          |                                                                       |
|          |          | Default:  A disk file located on the volume class DISC associated     |
|          |          | with the group in which file resides.                                 |
|          |          |                                                                       |
|          |          | A character placed in the first element designates the delimiter used |
|          |          | by HPFOPEN to search for the end of the character array.  The         |
|          |          | delimiter can appear again only following the last valid character of |
|          |          | the character array, for example:                                     |
|          |          |         %devclass%  (% is the delimiter, devclass is the designator)  |
|          |          |        fabcxyzf (f is the delimiter, abcxyz is the designator)        |
|          |          |                                                                       |
|          |          | This itemnum may not be specified when creating hierarchical          |
|          |          | directories.  Hierarchical directories created on the system volume   |
|          |          | set is allocated on any volume within the set.  Hierarchical          |
|          |          | directories created on non-system volume sets is allocated on the     |
|          |          | master volume.                                                        |
|          |          |                                                                       |
-----------------------------------------------------------------------------------------------
|          |          |                                                                       |
|    43    |  record  | UFID:                                                                 |
|          |          |                                                                       |
|          |          | Passes a unique file identifier (UFID) to provide a fast opening of   |
|          |          | an old disk file.  A UFID is a record structure, 20 bytes in length,  |
|          |          | that uniquely identifies a disk file.  Using this option avoids a     |
|          |          | directory search.  Obtain the UFID of an opened file by calling       |
|          |          | FFILEINFO. The UFID can then be passed to HPFOPEN. The file           |
|          |          | represented by the UFID must be accessible to the process calling     |
|          |          | HPFOPEN. (All file system security checks are made.)  New files       |
|          |          | cannot be opened with this option.  If the file to be opened by the   |
|          |          | UFID contains a lockword, use itemnum=2 to specify the file name with |
|          |          | the lockword.                                                         |
|          |          |                                                                       |
|          |          | Only files in the MPE name space may be opened by UFID. An attempt to |
|          |          | open a file outside the MPE name space by UFID results in a           |
|          |          | status.info of -321 being returned.  Only system code may open a file |
|          |          | by UFID in the POSIX name space.                                      |
|          |          |                                                                       |
|          |          | Default:  No UFID passed (a directory search is performed)            |
|          |          |                                                                       |
|          |          | (ASC) Not used for asynchronous devices.                              |
|          |          |                                                                       |
-----------------------------------------------------------------------------------------------

          Table 4-21.  HPFOPEN Itemnum/Item Values (cont.) 
-----------------------------------------------------------------------------------------------
|          |          |                                                                       |
| Itemnum  | Mnemonic |                           Item Description                            |
|          |          |                                                                       |
-----------------------------------------------------------------------------------------------
|          |          |                                                                       |
|    44    |   I32    | Numbuffers:                                                           |
|          |          |                                                                       |
|          |          | Passes the number of buffers to allocate to the file.  Ignored for    |
|          |          | standard disk files.  This option is useful only for slow devices     |
|          |          | (such as tapes) used in a buffered mode.  Not applicable for files    |
|          |          | representing interactive terminals; a system-managed buffering method |
|          |          | is always used.                                                       |
|          |          |                                                                       |
|          |          | The valid range for this option is dependent upon the file type:      |
|          |          |                                                                       |
|          |          |    *   For standard and KSAM files, the valid range is 1..31.         |
|          |          |    *   For circular and RIO files, the valid range is 1..16.          |
|          |          |    *   For message files, the valid range is 2..16.  (If a 1 is       |
|          |          |        specified, the file system sets this option to 2 and no error  |
|          |          |        is returned.)                                                  |
|          |          |                                                                       |
|          |          | This option must not specify a number of buffers whose combined size  |
|          |          | exceeds the physical capacity of the file.                            |
|          |          |                                                                       |
|          |          | This itemnum is ignored when creating hierarchical directories.       |
|          |          |                                                                       |
|          |          | Default:  2                                                           |
|          |          |                                                                       |
|          |          | (ASC) Not used for asynchronous devices.                              |
|          |          |                                                                       |
-----------------------------------------------------------------------------------------------
|          |          |                                                                       |
|    45    |    CA    | Fill character:                                                       |
|          |          |                                                                       |
|          |          | Passes two ASCII characters that determine what padding character to  |
|          |          | use at the end of blocks or unused pages, and the padding used by     |
|          |          | itemnum=53.  Do not use delimiter characters for this option.  The    |
|          |          | fill character must be a 2 byte array.  The first character only is   |
|          |          | used as the padding character.  The second character is reserved for  |
|          |          | future use.  This option is applicable only at file creation.         |
|          |          |                                                                       |
|          |          | Default:  Null characters for a binary file and ASCII blanks for an   |
|          |          | ASCII file.                                                           |
|          |          |                                                                       |
|          |          | The default fill character for byte stream files is the null          |
|          |          | character.  The fill character is null for hierarchical directories   |
|          |          | regardless of the value specified for this itemnum.                   |
|          |          |                                                                       |
-----------------------------------------------------------------------------------------------



MPE/iX 5.0 Documentation