Parameter Descriptions

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

CONTOKEN=contoken

Use this input parameter to specify the connection identifier that was returned by the IXLCONN service. The connection identifier uniquely identifies the user's connection to the structure.

During rebuild processing, use the original, not the temporary, contoken.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of the 16-character field that contains the connect token.

,DISCDATA=ALL_ZEROES

,DISCDATA=discdata

Use this input parameter to specify eight bytes of connector data that the system will pass to the event exit of other connectors when you disconnect from the structure.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of the eight-character field.

,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 IXLDISC Version Support for a description of the options available with PLISTVER.

,REASON=NORMAL

,REASON=FAILURE

,REASON=DELETESTR

Use this input parameter to specify the reason for the disconnection: The disconnect reason is presented to all surviving connectors' event exits.

NORMAL: Indicates normal termination. The connection disposition specified on IXLCONN does not apply and the connection is made not-defined. If the disconnection results in there being no connections (active or failed-persistent) to the structure, the structure disposition applies. The structure disposition determines if the structure is deleted (STRDISP=DELETE) or retained (STRDISP=KEEP).
If a connection to a lock structure with RECORD=YES owns lock resources and issues IXLDISC REASON=NORMAL, the disconnect is treated as if the user specified REASON=FAILURE.
FAILURE: Indicates termination due to a failure. The connection disposition specified on IXLCONN applies. After all surviving connections are notified and confirm the disconnect, the connection is made not-defined (CONDISP=DELETE) or failed-persistent (CONDISP=KEEP). If the disconnection results in there being no connections (active or failed-persistent) to the structure, the structure disposition applies. The structure disposition determines if the structure is deleted (STRDISP=DELETE) or retained (STRDISP=KEEP).
DELETESTR: Indicates normal termination. The connection disposition specified on IXLCONN does not apply and the connection is made not-defined. If the disconnection results in there being no connections (active or failed-persistent) to the structure, the structure is deleted even if the structure has a disposition of KEEP. This keyword allows a structure with a disposition of KEEP to be deleted by the last connector when it is known that the structure is no longer needed. Without this keyword, the program would need to issue IXLFORCE to delete such a structure, or the installation would need to manually delete the structure (there are also situations that might cause XES to implicitly delete a structure with no connectors).
If a connection to a lock structure with RECORD=YES owns lock resources, and issues IXLDISC REASON=DELETESTR, the disconnect is treated as if the user specified REASON=FAILURE. In particular, note that if the structure has a disposition of KEEP, the structure will persist even if it has no connectors.

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