Variables returned from the APL EXEC

The IMFCC TSO variable describes the success or failure of the EXEC that calls the APL EXEC. The IMFRC TSO variable contains information about the success of the APL EXEC. LOCAL variables APLCC and APLRC are also returned (and they contain additional information). For more information, refer to the following table.

Table 1. APL EXEC variables IMFRC, APLCC, and APLRC

Message in APLLNxx	IMFRC	APLCC	APLRC
PL0000I SUCCESS or IBM MQ response	0	0	0
PATROL Node Manager Return code	8	4	PATROL Node Manager reason code
SOCKET(SOCKET) rc=nnSOCKET(CONNECT) rc=nnSOCKET(WRITE) rc=nnSOCKET(SELECT) rc=nn	8	8	TCP/IP return code
Error in EXCMD command	8	12	1
Unable to initialize SOCKET	8	12	3
Connection reset by peer	8	12	4
TIMED OUT	8	12	5
Unrecognized response from MQ agent	8	12	6
CMD parameter is not provided	8	16	51
NODE parameter is not provided	8	16	52
Debug parameter can be only YES or NO	8	16	53
Required MainView AutoOPERATOR for MQ is not active	8	16	54
MainView AutoOPERATOR for MQ services required not available on this level. Must be 5.1 or higher	8	16	55
Error in parameter structure	8	16	56
Unknown parameter	8	16	57
Error in RESPONSE parameter	8	16	58

Note

If more than one command is passed, IMFRC, APLCC and APLRC correspond to the highest value of APLCC in the set of returns or the highest level of APLRC if APLCC=0.

For more information about TCP/IP return codes, refer to the IBM TCP/IP for MVS Application Programming Interface Reference, SC31-7187-03.

For more information about IBM MQreturn codes, refer to the IBM manual MQ Messages.

Additional response information from the queue manager is returned in the LOCAL variables APLNOL and APLLN1 through APLLNxx, where xx is the last line of returned information. APLNOL contains the number of returned lines (which is equal to the value of xx). These variables must be retrieved using the IMFEXEC VGET command before they can be used.

Variable name	Definition
APLNOL	Contains the number of returned lines in variables APLLN1 through APLLNxx
APLLN1	Contains the first line of response information from the queue manager
APLLNxx	Contains the last line of response information from the queue manager
APLNOL	Contains the total number of the response lines from all responses together
APLLNxx	Contains the response information from all commands. Each command response begins from a new line.

The following example shows that the variable APLNOL has a value of 13, which equals 13 lines of returned information from the queue manager.

Figure 1. Example of information returned in variables APLNOL and APLLN1 through APLLN13

 APLNOL = 13
  AMQ8408:  Display queue manager details
    DESCR(  )    DEADQ(DEAD.LETTER.)
    DEFXMITQ    CHADEXIT( )
    COMMANDQ(SYSTEM.ADMIN.COMMAND.QUEUE)QMNAME(EPESIN)
    TRIGINT(9999999999) MAXHANDS(256)
    MAXUMSGS(10000) AUTHOREV(DISABLED)
    INHIBTEV(ENABLED) LOCALEV(ENABLED)
    REMOTEEV(ENABLED) PERFMEV(ENABLED)
    STRSTPEV(ENABLED) CHAD(ENABLED)
    CHADEV(DISABLED) MAXMSGL(4194304)
    MAXPRTY(9) CCSID(437)
    CMDLEVEL(500) DISTL(YES)
    SYNCPT

Variables returned from the APL EXEC

Comments