Using KSAM/XL and KSAM 64 (32650-90886)

Chapter 9 111
KSAM Intrinsics
FLABELINFO
FLABELINFO
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 the name of the file using either MPE syntax (the default) or HFS
syntax. The file name must be terminated by a nonalphanumeric
character other than a period (.), a slash (/), a hyphen (-), and an
underscore (_).
If 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.
If HFS syntax, the file name must start with either a dot (.) or a slash (/).
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. Valid values are:
Value Meaning
0 Use file equation (if one exists)
1 Must use file equation (error if one does not exist)
2 Ignore existing file equations