z/OS MVS Programming: Sysplex Services Reference
Previous topic | Next topic | Contents | Contact z/OS | Library | PDF


Return and Reason Codes

z/OS MVS Programming: Sysplex Services Reference
SA38-0658-00

When control returns from IXCMSGC:
  • GPR 15 (and retcode, if you coded RETCODE) contains a return code.
  • GPR 0 (and rsncode, if you coded RSNCODE) contains a reason code, if applicable. Note that bits 0-15 of the reason code might contain component- diagnostic data for use by IBM® service personnel. XCF provides the IXCMSGRSNCODEMASK constant to mask off the component-diagnostic data.
The IXCMSGC macro provides equate symbols for the return and reason codes. The equate symbols associated with each hexadecimal return code are as follows:
00
IXCMSGCRCSUCCESSFUL
04
IXCMSGCRCWARNING
08
IXCMSGCRCINVALIDPARMS
0C
IXCMSGCRCENVIRONMENTALERROR
10
IXCMSGCRCSYSTEMERROR

Table 1 identifies the hexadecimal return and reason codes and the equate symbol associated with each reason code.

Table 1. Return and Reason Codes for the IXCMSGC Macro
Hexadecimal Return Code Hexadecimal Reason Code Equate Symbol Meaning and Action
0 None. Meaning: IXCMSGC completed successfully.

Action: None.

4 xxxx0004 Equate Symbol: IXCMSGCRSNANSAREATOOSMALL

Meaning: The IXCMSGC QUERYMSG request completed successfully. The area specified by ANSAREA was large enough to contain the header information (MQAHEADER), but was not large enough to contain all the data that was requested. The MQAHDRTLEN field indicates the total length of the output answer area that would have been needed to contain all the requested information. It is possible that only the MQAHEADER was provided, in which case the MQAHDR#ENTRIES field would contain zero.

Action: Retry the request with an answer area whose length is greater than or equal to the number of bytes indicated by MQAHDRTLEN. Note that the amount of data to be returned can change dynamically so that the length indicated by MQAHDRTLEN might be too small for all the data when you try the request again.

4 xxxx000C Equate Symbol: IXCMSGCRSNSAVEDMSGTIMEOUT

Meaning: HOLDTIME(CONTINUE) was specified for a SAVEMSG request but the established HOLDTIME for the saved message has expired and the message will be discarded as soon as CALLEXIT processing completes.

Action: If the message is to be saved, re-issue the SAVEMSG request specifying HOLDTIME(INDEFINITE) or HOLDTIME(SET) to establish a new HOLDTIME.

4 xxxx0008 Equate Symbol: IXCMSGCRSNMSGALREADYCOMPLETE

Meaning: The message has already completed.

Action: None. A message COMPLETION was requested for a message that was already completed.

4 xxxx0018 Equate Symbol: IXCMSGCRSNMSGDISCARDPENDING

Meaning: A message-discard is pending. Some work unit is currently processing the message. (For example, the message notify user routine might be processing the message.) The system will delete the message as soon as the work unit is finished with the message.

Action: None, the message is not available. Storage areas for a message-out request that were to be preserved until the message completed can be freed (applies to IXCMSGO/IXCMSGOX MSGACCESS=ASYNC or MSGACCESS=SYNCSUSPEND requests).

4 xxxx0020 Equate Symbol: IXCMSGCRSNNOMSGRELEASEDMSGOX

Meaning: A RELEASEMSG request for a paused message-out request identified by TOKEN did not find a unit of work to release.

Action: None. The system returns to the caller without releasing a unit of work.

4 xxxx0024 Equate Symbol: IXCMSGCRSNNOMSGRELEASEDCLIENT

Meaning: A RELEASEMSG request for a blocking IXCRECV or a paused IXCSEND service call identified by SENDTOKEN did not find a unit of work to release.

Action: The system returns to the caller without releasing a unit of work.

8 xxxx0004 Equate Symbol: IXCMSGCRSNMEMBERNOTACTIVE

Meaning: The member token does not identify an active member associated with the primary address space that was current when IXCMSGC was invoked.

Action: Reissue the request with a correct member token or from the correct address space.

8 xxxx0016 Equate Symbol: IXCMSGCRSNINAPPROPEXITROUTINENAME
Meaning: The user routine type specified was inappropriate for this request.
  • Messages saved by a message user routine and responses saved by a message notify user routine must be processed by a message user routine. Use the MSGEXIT parameter to specify the user routine.
  • A completed message-out request, or a saved message-out response entity must be processed by a message notify user routine. Use the NOTIFYEXIT parameter to specify the user routine.

