Parameter Descriptions

The parameter descriptions common to all IXLLOCK request types are listed in alphabetical order. Default values are underlined.

CONTOKEN=contoken

Use this input parameter to specify the CONNECT token that was returned in the answer area by the IXLCONN service. CONTOKEN uniquely identifies the user's connection to a lock structure.

To Code: Specify the RS-name or address (using a register from 2 to 12) of a 16-character input field that contains the CONNECT token returned in the answer area by the IXLCONN service.

,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.

,PLISTVER=IMPLIED_VERSION

,PLISTVER=MAX

,PLISTVER=plistver

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

,REQUEST=OBTAIN

,REQUEST=ALTER

,REQUEST=RELEASE

,REQUEST=PROCESSMULT

Use this input parameter to specify the type of operation requested.

OBTAIN: Use this input parameter to specify that the connected user is requesting to obtain ownership of the resource identified by the input resource name/hash value pair.
ALTER: Use this input parameter to request a change to one or more of the attributes of a resource that it currently owns. The ALTER option also may be used to replace a previous OBTAIN or ALTER request that is currently pending on the contention exit resource request queue with a more current request.
RELEASE: Use this input parameter to specify that the connected user is requesting to release ownership of the resource.
PROCESSMULT: Use this input parameter to specify that the connected user is requesting that multiple resource requests are to be processed. Each request is specified in a lock request block that the user builds in a storage area.
This request type is valid only for a structure allocated in a coupling facility of CFLEVEL=2 or higher.

,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.