PCE - Program control EXEC argument list

      CONTROL BLOCK NAME = DFHPCEDS
      DESCRIPTIVE NAME = CICS TS Program Control EXEC argument list
           Licensed Materials - Property of IBM
            Restricted Materials of IBM 
           5655-Y04
           (C) Copyright IBM Corp. 1990, 2004 
      PROGRAMMING INTERFACES
          The following fields are part of the Product-sensitive
          Programming Interface.
                   PC_ADDR0
                   PC_ADDR1
                   PC_ADDR2
                   PC_ADDR3
                   PC_ADDR4
                   PC_ADDR5
                   PC_ADDR6
                   PC_ADDR7
                   PC_ADDR8
                   PC_ADDR9
                   PC_ADDRA
                   PC_GROUP
                   PC_FUNCT
                   PC_BITS1
                   PC_BITS2
                   PC_EIDOPT5
                   PC_EIDOPT6
                   PC_PROGRAM
                   PC_LENGTH
                   PC_INPUTMSGLEN
                   PC_DATALENGTH
                   PC_SYSID
                   PC_TRANSID
                   PC_CHANNEL
           All equates for values of EIBRCODE, EIBRESP and EIBRESP2
           form part of the General-purpose Programming Interface.
      FUNCTION =
           To define fields that may be of use to Program Control
           User Exits:-
             (1) The Command Level Parameter List.
             (2) EIBRCODE, EIBRESP and EIBRESP2 values.
             (3) The application environment indicators
           On entry to the XPCREQ and XPCREQC User exits, the EXEC
           parameter list is pointed to by UEPCLPS. The EXEC
           parameter list for program control consists of up to eleven
           addresses.
           The eleven addresses are defined by PC_ADDR0 to PC_ADDRA.
           This DSECT defines PC_ADDR0 to PC_ADDRA and the areas
           that they point to.
           On entry to the XPCREQ and XPCREQC user exits, the copy
           of EIBRCODE is pointed to by UEPRCODE, the copy of EIBRESP
           is pointed by UEPRESP and the copy of EIBRESP2 is pointed
           to by UEPRESP2.
           The address of an application environment flag byte pointed
           to by UEPINDS is also passed to the user exit program. It
           contains flags which are mapped by the PC_INDS DSECT. These
           flags allow the exit program to decide whether the user
           application can access storage above or below the 16M line
           and which key such storage should be in, CICS or USER.
           This copybook also contains equates for values of EIBRCODE,
           EIBRESP and EIBRESP2 used by Program Control.
      LIFETIME = Lifetime of the PC command request
      STORAGE CLASS = As some of the storage being mapped is the
                   translated source in the user's application program,
                   the storage may be either above or below the line.
      LOCATION = (1) EXEC Parameter List is addressed by UEPCLPS.
                   (2) Fields copied from the EIB are addressed by
                       UEPRCODE, UEPRESP and UEPRESP2.
                   (3) The exit token is addressed by UEPCCTOK
      INNER CONTROL BLOCKS =
           PC_ADDR_LIST declares the EXEC addresses
           PC_EID defines Argument 0 pointed to by PC_ADDR0
      NOTES :
       DEPENDENCIES = S/370 ESA
       RESTRICTIONS = None
       MODULE TYPE = Control Block definition
   ---------------------------------------------------------------------
         The Command Parameter List
      PC_ADDR_LIST defines eleven addresses, that form the EXEC
      parameter list for Program Control.
      In addition, PC_ADDR1 to PC_ADDR8 and PC_ADDRA may be modified
      by a user exit.
      PC_ADDR9 is not used.
      Any attempt to modify PC_ADDR0 will be ignored.
Table 1.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 0 PC_ADDR_LIST EXEC Parameter List
(0) ADDRESS 4 PC_ADDR0 Address 0
(4) ADDRESS 4 PC_ADDR1 Address 1
(8) ADDRESS 4 PC_ADDR2 Address 2
(C) ADDRESS 4 PC_ADDR3 Address 3
(10) ADDRESS 4 PC_ADDR4 Address 4
(14) ADDRESS 4 PC_ADDR5 Address 5
(18) ADDRESS 4 PC_ADDR6 Address 6
(1C) ADDRESS 4 PC_ADDR7 Address 7
(20) ADDRESS 4 PC_ADDR8 Address 8
(24) ADDRESS 4 PC_ADDR9 Address 9
(28) ADDRESS 4 PC_ADDRA Address 10
(28) ..1. 11..   PC_ADDR_LIST_LEN "*-PC_ADDR_LIST"
      PC_EID defines:
        (1) The type of request
        (2) Existence bits indicating which addresses in the EXEC
            Parameter List are valid.
        (3) Bits to indicate the keywords specified.
      PC_ADDR0 contains the address of PC_EID.
      The following bits may be modified in a Program Control user exit.
        (1) Existence bits PC_EXIST2,
                           PC_EXIST3,
                           PC_EXIST4,
                           PC_EXIST5,
                           PC_EXIST6,
                           PC_EXIST7,
                           PC_EXIST8 and
                           PC_EXISTA
        (2) The keyword descriptor PC_SYNCONRET_X.
      Any attempt to modify any other part of PC_EID will be ignored.