Action: The type of user routine specified for a CALLEXIT request must be appropriate for the type of message to be processed. Retry the request with the correct user routine.

8 xxxx0040 Equate Symbol: IXCMSGCRSNRESERVEDFIELDNOTNULL

Meaning: Program error or environmental error. A reserved field in the control parameter list is not zero.

Action: Check to see if your program inadvertently overlaid the parameter list storage, and that it was assembled with the correct macro library for the release of z/OS on which your program is running.

8 xxxx0100 Equate Symbol: IXCMSGCRSNBADPLISTALET

Meaning: Program error. Your program is not running in primary ASC mode, and the ALET that qualifies the address of the control parameter list is not zero, associated with a valid public entry on the DU-AL, or for a common area data space.

Action: Ensure that:
  • Your program is not intended to run in primary ASC mode.
  • You specified SYSSTATE ASCENV=AR before issuing the IXCMSGC macro.
  • The ALET for the parameter list is a valid public entry on the DU-AL, is zero (primary address space ALET), or for a common area data spece.
8 xxxx0104 Equate Symbol: IXCMSGCRSNBADPLISTVERSION

Meaning: The parameter list is not valid. Either the version number in the parameter list is not valid, or the release level of z/OS on which the caller is running does not support this version of the message control service.

Action: Retry the request with the correct version of the parameter list.

8 xxxx0108 Equate Symbol: IXCMSGCRSNBADPLISTFUNCCODE

Meaning: The parameter list is not valid. The function code in the parameter list is not valid.

Action: Check to see if your program inadvertently overlaid the parameter list in storage, and that it was assembled with the correct macro library for the release of z/OS on which it is running.

8 xxxx010C Equate Symbol: IXCMSGCRSNBADPLISTADDRESS

Meaning: The parameter list is not accessible. Its storage is not addressable.

Action: Make sure the parameter list is accessible to XCF and retry the request.

8 xxxx011C Equate Symbol: IXCMSGCRSNNOTENABLED

Meaning: The caller is not enabled.

Action: Correct your program so that it does not issue IXCMSGC while it is disabled.

8 xxxx012C Equate Symbol: IXCMSGCRSNLOCKSHELD

Meaning: The caller is holding a lock.

Action: Correct your program so that it does not issue IXCMSGC while holding any locks.

8 xxxx013C Equate Symbol: IXCMSGCRSNANSAREASMALLERTHANHEADER

Meaning: The area specified by ANSAREA is too small. The answer area must be at least as long as the header record (MQAHEADER).

Action: Retry the request with a larger answer area.

8 xxxx0140 Equate Symbol: IXCMSGCRSNANSAREABADALET

Meaning: The area specified by ANSAREA is not accessible. The ALET of the answer area must be zero, a valid entry on the dispatchable unit access list (DU-AL), or a valid entry for a common area data space.

Action: Ensure that:
  • Your program is not intended to run in primary ASC mode.
  • You specified SYSSTATE ASCENV=AR before issuing the IXCMSGC macro.
  • The ALET for the parameter list is a valid public entry on the DU-AL, is zero (primary address space ALET), or for a common area data spece.
8 xxxx0148 Equate Symbol: IXCMSGCRSNANSAREABADADDRESS

Meaning: An error occurred attempting to access the answer area.

Action: Make sure the answer area is accessible to XCF and reissue the request.

8 xxxx0150 Equate Symbol: IXCMSGCRSNMsgTagBadAlet

Meaning: MSGTAG not accessible.

Action: The ALET of the MSGTAG is neither zero nor a valid entry on the Dispatchable Unit Access List (DU-AL), nor a valid entry for a common area data space. Retry the request with the correct ALET.

8 xxxx0152 Equate Symbol: IXCMSGCRSNMSGTAGBADADDRESS

Meaning: Error accessing MSGTAG.

Action: Make sure the MSGTAG is accessible to XCF, and reissue the request.

8 xxxx0154 Equate Symbol: IXCMSGCRSNMSGTAGFILTERBADALET

Meaning: MSGTAGFILTER not accessible.

Action: The ALET of the MSGTAGFILTER is neither zero nor a valid entry on the Dispatchable Unit Access List (DU-AL), nor a valid entry for a common area data space. Retry the request with the correct ALET.

8 xxxx0158 Equate Symbol: IXCMSGCRSNMSGTAGFILTERBADADDRESS

