FFILEINFO

Provides information about the characteristics of a file.

Syntax

I16V I16V *

FFILEINFO(filenum[,itemnum,item

[,itemnum,item

[,itemnum,item]]]]]);

Use

The FFILEINFO intrinsic returns information about a file located on any device. The file must be opened by the calling process at the time of the FFILEINFO call. You specify the type of information you want to access by using an item number that corresponds to that information as the value of itemnum. The file information requested is then returned to your program in the item parameter that constitutes the other half of the itemnum/item pair.

The itemnum and item parameters must always be specified in pairs. You can retrieve up to 5 types of information in one FFILEINFO call by specifying 5 itemnum/item pairs.

Table 8-9 “Selected Item Values Returned by FFILEINFO” shows some of the information options available through a call to FFILEINFO. Only the subset of options most applicable to files in asynchronous devices are listed here. For a complete list of available options, see the MPE/iX Intrinsics Reference Manual.

Parameters

filenumn

16-bit signed integer by value (required)

The file number of the file about which information is requested.

itemnum

16-bit signed integer by value (optional)

Passes the item number (in any order) of an information option. You can request up to 5 options in one call.

item

type varies (optional)

Returns information about the file as pertains to the option specified in the related filenum.

Table 8-9 Selected Item Values Returned by FFILEINFO

Item No.	Info. Returned In Item	Type
1	Actual file designator of the file, in the format: `filename.groupname.accountname`	Character array, at least 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` cannot be expressed using MPE name semantics a CCL condition code is returned. Calling FCHECK for `filenum` after this error occurs, will result in error.
2	File options (refer to the summary figure listing `foptions` bit settings).	16-bit unsigned integer by reference.
3	Access options (refer to the summary figure listing `aoptions` bit settings).	16-bit unsigned integer by reference.
5	Device type indicated by: bits (8:8) = device type.	16-bit signed integer by reference.
6	Local device number of the device where the file label resides.	16-bit unsigned integer by reference.
12	Number of logical records passed to and from your program during the current access.	32-bit signed integer by reference.
13	Number of buffered physical I/O operations performed since the last FOPEN/HPFOPEN call (records).	16-bit signed integer by reference.
43	Environment file name.	Character array, at least 36 bytes in length.
50	Real device number of the file.	16-bit unsigned integer by reference.
60	Terminal type, defined as follows: 0-File's associated device is not a terminal. 1-Configured as standard hardwired terminal. Could also be TELNET/iX device. 2-Configured as a modem-connected terminal. Could also be TELNET/iX device. 4-DTC PAD Terminal. 5-NS Virtual Terminal.	16-bit signed integer by reference.

Condition Codes

CCE: Request granted.
CCG: Not returned by this intrinsic.
CCL: Access or calling sequence error.

Additional Discussion

See also Getting System Information and the MPE/iX Intrinsics Reference Manual. See the discussion of FOPEN in this manual for a description of aoption and foption values.

FFILEINFO

Technical documentation

» Table of Contents

» Glossary

» Index

Syntax

Use

Parameters

Condition Codes

Additional Discussion