APPC Common Return Codes

This appendix describes the primary (and, if applicable, secondary) return codes that are common to several APPC verbs.

Verb-specific return codes are described in the documentation for the individual verbs.

AP_ALLOCATION_ERROR

Personal Communications and Communications Server has failed to allocate a conversation. The conversation state is set to RESET. This code can be returned through a verb issued after ALLOCATE or MC_ALLOCATE. The associated secondary return codes are as follows:

AP_ALLOCATION_FAILURE_NO_RETRY

The conversation cannot be allocated because of a permanent condition, such as a configuration error or session protocol error. To determine the error, the system administrator should examine the error log file. Do not attempt to retry the allocation until the error has been corrected.

AP_ALLOCATION_FAILURE_RETRY

The conversation could not be allocated because of a temporary condition, such as a link failure. The reason for the failure is logged in the system error log. Retry the allocation, preferably after a timeout to permit the condition to clear.

AP_CANCELLED

The verb returned because the conversation was canceled (the transaction program issued a CANCEL_CONVERSATION verb).

AP_CONV_FAILURE_NO_RETRY

The conversation was terminated because of a permanent condition, such as a session protocol error. The system administrator should examine the system error log to determine the cause of the error. Do not retry the conversation until the error has been corrected.

AP_CONV_FAILURE_RETRY

The conversation was terminated because of a temporary error. Restart the transaction program to see if the problem occurs again. If it does, the system administrator should examine the error log to determine the cause of the error.

AP_CONVERSATION_TYPE_MISMATCH

The requested transaction program cannot support conversations of the type (basic or mapped) specified in the allocation request. This indicates a mismatch between the local and partner transaction programs.

AP_CONVERSATION_TYPE_MIXED

The transaction program has attempted to mix conversation verbs for different conversation types on the same conversation. For example, the transaction program issued an MC_ALLOCATE verb followed by a CONFIRM verb.

AP_DEALLOC_ABEND

The conversation has been deallocated for one of the following reasons.

The partner transaction program has issued the MC_DEALLOCATE verb with dealloc_type set to AP_ABEND.
The partner transaction program has ended abnormally, causing the partner LU to send an MC_DEALLOCATE request.

AP_DEALLOC_ABEND_PROG

The conversation has been deallocated for one of the following reasons.

The partner transaction program has issued the DEALLOCATE verb with dealloc_type set to AP_ABEND_PROG.
The partner transaction program has ended abnormally, causing the partner LU to send a DEALLOCATE request.

AP_DEALLOC_ABEND_SVC

The conversation has been deallocated because the partner transaction program issued the DEALLOCATE verb with dealloc_type set to AP_ABEND_SVC.

AP_DEALLOC_ABEND_TIMER

The conversation has been deallocated because the partner transaction program has issued the DEALLOCATE verb with dealloc_type set to AP_ABEND_TIMER.

AP_DEALLOC_NORMAL

This return code does not indicate an error. The partner transaction program issued the DEALLOCATE or MC_DEALLOCATE verb with dealloc_type set to one of the following values.

AP_FLUSH
AP_SYNC_LEVEL with the synchronization level of the conversation specified as AP_NONE

AP_DUPLEX_TYPE_MIXED

The transaction program has attempted to issue a conversation verb with a different conversation duplex_type. For example, the transaction program issued a half-duplex MC_FLUSH verb (without AP_FULL_DUPLEX_CONVERSATION set in opext) on a full-duplex conversation.

AP_ERROR_INDICATION

This return code is used on full-duplex conversations only. A send queue operation has failed because the partner transaction program has terminated the conversation. If the conversation state is send-only, the conversation has now ended. If the conversation state is send-receive or receive-only, the conversation will end when the appropriate return code is returned to a receive queue verb. The associated secondary return codes are:

AP_ALLOCATION_ERROR_PENDING

The remote LU rejected the allocation request.

AP_DEALLOC_ABEND_PROG_PENDING

The conversation has been deallocated for one of the following reasons:

The partner transaction program has issued the DEALLOCATE verb with dealloc_type set to AP_ABEND_PROG.
The partner transaction program has ended abnormally causing the partner LU to send a DEALLOCATE request.

AP_DEALLOC_ABEND_SVC_PENDING

The conversation has been deallocated because the partner transaction program issued the DEALLOCATE verb with dealloc_type set to AP_ABEND_SVC.

