The command scan parameter list

The command scan parameter list (CSPL) is a six-word parameter list containing addresses required by the Command Scan Service Routine. To ensure that your Command Processor is reentrant, build the CSPL in subpool 1 in an area that the Command Processor obtains by issuing the GETMAIN macro instruction. Figure 1 shows the parameter list structure that your Command Processor must create as input to the Command Scan Service Routine.

Figure 1. The parameter list structure passed to command scan

Use the IKJCSPL DSECT, which is provided in SYS1.MACLIB, to map the fields in the CSPL. Table 1 shows the format of the command scan parameter list.

Table 1. The command scan parameter list
Number of bytes	Field name	Contents or meaning
4	CSPLUPT	The address of the user profile table. This address is passed to a Command Processor in the CPPL.
4	CSPLECT	The address of the environment control table. This address is passed to a Command Processor in the CPPL.
4	CSPLECB	The address of the Command Processor's event control block.
4	CSPLFLG	The address of a fullword, obtained via the GETMAIN macro instruction by the routine linking to command scan, and located in subpool 1. The first byte of the word pointed to contains flags set by the calling routine.
4	CSPLOA	The address of an 8-byte command scan output area, located in subpool 1. The output area is obtained by the calling routine via a GETMAIN macro instruction. It is filled in by the Command Scan Service Routine before it returns control to the calling routine. (See Figure 1.)
4	CSPLCBUF	The address of the command buffer.