CSLOMOUT: unsolicited output request

The CSLOMOUT request is issued by a command processing client that wants to send a message indirectly in response to a command. The message can be additional information as a result of a command issued after the initial command response is returned to OM, or an informational message as a result of an event in the system. OM sends the unsolicited message to the OM Output user exit.

CSLOMOUT syntax

DSECT syntax

Use the DSECT function of a CSLOMOUT request to include equate (EQU) statements in your program for the CSLOMOUT parameter list length and return and reason codes.

Read syntax diagramSkip visual syntax diagramCSLOMOUTFUNC=DSECT

Request protocol syntax

Read syntax diagramSkip visual syntax diagramCSLOMOUTFUNC=MESSAGE CMD= cmdinput CMDLEN= cmdinputlen MSGDATA= msgdataMSGDATALEN= msgdatalenOMNAME= omnameRQSTTKN= requesttokenPARM= parmRETCODE= returncodeRSNCODE= reasoncodeSCITOKEN= scitoken

CSLOMOUT parameters

CMD=symbol
CMD=(r2-r12)
(Optional) - Specifies the command input buffer. This can be any IMS command that can be specified through the OM API. This parameter represents the original command input.
CMDLEN=symbol
CMDLEN=(r2-r12)
(Optional) - Specifies the length of the command input buffer.
MSGDATA=symbol
MSGDATA=(r2-r12)
(Required) - Specifies the command response message buffer.
MSGDATALEN=symbol
MSGDATALEN=(r2-r12)
(Required) - Specifies the length of the command response message buffer.
OMNAME=symbol
OMNAME=(r2-r12)
(Optional) - Specifies the 8-byte OM name to which to send the unsolicited output message when the message is an asynchronous response to a command.
RQSTTKN=symbol
RQSTTKN=(r2-r12)
(Optional) - Specifies the 32-byte request token that was passed to the command processing client on an OM command directive. This represents the RQSTTKN1 and RQSTTKN2 fields that are entered on either or both the CSLOMI and CSLOMCMD requests.
PARM=symbol
PARM=(r2-r12)
(Required) - Specifies the CSLOMOUT parameter list. The length of the parameter list must be equal to the parameter list length EQU value that is defined by OOUT_PARMLN.
RETCODE=symbol
RETCODE=(r2-r12)
(Required) - Specifies a 4-byte field to receive the return code on output. Possible return codes are described in the following table.

The return code can be from OM (CSLOMOUT) or SCI (CSLSCMSG or CSLSCRQS). If ECB is specified, the RETCODE is not valid until the ECB is posted. The value of the high-order byte in the return code identifies whether SCI (X'01') or OM (X'02') provided the return code. OM return codes are defined in the CSLORR. SCI return codes are defined in CSLSRR.

RSNCODE=symbol
RSNCODE=(r2-r12)
(Required) - Specifies a 4-byte field to receive the reason code on output. OM reason codes are defined in the CSLORR. SCI reason codes are defined in CSLSRR. Possible reason codes are described in the following table.
SCITOKEN=symbol
SCITOKEN=(r2-r12)
(Required) - Specifies a 16-byte field containing the SCI token. This token uniquely identifies this connection to SCI. The SCI token is returned by a successful CSLSCREG FUNC=REGISTER request.

CSLOMOUT return and reason codes

The return and reason codes in the following table can be returned on a CSLOMOUT macro request. The following table lists the return and reason codes that can be returned on a CSLOMI macro request. Also included is the meaning of a reason code (that is, what possibly caused it).

Table 1. CLSOMOUT return and reason codes
Return code Reason code Meaning
X'00000000' X'00000000' The request completed successfully.