Parameter Descriptions

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

,CONNAME=conname

Use this input parameter to specify the connect name of the connection to be deleted. The connection identified is connected to the structure specified by STRNAME.

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

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

REQUEST=STRUCTURE

REQUEST=CONNECTION

REQUEST=ALLCONNS

REQUEST=STRDUMP

REQUEST=STRDUMPSERIAL

Use this input parameter to specify what the requestor wants to delete.

STRUCTURE: Indicates that the structure is to be deleted. A structure can be deleted only when there are no active or failed-persistent connections to the structure. You can use IXCQUERY to determine the state of connections to a structure. If there is a structure dump associated with the structure, deallocation of the structure remains pending until the structure dump is released.
CONNECTION: Indicates that the specified failed-persistent connection to a structure is to be deleted. If the last connection to a non-persistent structure is deleted, the structure also is deleted.
ALLCONNS: Indicates that all failed-persistent connections to a structure are to be deleted. If the last connection to a non-persistent structure is deleted, the structure also is deleted.
STRDUMP: Indicates that a structure dump associated with either an active structure or a structure pending deallocation is to be deleted. Structures pending deallocation will be processed only if a nonzero STRDUMPID is specified.
STRDUMPSERIAL: Indicates that the serialization held on the structure for the structure dump is to be released. For structures pending deallocation, however, release of dumping serialization is not supported because such structures have no active connectors who might be impacted by the dump serialization.

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

,STRDUMPID=0

,STRDUMPID=strdumpid

Use this input parameter to specify the structure dump identifier of the structure dump to be deleted. or of the dump for which structure dump serialization is to be released. This is used to uniquely identify the specific instance of a structure dump, since there might be multiple instances of a structure, each with an associated structure dump.

If you do not specify STRDUMPID or specify a value of zero on STRDUMPID, the system deletes, or releases dump serialization for, all structure dumps associated with the allocated structure. To delete a structure dump for a structure pending deallocation, you must specify a non-zero STRDUMPID. Release of structure dump serialization is not supported for a structure pending deallocation because such structures have no active connectors who might be impacted by the dump serialization. If a structure rebuild is in process, the system might delete, or release dump serialization for, the dump associated with the rebuild old structure, rebuild new structure, or both.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of a halfword input field that contains the structure dump identifier of the structure dump to be deleted.

,STRNAME=strname

Use this input parameter to specify the name of the structure that is identified on the IXLFORCE request. The structure might be active or pending deallocation. You can use the IXCQUERY macro to determine which structures have been defined in the CFRM active policy.

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