Parameter Descriptions

The parameter descriptions are listed in alphabetical order. Default values are underlined:

,MF=S

,MF=(L,mfctrl)

,MF=(L,mfctrl,mfattr)

,MF=(L,mfctrl,0D)

,MF=(E,mfctrl)

,MF=(E,mfctrl,COMPLETE)

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.

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 can 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 stores the parameters into the storage area defined by the list form, and generates the macro invocation to transfer control to the service.

,mfctrl: Use this output parameter to specify a storage area to contain the parameters.
To Code: Specify the RS-type name or address (using a register from 2 to 12) of the parameter list.
,mfattr: Use this input parameter to specify the name of a 1- to 60-character string that can contain any value that is valid on an assembler DS pseudo-op. You can use this parameter to force boundary alignment of the parameter list. If you do not code mfattr, the system provides a value of 0D, which forces the parameter list to a doubleword boundary.
,COMPLETE: Use this input parameter to require that the system check for required parameters and supply defaults for omitted optional parameters.
Note: In the macro expansion you might see some defaults for optional parameters that are not documented here. The ones that are not documented do not have any effect on the macro. For example, if SMILE=var were an optional parameter and the default is SMILE=NO_SMILE then it would not be documented. However, if the default was SMILE=:-), then it would be documented because a value would be the default.

NEPL=nepl

Use this input parameter to identify the notify exit parameter list (IXLYNEPL). The parameter list must be the actual list passed and not a copy of the list.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of the parameter list that was passed to the notify exit in register 1.

,MODEVAL=IXLMODESYNCSUSPEND

,MODEVAL=modeval

Use this input parameter to specify how the request should be processed if it cannot be serviced immediately. If the request can be processed immediately, the MODEVAL keyword is ignored and control is returned to the invoker with all information about the completed request.

The value provided must be equivalent to the constants provided in the IXLYCON macro indicating the mode. (See the IXLYCON macro for a list of mode value constants for users of IXLSYNCH and optionally include that macro in your program.)

Note: Only MODEVAL values IxlModeSyncSuspend and IxlModeSyncFail are currently supported for IXLSYNCH requests.

If you specify a value other than one of the IXLYCON constants that is valid for an IXLSYNCH request, the request fails with reason code IXLRSNCODEBADMODEVAL.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of an optional byte input.

Default: IXLMODESYNCSUSPEND

,PLISTVER=IMPLIED_VERSION

,PLISTVER=MAX

,PLISTVER=plistver

Use this input parameter to specify the version of the macro. See Understanding IXLSYNCH Version Support for a description of the options available with PLISTVER.

,RETCODE=retcode

Use this output parameter to specify the location in which the system is to copy the return code from GPR 15.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of a fullword to contain the return code.

,RSNCODE=rsncode

Use this output parameter to specify the location in which the system is to copy the reason code from GPR 0.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of a fullword to contain the reason code.