HPlogo MPE/iX Intrinsics Reference Manual > Chapter 5 Command Definitions (FCONTROL - FLOCK)

FLABELINFO

MPE documents

Complete PDF
Table of Contents
Index

Edition 7 E0701 ♥
Edition 7 E0300
Edition 6 E0195

NM and CM callable.

Returns information from the file label of a disk file.

Syntax



              CA           I16V  I16
  FLABELINFO (formaldesig, mode, fserrorcode,
              I16A     REC   I16A
              itemnum, item, itemerror);

Parameters


formaldesig

character array (required)

Passes a formal file designator interpreted according to MPE-escaped semantics. The file name must be terminated by a nonalphanumeric character other than a period (.), a slash (/), a hyphen (-), and an underscore (_). The file referred to by formaldesig can be either an MPE file (i.e., one that uses MPE syntax), or it can be an HFS syntax name beginning with a dot or a slash.

If formaldesig is an escaped pathname:

  • you cannot reference remote files

  • it cannot express a name equivalent to filename:envid

  • you cannot use the device parameter (device=node#) to specify the remote location of a device

If formaldesig follows MPE syntax, the file name can include password, group, and account specifications. The file name can backreference a file equation and optionally be preceded by an asterisk.

The file referred to by formaldesig may reside either in an MPE group or in an HFS directory. For files located in HFS directories, traverse directory entries (TD) access is required to all directories specified in formaldesig. If there is no TD access, FLABELINFO fails and a file system error code (398) is returned in the fserrorcode parameter.

If the file can be named using both MPE syntax and HFS syntax (for example, FILEA.MYGROUP.MYACCT and /MYACCT/MYGROUP/FILEA), the file can be either permanent or temporary. If a temporary and a permanent file have the same name, FLABELINFO returns information about the temporary file only.

mode

16-bit signed integer by value (required)

Passes an option specifying the valid backreferencing to file equations for the file.

BitsValue/Meaning
0:11Reserved for future use.
11:1Symbolic Link Traversal
0 To traverse through symbolic links, if they exist.
1 Do not traversing through symbolic links, if they exist.
12:2Caller Privilege Level
Allows the caller to pretend to be less privileged. The privilege level is passed in this field.
14:2File Equations
0 Use file equations if they exist.
1 A file equation must be used.
2 Do not use a file equation.

fserrorcode

16-bit signed integer by reference (required)

Returns a value indicating whether an error or warning occurred when FLABELINFO attempted to return requested information:

  • A value of zero indicates that no errors were encountered.

  • A positive value is a file system error code and indicates that an error was encountered and no information was returned in item.

  • A -1 indicates that an item error or warning has occurred. Check the itemerror parameter to determine which item(s) has an error/warning and what it is.

itemnum

16-bit signed integer array (required)

Specifies which item value is to be returned. (Refer to Table 5-6 "FLABELINFO Itemnum/Item Values".)

To indicate the end of the list, place a zero in the element following the last itemnum.

item

record (required)

Returns the value of the item specified in the corresponding itemnum. (Refer to Table 5-6 "FLABELINFO Itemnum/Item Values".)

Itemnum/items are paired such that the nth field of the item record corresponds to the nth element of the itemnum array.

itemerror

16-bit signed integer array (required)

Returns an error number corresponding to the items specified in the itemnum array. The itemnum/item and itemerror parameters are paired such that the nth element of the itemerror array corresponds to the nth element of the itemnum array.

If a value in the itemerror array is negative, a warning exists for the corresponding item. If the value is positive, an error was detected for the corresponding item. The absolute value of each value is a file system error number.


Table 5-6 FLABELINFO Itemnum/Item Values

Condition Codes


CCE (2)Request granted.
CCG (0)Not returned.
CCL (1)Request denied. An error occurred. Refer to the fserrorcode and itemerror parameters for more information.

Related Information


Intrinsics FFILEINFO, FGETINFO, FGETKEYINFO, FRELATE
Manuals Accessing Files Programmer's Guide




FINTSTATE


FLOCK