AP_DEALLOC_ABEND_TIMER_PENDING

The conversation has been deallocated because the partner transaction program issued the DEALLOCATE verb with dealloc_type set to AP_ABEND_TIMER.

AP_UNKNOWN_ERROR_TYPE_PENDING

The conversation has been deallocated by the partner transaction program, but the local LU does not recognize the reason.

AP_OPERATION_INCOMPLETE

The transaction program issued a nonblocking verb that started processing, but did not complete. When verb processing completes, the final return code will be set and the stub will notify the transaction program.

AP_PIP_NOT_ALLOWED

The requested transaction program cannot receive program initialization parameters (PIP). This indicates a mismatch between the local and partner transaction programs.

AP_PIP_NOT_SPECIFIED_CORRECTLY

The requested transaction program can receive program initialization parameters (PIP), but detected an error in the supplied PIP. This indicates a mismatch between the local and partner transaction programs.

AP_PROG_ERROR_NO_TRUNC

The partner transaction program has issued one of the following verbs while the conversation was in SEND state.

SEND_ERROR with err_type set to AP_PROG
MC_SEND_ERROR

Data was not truncated.

AP_PROG_ERROR_PURGING

The partner transaction program issued one of the following verbs while in RECEIVE, PENDING_POST, CONFIRM, CONFIRM_SEND, or CONFIRM_DEALLOCATE state.

SEND_ERROR with err_type set to AP_PROG.
MC_SEND_ERROR

Data sent, but not yet received, is purged.

AP_PROG_ERROR_TRUNC

In SEND state, after sending an incomplete logical record, the partner transaction program issued a SEND_ERROR verb with err_type set to AP_PROG. The local transaction program might have received the first part of the logical record through a RECEIVE verb.

AP_SEC_REQUESTED_NOT_SUPPORTED

The local LU is unable to allocate a conversation because the session with the partner LU does not support Password Substitution. The security type requested on the ALLOCATE or SEND_CONVERSATION is AP_PGM_STRONG, that requires Password Substitution support.

AP_SECURITY_NOT_VALID

The user ID or password specified in the allocation request was not accepted by the partner LU.

AP_SVC_ERROR_NO_TRUNC

While in SEND state, the partner transaction program (or partner LU) issued a SEND_ERROR verb with err_type set to AP_SVC. Data was not truncated.

AP_SVC_ERROR_PURGING

The partner transaction program (or partner LU) issued a SEND_ERROR verb with err_type set to AP_SVC while in RECEIVE, PENDING_POST, CONFIRM, CONFIRM_SEND, or CONFIRM_DEALLOCATE state. Data sent to the partner transaction program might have been purged.

AP_SVC_ERROR_TRUNC

In SEND state, after sending an incomplete logical record, the partner transaction program (or partner LU) issued a SEND_ERROR verb. The local transaction program might have received the first part of the logical record.

AP_SYNC_LEVEL_NOT_SUPPORTED

The requested transaction program cannot support conversations with the sync_level (AP_NONE, AP_CONFIRM_SYNC_LEVEL or AP_SYNCPT) specified in the allocation request. This indicates a mismatch between the local and partner transaction programs.

AP_TP_BUSY

The local transaction program has issued a blocking verb to Personal Communications while Personal Communications was processing another verb for the same conversation.

AP_TP_NAME_NOT_RECOGNIZED

The transaction program name specified in the allocation request is not recognized by the partner LU.

AP_TRANS_PGM_NOT_AVAIL_NO_RTRY

The remote LU rejected the allocation request because it was unable to start the requested partner transaction program. The requested transaction program (TP) is not available because of a permanent or semi-permanent condition. The reason for the error might be logged on the remote node. The condition will not clear itself without operator intervention. The transaction program should not retry the conversation until the error condition has been cleared.

AP_TRANS_PGM_NOT_AVAIL_RETRY

The remote LU rejected the allocation request because it was unable to start the requested partner transaction program. The requested transaction program (TP) is not available because of a transient condition, such as a timeout. The reason for the error might be logged on the remote node. The condition might clear itself without operator intervention. The transaction program should retry the conversation, preferably after a timeout to permit the condition to clear.

AP_UNEXPECTED_SYSTEM_ERROR

Personal Communications and Communications Server has encountered an unexpected system error, and cannot complete the verb. Usually these errors arise from a shortage of system resources (for example, memory), and are usually transient. Check the system log for more details.