Parameter Descriptions

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

MEMTOKEN=memtoken

Use this input parameter to specify the 64-bit token of the member that IXCLEAVE is to place in the not-defined state. XCF provided this token when it activated the member.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of an 8-byte field that contains the member token that was returned in the ANSAREA when IXCJOIN completed.

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

,RETCODE=retcode

Use this output parameter to specify a field to contain the return code. (The return code is also returned in register 15.)

To Code: Specify the RS-type name or address (using a register from 2 to 12) of a 4-byte field that will contain the return code when the request has completed.

,RSNCODE=rsncode

Use this output parameter to specify a field to contain the reason code returned, if applicable. (The reason code is also returned in register 0.)

To Code: Specify the RS-type name or address (using a register from 2 to 12) of a 4-byte field that will contain the reason code (if any) when the request has completed.

,USLEN=uslen

Use this input parameter to specify the length in bytes of the user state data that you provide on the USTATE parameter. The length must be from 1 to 32 bytes. XCF overlays any previous value in the user state field up to the length you specify on USLEN. XCF does not pad the remainder of the user state field (up to 32 bytes) with zeros. IXCQUERY always returns the full 32 bytes, and group user-routines always receive the full 32 bytes. If you code USTATE, USLEN is required.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of a 4-byte field that contains the length of the user state data (USTATE).

,USTATE=NO_USTATE

,USTATE=ustate

Use this input parameter to specify the area containing data that you want XCF to place in the user state field associated with the member. Use the USLEN parameter to specify the length of the user state data.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of the area (with a length of USLEN) that contains the user state information.