Common end codes for REQUESTS within each ILK

End Codes for Requests

The following list of codes is used at the end of each request (for example, REQUEST=XADD, REQUEST=SDVCINFO) within an ILK. Because the values stay the same for each request , there is no need to display the descriptions more than once.

,RETCODE=retcode

An optional output parameter into which the return code is to be copied from GPR 15.

To code: Specify the RS-type address of a fullword field, or register (2)-(12).

,RSNCODE=rsncode

An optional output parameter into which the reason code is to be copied from GPR 0.

To code: Specify the RS-type address of a fullword field, or register (2)-(12).

,PLISTVER=IMPLIED_VERSION

,PLISTVER=MAX

,PLISTVER=0

An optional input parameter that specifies the version of the macro. PLISTVER determines which parameter list the system generates. PLISTVER is an optional input parameter on all forms of the macro, including the list form. When using PLISTVER, specify it on all macro forms used for a request and with the same value on all of the macro forms. The values are as follows:

IMPLIED_VERSION, which is the lowest version that allows all parameters specified on the request to be processed. If you omit the PLISTVER parameter, IMPLIED_VERSION is the default.
MAX, if you want the parameter list to be the largest size currently possible. This size might grow from release to release and affect the amount of storage that your program needs.
If you can tolerate the size change, IBM® recommends that you always specify PLISTVER=MAX on the list form of the macro. Specifying MAX ensures that the list-form parameter list is always long enough to hold all the parameters you might specify on the execute form, when both are assembled with the same level of the system. In this way, MAX ensures that the parameter list does not overwrite nearby storage.
0, if you use the currently available parameters.

To code: Specify one of the following:

IMPLIED_VERSION
MAX
A decimal value of 0

,MF=S

,MF=(L,list addr)

,MF=(L,list addr,attr)

,MF=(L,list addr,'X'0D)

,MF=(E,list addr)

,MF=(E,list addr,COMPLETE)

,MF=(E,list addr,NOCHECK)

,MF=(M,list addr)

,MF=(M,list addr,COMPLETE)

,MF=(M,list addr, NOCHECK)

An optional input parameter that specifies the macro form.

Use MF=S to specify the standard form of the macro, which builds an inline parameter list and generates the macro invocation to transfer control to the service. MF=S is the default.

Use MF=L to specify the list form of the macro. Use the list form together with the execute form of the macro for applications that require reentrant code. The list form defines an area of storage that the execute form uses to store the parameters. Only the PLISTVER parameter may be coded with the list form of the macro.

Use MF=E to specify the execute form of the macro. Use the execute form together with the list form of the macro for applications that require reentrant code. The execute form of the macro stores the parameters into the storage area defined by the list form, and generates the macro invocation to transfer control to the service.

Use MF=M to add or remove a keyword to an existing ANTRQST parameter list. If the keyword references a parameter area with user data, the pointer to the parameter is added to or removed from the specified ANTRQST parameter list. If the keyword references a parameter that can only have certain values, the ANTRQST parameter list is updated with the specified parameter value. The ANTRQST macro parameter list has parameters by reference as well as parameters by value.

If a keyword is required for the MF=E form of ANTRQST, but one is not specified on the initial MF=L form, use of the MF=M form to add the required keyword will not copy the keyword parameter value into the ANTRQST parameter list.

Use of the MF=M to add or remove keywords and parameters requires extra instructions at program execution time. All keywords can be specified on the initial MF=L setup of the ANTRQST parameter list. The program can then set the parameter field to a known value when needed, and set the parameter field to binary zero when the keyword is not needed. Having the application program set the parameter field to binary zero reduces the extra instructions needed to support the MF=M form of adding or removing a keyword.

IBM recommends that you use the modify and execute forms of ANTRQST in the following order:

Use ANTRQST ...MF=(M,list-addr,COMPLETE) specifying appropriate parameters, including all required ones.
Use ANTRQST ...MF=(M,list-addr,NOCHECK), specifying the parameters that you want to change.
Use ANTRQST ...MF=(E,list-addr,NOCHECK), to execute the macro.

,list addr: The name of a storage area to contain the parameters. For MF=S, MF=E, and MF=M, this can be an RS-type address or an address in register (1)-(12).
,attr: An optional 1 to 60-character input string that you use to force boundary alignment of the parameter list. Use a value of X'0F' to force the parameter list to a word boundary, or X'0D' to force the parameter list to a doubleword boundary. If you do not code attr, the system provides a value of X'0D'.
,COMPLETE: Specifies that the system is to check for required parameters and supply defaults for omitted optional parameters.
,NOCHECK: Specifies that the system is not to check for required parameters and is not to supply defaults for omitted optional parameters.