Explanations of Return Codes for CPI Communications Services

Table 1 describes return codes that can be returned to a caller of a CPI Communications service.

Table 1. Return Codes for CPI Communications Services
Return Code	Value, Meaning, and Action
0	Value: OK Meaning: The call completed successfully. System Action: The system continues processing. Application Programmer Response: None required.
1	Value: Allocate_failure_no_retry Meaning: A TP submitted an allocate request. The request specified a value on the Return_control parameter that was other than Immediate. One of the following occurred: Virtual telecommunications access method (VTAM) could not establish a session with the partner LU. APPC/MVS could not establish a conversation. System Action: The system returns this return code to the caller of Allocate. Application Programmer Response: See Diagnosing Problems with APPC/MVS TPs for methods to use to diagnose the return code. See Error_Extract for the Error_Extract calling format. See z/OS Communications Server: SNA Programmer's LU 6.2 Guide for a description of the sense codes included in the message from Error_Extract. If the error persists, verify that the name specified on the Local_LU_name parameter is correct. If the name is correct, contact the system programmer. System Programmer Response: At the request of the application programmer, ensure that the local LU is defined correctly in the VTAM application (APPL) statement in SYS1.VTAMLST.
2	Value: Allocate_failure_retry Meaning: A TP submitted an allocate request. The request specified a value on the Return_control parameter that was other than Immediate. The system cannot allocate the conversation because of a condition that might be temporary. System Action: The system returns this return code to the caller of Allocate. Application Programmer Response: Retry the allocate request.
3	Value: Conversation_type_mismatch Meaning: The partner LU rejected an allocate request. The local TP called the Allocate service and specified a value of Basic_conversation or Mapped_conversation on the Conversation_type parameter. The partner TP does not support the respective basic or mapped conversation protocol boundary. System Action: The system returns this return code on a call that occurs after the call to Allocate. Application Programmer Response: When requesting the allocate, change the Conversation_type parameter to specify a conversation type that the partner TP supports.
6	Value: Security_not_valid Meaning: The partner LU rejected an allocate request. The specified security information is not valid. System Action: The system returns this return code on a call that occurs after the call to Allocate. Application Programmer Response: See Diagnosing Problems with APPC/MVS TPs for methods to use to diagnose the return code. See Error_Extract for the Error_Extract calling format.
8	Value: Sync_lvl_not_supported_pgm Meaning: The partner LU rejected an allocate request. The local TP specified a synchronization level (on the Sync_level parameter) that the partner TP does not support. System Action: The system returns this return code on a call that occurs after the call to Allocate. Application Programmer Response: See Allocate for an explanation of the Sync_level parameter. When requesting the allocate, ensure that the Sync_level parameter specifies a correct value.
9	Value: TPN_not_recognized Meaning: The partner LU rejected an allocate request. The local TP specified a partner TP that the partner LU does not recognize. System Action: The system returns this return code on a call that occurs after the call to Allocate. Application Programmer Response: See Diagnosing Problems with APPC/MVS TPs for methods to use to diagnose the return code. See Error_Extract for the Error_Extract calling format.
10	Value: TP_not_available_no_retry Meaning: The partner LU rejected an Allocate request. The local TP specified a partner TP that is known to the partner LU, but the partner LU cannot start the TP. The condition is not temporary. The TP should not retry the Allocate request. System Action: The system returns this return code on a call that occurs after the call to Allocate. Application Programmer Response: See Diagnosing Problems with APPC/MVS TPs for methods to use to diagnose the return code. See Error_Extract for the Error_Extract calling format.
11	Value: TP_not_available_retry Meaning: The partner LU rejected an allocate request. The local TP specified a partner TP that the partner LU recognizes but cannot start. The condition might be temporary. System Action: The system returns this return code on a call that occurs after the call to Allocate. Application Programmer Response: Retry the allocate request. If the error persists, see Diagnosing Problems with APPC/MVS TPs for methods to use to diagnose the return code. See Error_Extract for the Error_Extract calling format.
17	Value: Deallocated_abend Meaning: A partner TP called the Deallocate service. The request specified a Deallocate_type of Deallocate_abend. System Action: If the partner TP was in Receive state when it called Deallocate, the system purges information sent by the local TP that was not received by the partner TP. The system returns this return code to the local TP when it calls an APPC service in Send or Receive state. Application Programmer Response: See Diagnosing Problems with APPC/MVS TPs for methods to use to diagnose the return code. See Error_Extract for the Error_Extract calling format.
18	Value: Deallocated_normal Meaning: A partner TP called the Deallocate service for a basic or mapped conversation. The request specified a Deallocate_type of Deallocate_sync_level or Deallocate_flush. System Action: The system returns this return code to the local TP when it calls a service while the conversation is in Receive state. Application Programmer Response: See Diagnosing Problems with APPC/MVS TPs for methods to use to diagnose the return code. See Error_Extract for the Error_Extract calling format.
19	Value: Parameter_error Meaning: A local TP called an APPC service. A parameter specified on the call is not valid. One of the following occurred: SNASVCMG was specified as the mode name, or the mode name was not valid. X'0E' or X'0F' was used as the first character of a TP name. X'06' was used as the first character of a TP name by a caller that was not running either in supervisor state or with PSW key 0-7. An SNA service TP name was used with a mapped conversation service. System Action: The system might write symptom records, which describe the error, to the logrec data set. Application Programmer Response: See Diagnosing Problems with APPC/MVS TPs for methods to use to diagnose the return code. See Error_Extract for the Error_Extract calling format.
20	Value: Product_specific_error Meaning: The system found a product-specific error. System Action: The system might write symptom records, which describe the error, to the logrec data set. Application Programmer Response: See Diagnosing Problems with APPC/MVS TPs for methods to use to diagnose the return code. See Error_Extract for the Error_Extract calling format. If necessary, see Diagnosing Product-Specific Errors for more information about product-specific errors.
21	Value: Program_error_no_trunc Meaning: Indicates one of the following: A partner TP called the Send_Error service for a mapped conversation. The conversation for the local TP was in Send state. No truncation occurs at the mapped conversation protocol boundary. A partner TP called Send_Error for a basic conversation. The conversation was in Send state. The call did not truncate a logical record. No truncation occurs at the basic conversation protocol boundary when a TP calls Send_Error either before sending any logical records or after sending a complete logical record. System Action: The system returns this return code to the local TP when it calls the Receive service, before the TP receives any data records or after it receives one or more data records. Application Programmer Response: See Diagnosing Problems with APPC/MVS TPs for methods to use to diagnose the return code. See Error_Extract for the Error_Extract calling format.
22	Value: Program_error_purging Meaning: A partner TP called the Send_Error service for a basic or mapped conversation. The conversation for the partner TP was in Receive or Confirm state. System Action: The system returns this return code to the local TP when it calls an APPC service before sending any information. If the TP called Send_Error while in Receive state and before it received all the information that the partner TP sent, the system might purge the data. If the TP called Send_Error while in Receive or Confirm state but after it received all the information that the partner TP sent, the system does not purge the data. Application Programmer Response: See Diagnosing Problems with APPC/MVS TPs for methods to use to diagnose the return code. See Error_Extract for the Error_Extract calling format.
23	Value: Program_error_trunc Meaning: The partner TP called the Send_Error service for a basic conversation. The conversation for the partner TP was in Send state, and the call truncated a logical record. Truncation occurs at the basic conversation protocol boundary when a TP begins sending a logical record and then makes a Send_error call before sending the complete logical record. System Action: The system returns this return code to the local TP on a Receive call that occurs after the TP receives the truncated logical record. Application Programmer Response: See Diagnosing Problems with APPC/MVS TPs for methods to use to diagnose the return code. See Error_Extract for the Error_Extract calling format.
24	Value: Program_parameter_check Meaning: For the CPI Communications Initialize_Conversation service, the SYMDEST name was not found in the side information. System Action: The system returns this return code to the caller of the APPC service in error. Application Programmer Response: See Diagnosing Problems with APPC/MVS TPs for methods to use to diagnose the return code. See Error_Extract for the Error_Extract calling format.
25	Value: Program_state_check Meaning: The local TP called a service while running in a state in which the call is not valid. The TP should not examine any other returned variables associated with the call because nothing is placed in those variables. System Action: The state of the conversation remains unchanged. For a list of states that are valid for each call, see APPC/MVS Conversation State Table. Application Programmer Response: See Diagnosing Problems with APPC/MVS TPs for methods to use to diagnose the return code. See Error_Extract for the Error_Extract calling format.
26	Value: Resource_failure_no_retry Meaning: An error caused the conversation to terminate. The condition is not temporary. The application should not try to run the transaction until the condition is corrected. System Action: The system terminates the conversation. Application Programmer Response: See Diagnosing Problems with APPC/MVS TPs for methods to use to diagnose the return code. See Error_Extract for the Error_Extract calling format.
27	Value: Resource_failure_retry Meaning: An error caused the conversation to terminate. The condition might be temporary. System Action: The system terminates the conversation. Application Programmer Response: Retry the transaction.
28	Value: Unsuccessful Meaning: A call to a TP conversation service was not successful. System Action: The system returns this return code to the caller of the APPC service in error. Application Programmer Response: See Diagnosing Problems with APPC/MVS TPs for methods to use to diagnose the return code. See Error_Extract for the Error_Extract calling format.
30	Value: Deallocated_abend_SVC Meaning: The partner TP called Deallocate with a Deallocate_type of Deallocate_abend_SVC. System Action: If the partner TP was in Receive state when it called Deallocate, the system purges all information that was sent by the local TP but was not yet received by the partner TP. The system returns this return code to the local TP when it calls a service while in Send or Receive state. Application Programmer Response: See Diagnosing Problems with APPC/MVS TPs for methods to use to diagnose the return code. See Error_Extract for the Error_Extract calling format.
31	Value: Deallocated_abend_timer Meaning: A partner TP called the Deallocate service with a Deallocate_type of Deallocate_abend_timer. System Action: If the partner TP was in Receive state when it called Deallocate, the system purges all information that was sent by the local TP but was not yet received by the partner TP. The system returns this return code to the local TP when it calls a service while in Send or Receive state. Application Programmer Response: See Diagnosing Problems with APPC/MVS TPs for methods to use to diagnose the return code. See Error_Extract for the Error_Extract calling format.
100	Value: Take_backout Meaning: This value is returned only when all of the following conditions are true: The Sync_level is set to syncpt. The conversation is not in Initialize state. The program is using protected resources that must be backed out. System Action: The system returns this return code to the caller of the service. Application Programmer Response: Before it can use this conversation or any other protected conversations associated with the current context again, the local TP must issue a Backout call to restore all protected resources to their status as of the last synchronization point.
130	Value: Deallocated_abend_bo Meaning: This return code is returned only for conversations with Sync_level set to syncpt. The partner program issued a Deallocate call with Deallocate_type set to deallocate_abend, or the partner LU has done so because of a partner program abnormal-end condition. System Action: If the conversation for the partner program was in Receive state when the call was issued, information sent by the local program and not yet received by the partner program is purged. The conversation is now in Reset state. Application Programmer Response: Before it can use any other protected conversations associated with the current context again, the local TP must issue a Backout call to restore all protected resources to their status as of the last synchronization point.
131	Value: Deallocated_abend_SVC_bo Meaning: This return code is returned only for conversations with Sync_level set to syncpt. The partner TP called Deallocate with a Deallocate_type of deallocate_abend_SVC. System Action: If the partner TP was in Receive state when it called Deallocate, the system purges all information that was sent by the local TP but was not yet received by the partner TP. The system returns this return code to the local TP when it calls a service while in Send or Receive state. Application Programmer Response: Before it can use any other protected conversations associated with the current context again, the local TP must issue a Backout call to restore all protected resources to their status as of the last synchronization point.
132	Value: Deallocated_abend_timer_bo Meaning: This return code is returned only for conversations with Sync_level set to syncpt. A partner TP called the Deallocate service with a Deallocate_type of deallocate_abend_timer. System Action: If the partner TP was in Receive state when it called Deallocate, the system purges all information that was sent by the local TP but was not yet received by the partner TP. The system returns this return code to the local TP when it calls a service while in Send or Receive state. Application Programmer Response: Before it can use any other protected conversations associated with the current context again, the local TP must issue a Backout call to restore all protected resources to their status as of the last synchronization point.
133	Value: Resource_failure_no_retry_bo Meaning: This return code is returned only for conversations with Sync_level set to syncpt. An error caused the conversation to terminate. The condition is not temporary. The application should not try to run the transaction until the condition is corrected. The system terminates the conversation.Before it can use any other protected conversations associated with the current context again, the local TP must issue a Backout call to restore all protected resources to their status as of the last synchronization point. System Action: The system terminates the conversation. Application Programmer Response: Before it can use any other protected conversations associated with the current context again, the local TP must issue a Backout call to restore all protected resources to their status as of the last synchronization point.
134	Value: Resource_failure_retry_bo Meaning: This return code is returned only for conversations with Sync_level set to syncpt. An error caused the conversation to terminate. The condition might be temporary. System Action: The system terminates the conversation. Application Programmer Response: Before it can use any other protected conversations associated with the current context again, the local TP must issue a Backout call to restore all protected resources to their status as of the last synchronization point.
135	Value: Resource_failure_retry_bo Meaning: This return code is returned only for conversations with Sync_level set to syncpt. When the Send_Error call is issued in Receive state, incoming information is purged by the system. This purged information might include an abend deallocation notification from the partner program or system. The conversation is now in Reset state. System Action: The system returns this return code to the caller of the service. Application Programmer Response: Before it can use any other protected conversations associated with the current context again, the local TP must issue a Backout call to restore all protected resources to their status as of the last synchronization point.