OpenTP1 Version 7 Programming Reference COBOL Language

[Contents][Index][Back][Next]

TPINTRO - COPY files for the XATMI interface

Description

The following return codes and setting definitions are used by the COBOL XATMI routines. XATMI interface providers supply these definitions in the four COPY files listed below. Shown for each are the minimum set of record definitions and settings that must be defined in each COPY file.

<<The COBOL records shown below are stored in the $DCDIR/include/COBOL/ directory. When compiling the UAP, you must designate this directory as the location of the COPY file. For details about the specifications needed for compilation, see a manual for the COBOL language version you are using.>>

*
* TPSTATUS.cbl
*
 05  TP-STATUS  PIC S9(9) COMP-5.
           88  TPOK            VALUE 0.
           88  TPEBADDESC      VALUE 2.
           88  TPEBLOCK        VALUE 3.
           88  TPEINVAL        VALUE 4.
           88  TPELIMIT        VALUE 5.
           88  TPENOENT        VALUE 6.
           88  TPEOS           VALUE 7.
           88  TPEPROTO        VALUE 9.
           88  TPESVCERR       VALUE 10.
           88  TPESVCFAIL      VALUE 11.
           88  TPESYSTEM       VALUE 12.
           88  TPETIME         VALUE 13.
           88  TPETRAN         VALUE 14.
           88  TPEGOTSIG       VALUE 15.
           88  TPEITYPE        VALUE 17.
           88  TPEOTYPE        VALUE 18.
           88  TPEEVENT        VALUE 22.
           88  TPEMATCH        VALUE 23.
 05  TP-EVENT  PIC S9(9) COMP-5.
           88  TPEV-NOEVENT    VALUE 0.
           88  TPEV-DISCONIMM  VALUE 1.
           88  TPEV-SENDONLY   VALUE 2.
           88  TPEV-SVCERR     VALUE 3.
           88  TPEV-SVCFAIL    VALUE 4.
           88  TPEV-SVCSUCC    VALUE 5.

The following COBOL record is used whenever sending or receiving application data. REC-TYPE indicates the type of data record that is to be sent. SUB-TYPE indicates the name of the sub-type for a particular type. LEN contains the amount of data to send and the amount received.

*
* TPTYPE.cbl
*
 05  REC-TYPE       PIC X(8).
           88  X-OCTET         VALUE "X-OCTET".
           88  X-COMMON        VALUE "X-COMMON".
 05  SUB-TYPE       PIC X(16).
 05  LEN            PIC S9(9)  COMP-5.
           88  NO-LENGTH       VALUE 0.
 05  TPTYPE-STATUS  PIC S9(9)  COMP-5.
           88  TPTYPEOK        VALUE 0.
           88  TPTRUNCATE      VALUE 1.

The following COBOL record is used by functions to pass settings to and from the communication resource manager.

*
* TPSVCDEF.cbl
*
 05  COMM-HANDLE        PIC S9(9)    COMP-5.
 05  TPBLOCK-FLAG       PIC s9(9)    COMP-5.
           88  TPBLOCK      VALUE 0.
           88  TPNOBLOCK    VALUE 1.
 05  TPTRAN-FLAG        PIC S9(9)    COMP5.
           88  TPTRAN       VALUE 0.
           88  TPNOTRAN     VALUE 1.
 05  TPREPLY-FLAG       PIC S9(9)    COMP5.
           88  TPREPLY      VALUE 0.
           88  TPNOREPLY    VALUE 1.
 05  TPTIME-FLAG        PIC S9(9)    COMP5.
           88  TPTIME       VALUE 0.
           88  TPNOTIME     VALUE 1.
 
 05  TPSIGRSTRT-FLAG    PIC S9(9)    COMP5.
           88  TPNOSIGRSTRT VALUE 0.
           88  TPSIGRSTRT   VALUE 1.
 05  TPGETANY-FLAG      PIC S9(9)    COMP5.
           88  TPGETHANDLE  VALUE 0.
           88  TPGETANY     VALUE 1.
 05  TPSENDRECV-FLAG    PIC S9(9)    COMP5.
           88  TPSENDONLY   VALUE 0.
           88  TPRECVONLY   VALUE 1.
 05  TPNOCHANGE-FLAG    PIC S9(9)    COMP5.
           88  TPCHANGE     VALUE 0.
           88  TPNOCHANGE   VALUE 1.
 05  TPSERVICETYPE-FLAG PIC S9(9)    COMP5.
           88  TPREQRSP     VALUE 0.
           88  TPCONV       VALUE 1.
 05  SERVICE-NAME       PIC X(15).

The following COBOL record is used by TPRETURN to indicate the status of the transaction.

*
* TPSVCRET.cbl
*
 05  TP-RETURN-VAL  PIC S9(9)    COMP-5.
           88  TPSUCCESS    VALUE 0.
           88  TPFAIL       VALUE 1.
 05  APPL-CODE      PIC S9(9)    COMP-5.