FFILEINFO

File designator (28 bytes):

Returns the file designator of the file being referenced in the format: filename.groupname.accountname Must be >=28 bytes in length. Unused bytes are filled with right-justified blanks and a nameless file returns an empty string. The fully qualified name of the file referenced by filenum is returned as the value of this itemnum. Only names which can be expressed using MPE-only semantics are returned by this itemnum. If the name of the object referenced by filenum can not be expressed using MPE-name semantics a CCL condition code is returned. Calling FCHECK for filenum after this error occurs will return FSERR391.

File options:

Returns file characteristics (refer to the foption figure). The record format extension bit is returned as the foption (1:1) bit. Byte stream record format is represented as a record format extension of one with a variable record format foption (8:2) bits equal to 01.

Directories, symbolic links, device links, pipes and FIFO's can not be represented by foptions. If the object referenced by filenum is one of these objects, a CCL condition code is returned. Calling FCHECK for filenum after this error occurs will will return FSERR399

Access options:

Returns file access information (refer to the Faoption figure).

(CM) Record size:

Returns the logical record size associated with the file:

For message files, when there is call to FCONTROL with controlcode=46, the value returned is the size of the data records, including the 4 byte header.

Maintained for compatibility with MPE V/E-based systems only. CM record sizes are imposed when FGETINFO returns record size information on all file types. If the record size exceeds the limits, a zero is returned.

Note: If a zero is returned, use item 67.

Device type/subtype:

Returns the type and subtype of the device being used for a KSAM, RIO, circular, or message file, or devices such as a tape drive, printer, or terminal where bits (0:8) indicate the device subtype, and bits (8:8) indicate the device type.

If the file is not spooled or is opened as a spoolfile through the logical device, the actual value is returned. If an output file is spooled and was opened by device class name, the type and subtype of the first device in its class is returned. (This may be different from the device actually used.)

Logical device number:

Returns the logical device number of the device where the disk file label resides.

Note: If a zero is returned, use item 50.

Hardware device address:

Returns 2048. Maintained to provide backward compatibility with MPE V/E-based systems.

File code:

Returns the file code of a disk file (refer to FFILEINFO for file codes).

Current logical record pointer:

Returns the current logical record pointer setting. This value is the displacement in logical records from record number 0 in the file and identifies the record that would be accessed next by FREAD or FWRITE.

EOF:

Returns the pointer setting of the last logical record currently in the file (equivalent to EOF). If the file does not reside on disk, the value is zero. For message files, when a call is made to FCONTROL with itemnum=46, the number of records returned includes open, close, and data records.

File limit:

Returns a number representing the last logical record that can exist in the file (equivalent to the file limit). If the file does not reside on disk, the value is zero.

Log count:

Returns the logical records passed to and from the program during the current file access.

Physical count:

Returns the number of buffered physical I/O operations performed since the last FOPEN/HPFOPEN call (records).

Block size:

Returns the file block size:

For standard fixed ASCII files with odd record sizes, the block size is computed as "(record size + 1)" X block factor. For even record sizes, it returns the block size from the gufd.

Maintained for compatibility with MPE V/E-based systems only. CM block size limits are used when FGETINFO returns block size information on all file types (STD, KSAM, RIO, CIR, MSG). If the block size of the specified file exceeds the limits, zero is returned.

Note: If a zero is returned, use item 68.

Extent size:

Returns the extent size; for compatibility with MPE V/E-based systems only.

Note: If a zero is returned, use item 69. If extent size is specified or the maximum number of extents is specified at file creation, the size and number of extents are determined by the operating system and the item values are not actual values; they are calculated using system defaults.

Maximum number of extents:

If the extent size or maximum number of extents is specified as zero at file creation, then the size and number of extents are determined by the system. In that case, these item values are calculated using system defaults defaults and do not reflect actual values.

User labels:

Returns the number of user labels defined for the file during creation. If the file is not a disk file, this number is zero. When an old file is opened for overwrite output, the value is not reset and the old user label is not destroyed.

Creator:

Returns the name of the file creator (at least 8 bytes). If the file does not reside on disk, blanks are returned.

An unqualified form of the file owner's name is returned as the value of this itemnum. The file owner is not neccessarily the file's creator. File ownership may be changed using the :ALTFILE command.

A symbolic zero (ASCII 48 in decimal) is returned as the file owner for root directories, accounts, and MPE groups created prior to release 4.5 of MPE/iX.

