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 result in error.

File options: Returns file characteristics (refer to the FFfoption 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 result in error.

Access options: Returns file access information (refer to the FFaoption 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:

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 (see engineer).

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.

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.

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.

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.

Volume restriction (34 bytes): The last two characters indicate the type:

Spoolfile device file number:

File's pending disposition

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.

(add drawing of Format of the buffer on input)

32-bit signed integer by reference. Time of last file access in clock format. The bit assignments are:

16-bit unsigned integer by reference. Date of last file status change in calendar format. The bit assignements are:

32-byte character array by reference. 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.

32-bit signed integer by reference. 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.

32-byte character array by reference. 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.

32-bit signed integer by reference. 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.

32-bit unsigned integer by reference. File type:

The following valid file types may be returned:

32-bit unsigned integer by reference. Record type:

The following valid record types may be returned:

64-bit signed integer by reference. 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.

32-bit signed integer by reference. 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.

32-bit unsigned integer by reference. 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.

32-bit signed integer by reference. MPE/iX device type:

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

32-bit signed integer by reference. 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.

32-bit signed integer by reference. 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).

32-bit signed integer by reference. 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.