Meaning: Error accessing MSGTAGFILTER.

Action: Make sure the MSGTAGFILTER is accessible to XCF, and reissue the request.

8 xxxx0160 Equate Symbol: IXCMSGCRSNMSGTAGMASKBADALET

Meaning: MSGTAGMASK not accessible.

Action: The ALET of the MSGTAGMASK is neither zero nor a valid entry on the Dispatchable Unit Access List (DU-AL), nor a valid entry for a common area data space. Retry the request with the correct ALET.

8 xxxx0168 Equate Symbol: IXCMSGCRSNMSGTAGMASKBADADDRESS

Meaning: Error accessing MSGTAGMASK.

Action: Make sure the MSGTAGMASK is accessible to XCF, and reissue the request.

8 xxxx0170 Equate Symbol: IXCMSGCRSNTOKENBADALET

Meaning: SENDTOKEN not accessible.

Action: The ALET of the SENDTOKEN is neither zero nor a valid entry on the Dispatchable Unit Access List (DU-AL), nor a valid entry for a common area data space. Retry the request with the correct ALET.

8 xxxx0170 Equate Symbol: IXCMSGCRSNTOKENBADALET

Meaning: SENDTOKEN not accessible.

Action: The ALET of the SENDTOKEN is neither zero nor a valid entry on the Dispatchable Unit Access List (DU-AL), nor a valid entry for a common area data space. Retry the request with the correct ALET.

8 xxxx0172 Equate Symbol: IXCMSGCRSNTOKENBADADDRESS

Meaning: Error accessing SENDTOKEN

Action: Make sure the SENDTOKEN is accessible to XCF, and reissue the request.

Ensure that you are issuing the SAVEMSG request under the user routine unit of work.

8 xxxx0204 Equate Symbol: IXCMSGCRSNTOKENNOTFORDISCARDMSG

Meaning: The token specified by TOKEN is not valid for the DISCARDMSG service.

Action: Check to see if your program inadvertently overlaid the parameter list in storage.

Ensure that you are issuing the DISCARDMSG request under the user routine unit of work.

8 xxxx0208 Equate Symbol: IXCMSGCRSNTOKENFORCALLEXITINVALID

Meaning: The token specified by TOKEN is not valid for the CALLEXIT service. Valid tokens for the CALLEXIT service are those returned by the IXCMSGC SAVEMSG service, the IXCMSGO service (RETMSGOTOKEN), and the IXCMSGC QUERYMSG service.

Action: Ensure that the token is one that was returned by a successful invocation of the IXCMSGC SAVEMSG or QUERYMSG service or the RETMSGOTOKEN from the IXCMSGO service.

Also, check to see if your program inadvertently overlaid the parameter list in storage.

Note that message tokens presented to the message user routine and the message notify user routine are not valid for the CALLEXIT service.

8 xxxx020C Equate Symbol: IXCMSGCRSNMESSAGEUNAVAILABLE

Meaning: Message not available. The message identified by the input message token (TOKEN or SENDTOKEN) either does not exist, or is no longer accessible using the indicated token. The message was either completely delivered, processed, or discarded. In the case of an input TOKEN, this situation can also occur if the specified MEMTOKEN does not identify the XCF group member to whom the message token was given.

Action: Verify that the input token (either TOKEN or SENDTOKEN) was validly specified in an appropriate context. If the message was for an XCF group member, verify that the message token (TOKEN) is relevant to the specified member (MEMTOKEN). Reissue the request with the correct token(s) in the correct context.

When a user routine saves the message, the message is no longer available to the user routine. If the message still exists, use the token returned via the RETMSGTOKEN keyword on the IXCMSGC invocation that saved the message to process the message.

Another option is to use the token returned by the IXCMSGC QUERYMSG service.

8 xxxx0212 Equate Symbol: IXCMSGCRSNSENDTOKENINVALID

Meaning: SENDTOKEN not valid. The SENDTOKEN must be a token that was returned by the IXCSEND service through the RETMSGTOKEN keyword.

Action: Verify the SENDTOKEN and retry the request with the correct SENDTOKEN.

8 xxxx0220 Equate Symbol: IXCMSGCRSNTOKENNOTFORFORCECOMPLETION

Meaning: The message TOKEN is not valid for Force Completion. The message token must be a token that was returned either by the IXCMSGO service with the RETMSGOTOKEN keyword or by the IXCMSGC QUERYMSG DATATYPE=MSGOUT STATUS=INCOMPLETE service.

Action: Verify the token and retry the request with the correct token.

