Use this system macro to obtain information about the characteristics of a
specific symbolic file address as follows:
- The address is a fixed or pool address.
- The record is small, large or 4 K in size.
- The record is duplicated or nonduplicated.
- For a pool file address reference format (FARF) address, the address is
short-term or long-term.
- If a fixed FARF address is common to all processors, I-streams, and users
of the subsystem, or is unique to a combination of processors, I-streams, and
users of the subsystem.
- If the address is a FARF3, FARF4, FARF5, or FARF6 address.
Required Authorizations
|
Key0
| Restricted
| System
| Common Storage
|
| X
|
|
|
Format
Notes:
- file_address
- extended_info_address
- label
- A symbolic name can be assigned to the macro statement.
- file_address
- Location of the file address.
- Dx
- A file address reference word (D0-DF) which contains the file
address.
- (Rx)
- A register that contains the file address. For E-type
programs this may be R0-R7. For control programs (CPs), this may
be R1-R10, R14, or R15.
- ADDR=(Rz)|label1
- This parameter specifies the general register containing the location, or
a label indicating the location, of an 8-byte file address. For
E-type programs, this can be R1-R7. For CPs, this can be
R1-R10, R14, or R15.
- extended_info_address
- This parameter specifies the address of where the extended information is
to be returned.
- (Ry)
- A register specifying the address where the extended information is to be
returned. For E-type programs this may be R1-R7.
For CPs, this may be R0-R10, R14, or R15.
- scon_label
- A label that is resolvable as an S-type constant. For E-type
programs, the SCON base must be in the range R1-R7 or R9 if an entry
control block (ECB) work area is used. For CPs, the SCON base may be
any register.
The address specified by the second positional parameter points to a data
area structured according to DSECT DCTSON.
Entry Requirements
- If an ECB data level is specified to hold the file address, R9 must
contain the address of an ECB.
- The symbolic file address must be contained in file address reference word
(FARW) CE1FMx, where x is the specified ECB data level or it
must be contained in a register. If this information is not provided,
the ADDR parameter must be coded to point to an 8-byte file address.
Return Conditions
- Control is returned to the next sequential instruction.
- Condition code 0 is returned if the file address is successfully
decoded; condition code 1 if it is not.
- The FARW at the specified level, if used, is unchanged.
- For E-type programs, R0-R7 are saved in the ECB at CE1SVR and
restored on return from the service routine. For CP programs, all
registers are preserved across the macro call except R0 and R1 that are used
for parameters and R14 and R15 that are used for linkage to the service
routine.
Programming Considerations
This macro can be run on any I-stream.
Examples
None.