|
|
|
Returns global file information.
Syntax
REC I32A @64A
AIFFILEGGET ( overall_status, itemnum_array, item_array,
RECA REC REC B
itemstatus_array, UFID, filename, tempfile,
I32 REC REC
user_id, path_identifier, pathname );
Parameters
- overall_status
- record by reference (required)
Returns the overall status of the call. A zero indicates a successful
call. A negative value indicates an error in the overall call, not
specific to any particular item. A positive value indicates the last
element in itemstatus_array, signaling an error condition. Refer to
appendix A for meanings of status values.
Record type: status_type (Refer to appendix B.)
- itemnum_array
- 32-bit signed integer array by reference (required)
An array of integers where each element is an item number indicating the
information to be returned to a data structure pointed to in the
corresponding element in item_array. If n item numbers
are being requested, element n+1 must be a zero to
indicate the end of the element list.
- item_array
- 64-bit address array by reference (required)
An array where each element is a 64-bit address pointing to a data
structure where information is returned. Information and its required
data type are defined by the item number passed in the corresponding
element in itemnum_array.
Array type: globalanyptr
- itemstatus_array
- record array by reference (required)
An array where each element returns the status of the operation
performed in the corresponding element in item_array. A zero indicates a
successful operation. A negative value indicates an error condition. A
positive value indicates a warning. Refer to appendix A for meanings of
status values.
Array type: status_type (Refer to appendix B.)
- UFID
- record by reference (optional)
Required if filename is omitted. Passes the UFID of the
file for which information is desired. Use this parameter if performance
is a concern.
Note that this parameter is not adequate for identifying the pathname
for an HFS syntax file. You should specify
path_identifier instead of this item when you are
interested in both MPE syntax and HFS syntax files.
Record type: ufid_type (Refer to appendix B.)
Default: nil
- filename
- record by reference (optional)
Passes the fully qualified name of the file for which information is
desired. The name in each element of the record filename_type
must be left-justified and padded with blanks. In addition, characters
must be in the correct case (uppercase and/or lowercase).
If the UFID is omitted and you are interested only in those files that
can be represented by MPE syntax, this parameter is required.
For HFS syntax files, the pathname parameter should be
specified.
Record type: filename_type (Refer to appendix B.)
Default: nil
- tempfile
- boolean by value (optional)
Indicates whether or not the file specified is a temporary file. If true,
the file is a temporary file. If false, or if this parameter is omitted,
the file is a permanent file. (If the file UFID is passed in the
UFID parameter, this parameter is ignored.)
Default: false
- user_id
- 32-bit signed integer by value (optional)
The user ID assigned to a vendor at the time of purchase of the
Architected Interface Facility: Operating System product. If it is not
passed, the caller must have previously called AIFACCESSON.
Default: 0
- path_identifier
- record by reference (optional)
Passes the unique path_identifier of the MPE syntax or
HFS syntax file for which information is desired. Use this parameter if
performance is a concern and you are interested in either an MPE syntax
or HFS syntax file. Note that when specifying this parameter, you must
specify item 5036 to get the corresponding pathname for an HFS syntax
file (for example, /SYS/PUB/dirc/pxfile).
Record type : path_identifier (Refer to appendix B.)
Default: nil
- pathname
- record by reference (optional)
Passes the pathname of the file (MPE syntax or HFS syntax) for which
information is desired. If the path_identifier is
omitted and you are interested in both MPE syntax and HFS syntax files,
this parameter is required. If you specify both this parameter and the
filename parameter, then the filename
parameter is ignored. The first word in the pathname specifies the
length of the name.
Record type : pathname_type (Refer to appendix B.)
Operation Notes
Use UFID instead of filename for greater
performance.
The hierarchical file system (HFS) was incorporated into MPE/iX with release
4.5. The following Operation Notes describe dealing with MPE syntax and HFS
syntax files.
MPE Syntax Files
When interested in only those files that can be represented by MPE syntax, the
following item keys and items should be used. These items continue to work
exactly as they did before the introduction of the hierarchical file system.
- Items
- Item 5002 - UFID
- Item 5001 - file_name
Note that the UFID key and the UFID item still return valid data for an HFS
syntax file since an UFID is still unique for every file on the system;
however, the UFID alone is not enough information to identify a unique file
name for an HFS syntax file since the file name is no longer kept in the file
label.
MPE Syntax and HFS Syntax Files
When interested in all files, the following item keys and items should be used:
- Items
- Item 5037 - path identifier
- Item 5036 - pathname
 |
NOTE: Only one item key should be specified. If multiple item keys
are specified, then only one key is used and the rest are ignored. The
following keys are in order of precedence:
-
- path_identifier
- pathname
- UFID
- filename
For example, if you specify both the pathname and the
UFID parameters, the UFID parameter is
ignored. If you specify the path_identifier and the
pathname parameters, then the pathname
parameter will be ignored.
|
|