Table 2.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 0 PC_EID Argument 0 for Program Control
(0) CHARACTER 1 PC_GROUP Group Code
(0) .... 111.   PC_PROGRAM_GRP "X'0E'" All Program Control Requests ...
(1) CHARACTER 1 PC_FUNCT Function Code
(1) .... ..1.   PC_LINK "X'02'" LINK Request
         The next two bytes contain existence bits for the addresses
         in the EXEC parameter list.
         For example, PC_ADDR1 should not be used unless PC_EXIST1
         is set on.
         PC_ADDR0 is always valid and has no existence bit.
(2) BITSTRING 1 PC_BITS1 First 8 existence bits
(2) 1... ....   PC_EXIST1 "X'80'" PC_ADDR1 is valid if the command specifies PROGRAM.
(2) .1.. ....   PC_EXIST2 "X'40'" PC_ADDR2 is valid if the command specifies COMMAREA. This bit may be modified by a user exit.
(2) ..1. ....   PC_EXIST3 "X'20'" PC_ADDR3 is valid if the command specifies LENGTH. This bit may be modified by a user exit.
(2) ...1 ....   PC_EXIST4 "X'10'" PC_ADDR4 is valid if the command specifies INPUTMSG. This bit may be modified by a user exit.
(2) .... 1...   PC_EXIST5 "X'08'" PC_ADDR5 is valid if the command specifies INPUTMSGLEN. This bit may be modified by a user exit.
(2) .... .1..   PC_EXIST6 "X'04'" PC_ADDR6 is valid if the command specifies DATALENGTH. This bit may be modified by a user exit.
(2) .... ..1.   PC_EXIST7 "X'02'" PC_ADDR7 is valid if the command specifies SYSID. This bit may be modified by a user exit.
(2) .... ...1   PC_EXIST8 "X'01'" PC_ADDR8 is valid if the command specifies TRANSID. This bit may be modified by a user exit.
(3) BITSTRING 1 PC_BITS2 Second eight existence bits
(3) 1... ....   PC_EXIST9 "X'80'" This bit is not used
(3) .1.. ....   PC_EXISTA "X'40'" PC_ADDRA is valid if the command specifies CHANNEL. This bit may be modified by a user exit.
         The next byte is reserved.
(4) BITSTRING 1 PC_EIDOPT4 Reserved
         The next 2 bytes describe the keywords on the command
         For example, if PC_SYNCONRET_X is set on, the command
         included the SYNCONRETURN keyword. If PC_SYNCONRET_X is
         set off, the command did not include the SYNCONRETURN
         keyword.
(5) BITSTRING 1 PC_EIDOPT5 Options Byte 1
(6) BITSTRING 1 PC_EIDOPT6 Options byte 2
(6) 1... ....   PC_SYNCONRET_X "X'80'" SYNCONRETURN specified
      The following definitions define the variables addressed by the
      remainder of the EXEC parameter list
         PC_ADDR1 addresses program name
Table 3.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 0 PC_DATA1 Addressed by PC_ADDR1
(0) CHARACTER 8 PC_PROGRAM program name
         PC_ADDR2 addresses the COMMAREA whose length is given
                  in PC_ADDR3
         PC_ADDR3 addresses the length of the COMMAREA
Table 4.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 0 PC_DATA3 Addressed by PC_ADDR3
(0) HALFWORD 2 PC_LENGTH Value of LENGTH
         PC_ADDR4 addresses the INPUTMSG whose length is given
                  in PC_ADDR5
         PC_ADDR5 addresses the length of the INPUTMSG
Table 5.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 0 PC_DATA5 Addressed by PC_ADDR5
(0) HALFWORD 2 PC_INPUTMSGLEN Area for LENGTH of INPUTMSG
         PC_ADDR6 addresses length of COMMAREA to be sent