Also, check to see if your program inadvertently overlaid the parameter list in storage.

8 xxxx0224 Equate Symbol: IXCMSGCRSNTOKENNOTFORRELEASEMSG

Meaning: The input message token identified by TOKEN or SENDTOKEN is not valid for Release Message (RELEASEMSG). The message token must be a token that was returned by the IXCMSGOX service via the RETMSGOTOKEN keyword or a send token that was returned by the IXCSEND service via the RETMSGTOKEN keyword.

Action: Verify the token and retry the request with the correct message token.

8 xxxx0308 Equate Symbol: IXCMSGCRSNBADRETMSGTOKENALET

Meaning: The ALET that qualifies the address of the RETMSGTOKEN is not zero, nor a valid entry on the dispatchable unit access list (DU-AL), nor a valid entry for a common area data space.

Action: Ensure that:
  • Your program is not intended to run in primary ASC mode.
  • You specified SYSSTATE ASCENV=AR before issuing the IXCMSGC macro.
  • The ALET for the parameter list is a valid public entry on the DU-AL, is zero (primary address space ALET), or for a common area data spece.
8 xxxx0309 Equate Symbol: IXCMSGCRSNBADRETMSGTOKENADDRESS

Meaning: The RETMSGTOKEN was not accessible. The message control service was not able to store a message token in the storage area specified by RETMSGTOKEN.

Action: Verify the storage area is accessible to XCF and retry the request.

8 xxxx030A Equate Symbol: IXCMSGCRSNBADEXITFORCALLEXIT

Meaning: For a CALLEXIT request, XCF attempted to call the user routine but the message or message notify user routine abended. The user routine address might not be valid or the user routine might have done some processing. The specified message might have been processed by the user routine before it abended. As such, the token might or might not specify a currently valid message.

Action: If necessary, perform any recovery action and resource cleanup for the user routine.

Verify the user routine address and retry the CALLEXIT request.

8 xxxx030E Equate Symbol: IXCMSGCRSNTASKMODECALLEXITWITHFRR

Meaning: For a CALLEXIT request that was made in task mode, the caller had an FRR established.

Action: Correct your program so that it does not issue an IXCMSGC CALLEXIT request with FRRs established while in task mode.

8 xxxx0C14 Equate Symbol: IXCMSGCRSNTOKENNOTFORQUERYMSG

Meaning: Environmental error. TOKEN not valid for IXCMSGC QUERYMSG service.

Action: Retry the request with the correct token.

8 xxxx0C1C Equate Symbol: IXCMSGCRSNBADMQAALEVEL

Meaning: MQAALEVEL specified for the QUERYMSG request was not valid.

Action: Retry the request with a MQAALEVEL that is supported by the local system and by the DATATYPE. The IXCYMQAA macro documents the supported MQAALEVEL.

8 xxxx0C1D Equate Symbol: IXCMSGCRSNHOLDTIMENOTSET

Meaning: HOLDTIME(CONTINUE) was specified for a message that had not previously been saved.

Action: Retry the request specifying HOLDTIME(SET) or omit the HOLDTIME(CONTINUE) keyword to allow the message to be saved indefinitely.

C xxxx0C1E Equate Symbol: IXCMSGCRSNHOLDTIMEINVALID

Meaning: HOLDTIME(SET) was specified with an invalid TIME value. TIME must be a non-zero value.

Action: Use the message control DISCARDMSG service to discard one or more messages in order to make more storage available.

C xxxx0C0C Equate Symbol: IXCMSGCRSNDUALCANNOTBEEXPANDED

Meaning: Specify a TIME value that is non-zero.

Action: Retry the request at a later time or remove an entry from the DU-AL and retry the request.

C xxxx0C10 Equate Symbol: IXCMSGCRSNNOWORKINGSTORAGE

Meaning: Environmental error. An IXCMSGC request could not be performed because XCF could not obtain enough working storage in the caller's address space to process the request.

Action: Retry your request at a later time.

C xxxx0C18 Equate Symbol: IXCMSGCRSNMSGPENDING

Meaning: Environmental error. The CALLEXIT service is not valid for a message-out request that is not yet completed.

Action: Reissue the CALLEXIT request after the message is completed. Use the IXCMSGC COMPLETION service to force the message to be considered complete, if necessary.

10 None Meaning: System failure. XCF processing failure.

Action: Save the return and reason code information and contact the IBM Support Center.

Go to the previous page Go to the next page




Copyright IBM Corporation 1990, 2014