Use this system macro to access a specific record identifier (ID) in the
record ID attribute table (RIAT). If the specified record ID is in the
RIAT, this macro moves the RIAT record to the caller's work area.
If the specified record ID is not found in the RIAT, this macro
sets the address of the RIAT section in the caller's work area to zero
(the DCTRIT RITADDR field).
Format
- CHK
- Parameter used for LEBIC call. This parameter is valid only when
RITID is invoked by a CP segment.
- YES
- Integrity checking is required on the LEBIC macro call.
- NO
- Integrity checking is not required on the LEBIC macro call.
- XBI
- Program/data base index, used by LEBIC macro. The default is
DBI. This parameter is valid only when RITID is invoked by a CP
segment.
- DBI
- CE1DBI is to be used as first parameter in LEBIC macro.
- PBI
- CE1PBI is to be used as first parameter in LEBIC macro.
- FADC=N|Y
- FADC=Y is used by the CP file access code to generate module specific RIAT
support code. The default is FADC=N. FADC=Y is restricted to the
control program (CP).
- Note:
- The interface requirements when this parameter is specified as Y are module
specific.
- DEFAULT=Y|N
- DEFAULT=Y or DEFAULT=N along with FADC=Y is used by the CP file access
code to generate module specific RIAT support code. DEFAULT has no
meaning when FADC=Y is not coded.
- FAST=N|Y
- Specifies whether control program (CP) routines are used for
processing. This parameter is ignored unless used within the control
program (CP) and FADC=1. The default is FAST=N.
Entry Requirements
There are two sets of entry requirements:
- The first set, the work area option, can be used by real-time programs or
by the control program. R1 points to the caller's work
area. The minimum length of the work area must be RITIDLN as defined in
DCTRIT. The RITRID field in the work area must be set to the record ID
to be searched for in the RIAT. This ID must be in hexadecimal format
(for example, X'1355') or character format (for example,
C'AS').
- The second set, the FADC option, can be used only by the control
program. The CHK, XBI, DEFAULT, and FAST parameters apply to the FADC
option.
Return Conditions
- Work area option
The work area passed by the caller will contain the RIAT item. The
RIAT item in the work area maps to the RTID DSECT (contained in
DCTRIT). RITADDR will contain the address of the item in the RIAT
table.
If the specified ID is not found in the RIAT, the address of the ID entry
in the RIAT (accessed by field RITADDR in the RTID DSECT) in the work area
will be set to zero. The RIAT item in the work area will contain all
the default values located in the RIAT header.
Registers 0 to 15 are preserved across this macro call.
- FADC option
The appropriate fields in the MIOB block will be set.
Programming Considerations
The RITID macro can be processed on any I-stream.
Examples
None.