FLABELINFO

File name (8 bytes):

The file name component for the file referenced in formaldesig is returned as the value. If the file name is not expressible using MPE-only semantics, a file system error code (391) is returned in the associated itemerror.

Group name (8 bytes):

The group name component for the file referenced in formaldesig is returned as the value. If the group name is not expressible using MPE-only semantics, a file system error code (391) is returned in the associated itemerror.

Account name (8 bytes):

The account name component for the file referenced in formaldesig is returned as the value. If the account name is not expressible using MPE-only semantics, a file system error code (391) is returned in the associated itemerror.

File creator name (8 bytes):

An unqualified form of the file owner's name is returned as the value. The file owner is not necessarily the file's creator.

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

If the file is not located in the account where the file owner is a member, a blank file owner name is returned. Use itemnum=43 to obtain the full file owner name.

Security matrix for access:

Returns the file's security matrix. This value does not indicate the actual security enforced for a file, since group and account security masks can also restrict access. This field is ignored if an ACD is active on a file.

File creation date:

The date in CALENDAR intrinsic format. Either creator (C) or manager (AM if file is within account, otherwise SM) access required.

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

Last access date:

The date in CALENDAR intrinsic format. May not be up-to-date when the file is open.

Zero is returned as the last access date for root directories, MPE accounts, and MPE groups created prior to release 4.5.

Last modification date:

The date in CALENDAR intrinsic format. May not be up-to-date when the file is open.

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

Number of user labels written:

May not be up-to-date when the file is open.

Number of user labels available:

May not be up-to-date when the file is open.

Total number of logical records possible in the file:

Equivalent to the file limit measured in logical records.

File options:

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 cannot be represented by foption. If the object referenced by filenum is is an object, MPE error 399 is returned in the associated itemerror.

Refer to the foption figure.

Record size:

Maintained for compatibility with MPE V/E-based systems. (If a zero is returned, use itemnum 30 instead.)

Block size:

Maintained for compatibility with MPE V/E-based systems. (If a zero is returned, use itemnum 31 instead.)

Maximum number of extents:

Maintained for compatibility with MPE V/E-based systems. (If a zero is returned, use itemnum 32 instead.)

Last extent size:

Indicates sectors. May not be up-to-date when the file is open.

Extent size:

Indicates sectors. (If a zero is returned, use itemnum 32 instead.)

Number of logical records in file:

Equivalent to EOF. May not be up-to-date when the file is open.

File allocation time:

The time when file was last restored (in CLOCK intrinsic format).

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

File allocation date:

The date when the file was last restored (in CALENDAR intrinsic format).

Zero is returned as the file allocation date for root directories, MPE accounts, and MPE groups created prior to release 4.5.

Number of open/close records:

MSG files only. May not be up-to-date when the file is open.

Last modification time:

The time when the file was last modified (in CALENDAR intrinsic format). May not be up-to-date when the file is open.

First user label (user label 0) (256 bytes):

May not be up-to-date when the file is open. For all but PM files, Manager capabilitiy (AM if file is within account, otherwise SM) or read/write (R/W) access required. For PM files, Manager capability is required; otherwise, FLABELINFO fails with FSERR93.

Total number of bytes allowed in file:

Equivalent to the file limit measured in bytes. May not be up-to-date when the file is open.

Start of file offset:

Indicates the byte offset where user data starts.

File lockword (8 bytes):

Returned if you are the file creator, account manager, or system manager.

Volume restriction (34 bytes):

The last two characters indicate the type of restriction, as follows:

Volume set names (32 bytes):

No restrictions.

Transaction management log set id (4 bytes)

No restrictions.

Terminated HFS-syntax system absolute pathname:

Upon input, the first four bytes are interpreted as a 32-bit unsigned integer specifying the maximum available buffer size in bytes. This maximum available buffer size does not include the four bytes used to represent this size. Upon output, the first four bytes represent the pathname length excluding the null terminator as a 32-bit unsigned integer. The pathname is returned in bytes following the pathname length. Bytes beyond the pathname terminator are undefined. If the maximum available buffer size is incorrect upon input, variables allocated near the buffer can be overwritten or a bounds violation could occur. A zero pathname length is returned for unnamed new files and when an error occurs. Zero is the minimum buffer length upon 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 (clock format):

The bit assignments are:

   bits 0-7 = hours

   bits 8-15 = minutes

   bits 16-23 = seconds

   bits 24-31 = tenths of seconds

Time of last file status change (clock format):

The bit assignments are:

   bits 0-7 = hours

   bits 8-15 = minutes

   bits 16-23 = seconds

   bits 24-31 = tenths of seconds

Date of the last file status change (calendar format):

The bit assignments are:

   bits 0-7 = year of century

   bits 8-15 = day of the year

File owner (32 bytes):

The full file owner name. Unused characters are filled with blanks. 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.

File owner identifier:

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

File group (32 bytes):

The file group name. Unused characters are filled with blanks. A symbolic zero (ASCII 48 in decimal) is returned as the group for root directories where GIDs have not been explicitly assigned.

File group identifier:

The file group identifier (GID). Zero is returned as the group ID for root directories where GIDs have not been explicitly assigned.

File type:

Following are valid file types that can be returned:

   0 = Ordinary file

   1 = KSAM/3000

   2 = RIO

   3 = KSAM XL

   4 = CIR

   5 = Native Mode Spool File

   6 = MSG

   7 = N/A

   8 = N/A

   9 = Directory

   10-11= N/A

   12 = Pipe

   13 = FIFO

   14 = Symbolic Link

   15 = Device Link

Record type:

Following are valid record types that can be returned:

   0 = fixed

   1 = variable

   2 = undefined

   3 = spool block

   4 = root directory

   5 = N/A

   6 = account directory

   7 = group directory

   8 = N/A

   9 = byte stream

   10 = hierarchical directory

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 number of a KSAM XL file. A value of 1 indicates an original type KSAM XL file. 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.

KSAM XL Parameters:

This item returns the ksamparam for KSAM XL files, which is an array that specifies the characteristics for up to 16 keys for the file.

MPE/iX Device Type:

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

   0=Disk device

   1=Tape device

   2=Terminal device

   3=Printer device

   4=Remote device

   5=Ports device 

   6=Reserved 

   7=Streams device

   8=Sockets device

Secure/Release:

This item returns a value indicating whether the file is currently secured or released. A value of 1 indicates that the file is secured. A value of zero indicates that the file is released.

Setuid flag

This item returns a value indicating whether or not the setuid flag is on for the specified file. When the setuid flag is on for a program file (the value is 1), the program will execute under the identity of the file's owner rather than assuming the identity of the process that invoked the program. A value of zero indicates the flag is off.

Setgid flag

This item returns a value indicating whether or not the setgid flag is on for the specified file. When the setgid flag is on for a program file (the value is 1), the program will execute with the GID membership of the file rather than assuming the GID membership of the invoking process. A value of zero indicates that the flag is off.