Table 6.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 0 PC_DATA6 Addressed by PC_ADDR6
(0) HALFWORD 2 PC_DATALENGTH Area For DATALENGTH
         PC_ADDR7 addresses SYSID
Table 7.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 0 PC_DATA7 Addressed by PC_ADDR7
(0) CHARACTER 4 PC_SYSID Area For SYSID
         PC_ADDR8 addresses TRANSID
Table 8.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 0 PC_DATA8 Addressed by PC_ADDR8
(0) CHARACTER 4 PC_TRANSID Area For TRANSID
         PC_ADDRA addresses CHANNEL
Table 9.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 0 PC_DATAA Addressed by PC_ADDRA
(0) CHARACTER 16 PC_CHANNEL Area For CHANNEL name
    Start of general use programming interface.
    EIBRCODE, EIBRESP and EIBRESP2
    Equates for EIBRCODE values used by Program Control
(10) BITSTRING 6 PC_OK_EIBRCODE OK
(10) .... ...1   PC_PGMIDERR_EIBRCODE "X'01'"
(10) .111 1.1.   PC_CHANNELERR_ EIBRCODE "X'7A'"
(10) 11.1 ....   PC_SYSIDERR_EIBRCODE "X'D0'"
(10) 111. ....   PC_INVREQ_EIBRCODE "X'E0'"
(10) 111. ...1   PC_LENGERR_EIBRCODE "X'E1'"
(10) 1111 ...1   PC_TERMERR_EIBRCODE "X'F1'"
(10) 11.1 1..1   PC_RESUNAVAIL_ EIBRCODE "X'D9'"
    Equates for EIBRESP values used by Program Control
(10) .... ....   PC_OK_EIBRESP "0" OK
(10) ...1 ....   PC_INVREQ_EIBRESP "16" invalid request
(10) ...1 .11.   PC_LENGERR_EIBRESP "22" length error
(10) ...1 1.11   PC_PGMIDERR_EIBRESP "27" program id error
(10) ..11 .1.1   PC_SYSIDERR_EIBRESP "53" system id error
(10) .1.. .11.   PC_NOTAUTH_EIBRESP "70" not authorised
(10) .1.1 ...1   PC_TERMERR_EIBRESP "81" terminal error
(10) .111 1..1   PC_RESUNAVAIL_EIBRESP "121" Resource unavailable
(10) .111 1.1.   PC_CHANNELERR_EIBRESP "122" Channel error
    Equates for EIBRESP2 values used by Program Control
(10) .... ....   PC_OK_EIBRESP2 "0" OK
(10) .... ...1   PC_CHANNELERR_ EIBRESP2 "1" Invalid CHANNEL name
(10) .... ...1   PC_PGMIDERR_1_ EIBRESP2 "1" PPT entry not located
(10) .... ..1.   PC_PGMIDERR_2_ EIBRESP2 "2" program disabled
(10) .... ..11   PC_PGMIDERR_3_ EIBRESP2 "3" program not found in load library
(10) .... 1...   PC_INVREQ_1_EIBRESP2 "8" INPUTMSG without terminal
(10) .... 1.11   PC_LENGERR_1_EIBRESP2 "11" LENGTH < 0
(10) .... 11..   PC_LENGERR_2_EIBRESP2 "12" DATALENGTH < 0
(10) .... 11.1   PC_LENGERR_3_EIBRESP2 "13" DATALENGTH > LENGTH
(10) .... 111.   PC_INVREQ_2_EIBRESP2 "14" SYNCONRETURN invalid
(10) .... 1111   PC_INVREQ_3_EIBRESP2 "15" TRANSID invalid
(10) ...1 ....   PC_INVREQ_4_EIBRESP2 "16" TRANSID blank
(10) ...1 ...1   PC_TERMERR_1_EIBRESP2 "17" TERMERR raised
(10) ...1 ..1.   PC_SYSIDERR_1_ EIBRESP2 "18" SYSIDERR raised
(10) ...1 ..11   PC_INVREQ_5_EIBRESP2 "19" INPUTMSG specified on DPL request
(10) ...1 .1..   PC_SYSIDERR_2_ EIBRESP2 "20" DPL not supported over LU6.1
(10) ...1 .1.1   PC_SYSIDERR_3_ EIBRESP2 "21" Type of request not supported by receiver e.g. LINK CHANNEL to be executed a CICS that does not support CHANNEL
(10) .11. .1.1   PC_NOTAUTH_1_EIBRESP2 "101" resource security check failed
    End of general use programming interface.


DFHPCEKS.html | Timestamp icon Last updated: Sunday, 4 June 2017