If the file is not located in the account in which the file owner is a member, a blank file owner name is returned. Item number 85 should be used to obtain the full file owner name instead of item 18.

Label address:

Returns a zero. For compatibility with MPE V/E-based systems only.

Spoolfile device file number:

If the spoolfile device number is larger than 32767, itemnum 38 returns 0 (zero). Use itemnum 78 instead for spoolfile numbers larger than 32767.

Disk device status:

Returns a zero. For compatibility with MPE V/E-based systems only.

DRT number:

Always returns an 8.

Device unit number:

Always returns a 0.

Remote environment number

Note: If using NS 3000/XL RFA (remote file access), specify DSDEVICE ldev# when you are using a DS (point-to-point or X.25) link.

Last modification time (CLOCK format)

Zero is returned as the modification time for root directories, accounts, and MPE groups created prior to release 4.5.

Last modification date (CALENDAR format)

Zero is returned as the modification time for root directories, accounts, and MPE groups created prior to release 4.5.

File creation date (CALENDAR format)

Zero is returned as the modification time for root directories, accounts, and MPE groups created prior to release 4.5.

Last access date (CALENDAR format)

Zero is returned as the modification time for root directories, accounts, and MPE groups created prior to release 4.5.

Terminal type:

NS 3000/XL remote environment ID name

Note: If using NS 3000/XL RFA (remote file access), specify DSDEVICE ldev# when using a DS (point-to-point or X.25) link. A buffer must be provided for the node name (or envid) with the required space of 52 bytes; otherwise, data corruption may occur on variables following itemnum=61 or an FSERR 73, BOUNDS VIOLATION may be returned.

Virtual address of the file:

Applicable for standard disk files only. (Requesting itemnums 64, 74, or 75 for any other file type, RIO, MSG, CIR, causes an error and returns CCL (1).)

Virtual address of file label:

Applicable for standard disk files only. (Requesting itemnums 64, 74, or 75 for any other file type (RIO, MSG, CIR) causes an error and returns CCL (1).)

Hardware path:

Applicable for standard disk files only. (Requesting itemnums 64, 74, or 75 for any other file type (RIO, MSG, CIR) causes an error and returns CCL (1).)

Volume restriction (34 bytes):

The last two characters indicate the type:

Transaction management log set ID

If itemnum 77 = 0 (zero), the file is not attached to the XM (Transaction Management) log.

Spoolfile device file number:

File's pending disposition

HFS syntax filename.

This itemnum returns a null-terminated POSIX-syntax system absolute pathname for the file or directory referenced by filenum. On input the first four bytes of this buffer are interpreted as a 32-bit unsigned integer specifying the maximum buffer size in bytes. This maximum buffer size does not include the four bytes used to represent this size. On output the first four bytes of the buffer represent the pathname length excluding the null-terminator as an unsigned integer. The pathname is returned in the bytes following the pathname length. Bytes beyond the null-terminator should be considered undefined. If the maximum buffer length is incorrect on input, variables allocated near the buffer may be overwritten or a bounds violation may occur. A zero pathname length is returned for unnamed new files and when an error occurs. Zero is the mininum buffer length on input for this itemnum.

         Format of the buffer on input:



         byte     #1   #2   #3   #4 | #1   ...   #N

                +----+----+----+----+----+ ... +----+

                |      maximum      |               |

                |     length = N    |               |

                +----+----+----+----+----+ ... +----+



         Format of the buffer on output:



         byte     #1   #2   #3   #4 | #1   ...   #L   ...   #N

                +----+----+----+----+----+ ... +----+ ... +----+

                |    length =       | /  |     | \0 |     |    |

                |    (L - 1)        |    |     |    |     |    |

                +----+----+----+----+----+ ... +----+ ... +----+

Time of last file access in clock format. The bit assignments are:

Date of last file status change in calendar format. The bit assignements are:

File Owner

The full file owner name. Unused characters are blank filled. A symbolic zero (ASCII 48 in decimal) is returned as the file owner for root directories, accounts, and MPE groups created prior to the POSIX release.

File owner identifier

The file owner identifier (UID). Zero is returned as the file owner ID for root directories, accounts, and MPE groups created prior to the POSIX release.

File group

The file group name. Unused characters are blank filled. A symbolic zero (ASCII 48 in decimal) is returned as the file group for root directories whose GID's have not been assigned.

