The EXITWS copybook

Here we describe the copybook EXITWS in which exit program mandatory fields are defined.

*****************************************************************
*                                                               *
* WORKING-STORAGE - TABLESONLINE EXIT PROGRAM REQUIRED FIELDS   *
*                                                               *
*****************************************************************
*
 01  H-PROGRAM-CONTROL-AREA.
     05  H-COMMAND-AREA.
         10  H-COMMAND               PIC X(2).
         10  H-TABLE                 PIC X(8).
         10  H-FOUND                 PIC X(1).
         10  H-INDIRECT              PIC X(1).
         10  FILLER                  PIC X(2).
         10  H-ERROR                 PIC S9(4) COMP.
         10  H-COUNT                 PIC S9(9) COMP.
         10  H-LOCK                  PIC X(8).
* REL 5 OR LATER COMMAND EXTENSION
         10  H-ITEM-LENGTH           PIC S9(9) COMP.
         10  H-ACTUAL-ITEM-LENGTH    PIC S9(9) COMP.
         10  H-FG-KEY-LENGTH         PIC S9(4) COMP.
         10  H-FUNCTION-ID           PIC S9(4) COMP.
         10  H-FUNCTION-PARM.
             15  H-DATE              PIC 9(8).
             15  RESERVED            PIC X(20).
         10  H-RETURNEDABS-GEN       PIC S9(4) COMP.
         10  H-ERROR-SUBCODE         PIC S9(4) COMP.

A tableBASE command area for the exit program so that it can use tableBASE services without affecting the tablesONLINE/CICS command area.

     05  H-LIB-LIST                  PIC X(80).
     05  H-STATUS-SAVE               PIC X(80).

An area to store a copy of the library concatenation list so that if the exit program alters it, the original can be restored before returning to tablesONLINE/CICS.

     05  H-RETURN-CODES.
         10  H-NORMAL-RETURN         PIC X VALUE ' '.
         10  H-BYPASS-RETURN         PIC X VALUE 'Y'.
         10  H-INFO-RETURN           PIC X VALUE 'I'.
         10  H-WARN-RETURN           PIC X VALUE 'W'.
         10  H-ERROR-RETURN          PIC X VALUE 'E'.
         10  H-ABORT-RETURN          PIC X VALUE 'A'.
         10  FILLER                  PIC X VALUE ' '.
     05  H-ABEND-STATUS-SWITCHES.
         10  H-ABEND-STATUS-OFF      PIC X(8) VALUE 'NN      '.
         10  H-ABEND-STATUS-ON       PIC X(8) VALUE 'YN      '.

Constants used in communicating with tablesONLINE/CICS.

     05  H-CONSTANTS.
         10  H-PROG-DKTBMSTK         PIC X(8)  VALUE 'TBDKMSTK'.
         10  H-DFHCOMM-MSGLENGTH     PIC S9(4) COMP VALUE +148.

The program to call for message handling and the size of its parameter area.

         10  H-MSG-INVALID-CALL      PIC X(7)  VALUE 'TB-9000'.
         10  H-MSG-DEBUG-CALL        PIC X(7)  VALUE 'TB-9001'.