HP-UX SNAplus2 CPI-C Programmer's Guide (June 2003)

CPI-C Calls
Set_Return_Control (cmsrc)
Chapter 3 283
CM_IMMEDIATE The LU allocates a contention winner
session, if one is immediately
available, and returns control to the
program.
CM_WHEN_SESSION_ALLOCATED The LU does not return
control to the program until it
allocates a session or encounters
certain errors. If a session is not
available, the program waits for one.
(If the session limit is 0, the LU
returns control immediately.)
Returned Parameters
After the verb executes, SNAplus2 returns parameters to indicate
whether the execution was successful and, if not, to indicate the reason
the execution was unsuccessful.
return_code Possible values are:
CM_OK The call executed successfully.
CM_PROGRAM_STATE_CHECK The conversation is not in
Initialize state.
CM_PROGRAM_PARAMETER_CHECK The value specified by
conversation_ID or
return_control is not valid.
CM_PRODUCT_SPECIFIC_ERROR For an explanation of
this return code, see Appendix A,
“Common Return Codes.”
State When Issued
The conversation must be in Initialize state.
State Change
There is no state change.