File group identifier

The file group identifier (GID). Zero is returned as the file group ID for root directories whose GID's have not been assigned.

File type

The following valid file types may be returned:

Record type

The following valid record types may be returned:

This item will return information based upon the record format that is logically assoicated with the specified file designator and will not necessarily be the same as the physical record structure of the file. It is possible with the HPFOPEN intrinsic item 77, Read Format option, to access a file in a different mode than the physical record type. For example, byte stream record files, when opened by default, present variable record instead of the physical byte stream storage, since the file was opened to behave like a variable record file. In order to determine the true physical record structure of a file, use the FFILEINFO item 101.

The current file size in bytes.

The value returned represents the current position of the End-of-File (EOF) and may not reflect the number of bytes actually occupied by the file on disk if the file is sparsely allocated.

KSAM XL file version:

This item returns a value indicating the version of a KSAM XL file. A value of 1 indicates an original type KSAM XL file, and a value of 2 indicates the next generation KSAM XL file. A value of zero is returned if the file is not a KSAM XL file.

NM Plabel:

This item returns a 32-bit NM Plabel of a message file interrupt handler. Interrupts may be enabled on message files by calling the FCONTROL intrinsic with item 48 and the Plabel address.

MPE/iX device type:

This item returns the following values for the following types of devices:

Close-on-Exec

This item returns a value indication whether or not this filenum is closed if one the POSIX.1 exec() family of functions if called. A value of 1 means that the file is closed on an exec() call, while a value of 0 indicates the file will survive across exec() calls.

POSIX Append mode

This item returns a value indicating whether or not this filenum has the POSIX.1 append mode flag set. When the append mode flag is set on files that support this feature, all writes occur at the end of the file, although reads may occur anywhere in the file. A value of 1 indicates that the POSIX.1 append mode is on, while a value of 0 indicates the append mode is off.

The only time that the POSIX.1 append mode is valid is when a file has been oepned for byte stream access (HPFOPEN option 77 with a value of 2).

POSIX non-block mode

This item returns a value indicating whether or not this filenum has the POSIX.1 non-block flag set. When the non-block flag is set, on files that support this feature, reads, writes, and opens can be affected in a file dependent manner. In general, operations that would otherwise have impeded the caller results in immediate return when this flag is set. A value of 1 indicates the non-block flag is set, while a value of zero indicates the flag is not set.

The only time the non-block flag is valid is for pipes and FIFO's.

Carriage Control

This item returns a value indicating whether or not the carriage control option is in effect for this file. If carriage control is on, a value of 1 is returned. Otherwise, a value of 0 is returned.

Setuid Flag

This item returns a value indicating whether or not this file has the setuid flag turned on. When the setuid flag is on for a program file, the program will execute under the user who owns the file rather than under the user who invoked the program. A value of 1 indicates that the setuid flag is on; a value of 0 indicates the flag is off.

Setgid Flag

This item returns a value indicating whether or not the file has the setgid flag turned on. When the setgid flag is on for a program file, the program will execute with the GID membership of the file rather than the GID membership of the process that invoked the program. A value of 1 indicates that the setgid flag is on; a value of 0 indicates that the flag is off.

Physical record type

This item returns the record type of the file's physical record layout. It is possible through the HPFOPEN option 77, Read Format option, to emulate a different record structure than the actual physical record structure of the file. To get the current logical record view, use FFILEINFO item 90.

The following values will be returned by this item:

Dissallow file equation flag

This item returns a value indicating whether or not file equations were disallowed when the file was opened. A value of zero indicates that file equations were allowed; a value of 1 indicates file equations were disallowed. This item is identical to bit 5:1 of the foptions.

MPE Tape labels flag

This item returns a value indicating whether or not a tape was opened labeled or unlabeled. A value of 0 indicates an unlabeled tape; a value of 1 indicates a labeled tape. This item is identical to bit 6:1 of the foptions.

File designator type

This item returns the file designator type for this file. It is identical to bit 10:3 of the foptions. The following values can be returned by this item:

ASCII/Binary flag

This item returns the setting of the file's ASCII/Binary flag. A value of 0 indicates that this is a binary file; a value of 1 indicates that this is an ASCII file. This item is identical to bit 13:1 of the foptions.

File domain

This item returns the domain in which the file currently resides. It is identical to bit 14:2 of the foptions, and can return the following values: