Index Suppression Exit Support › Interface

Interface

CA IDMS DLI Transparency expects an index exit routine to perform standard assembler linkage and provides a save area in register 13 for this purpose. Upon entry, the exit routine must save the contents of register 13. Upon return, it must restore the contents of registers 1 through 14. Under no circumstances should the routine alter data addressed by the registers at entry.

CA IDMS DLI Transparency initializes the registers to the following values:

• Register 2 - Address of the index pointer record
• Register 3 - Address of the index exit PARMS DSECT (described in figure 73 available further below)
• Register 4 - Address of the index source record
• Register 13 - Address of the save area
• Register 14 - Return address in CA IDMS DLI Transparency
• Register 15 - Address of the index exit entry point

The exit routine controls CA IDMS DLI Transparency's action by the return code it places in register 15, as follows:

• 4 ── Suppresses the index pointer record
• 0 ── Stores the index pointer record as part of the secondary index relationship

Figure 73 shows the format of the index exit PARMS DSECT (NDXXITDS DSECT), as passed to the exit routine.

                        NDXXITDS DSECT
   Offset   Field Name        Type/             Description
                                     Length
       0    NDXRECNM     DS    CL8        Index pointer record name
       8    NDXFLDNM     DS    CL8        Index definition field name
      16    NDXXITNM     DS    CL8        Index exit name
      24    NDXXITEP     DS    A           Index exit entry point

Figure 73. Index Exit PARMS DSECT