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

CPI-C Calls
Set_CPIC_Side_Information (xcmssi)
Chapter 3 251
CM_OK The call executed successfully.
CM_PROGRAM_PARAMETER_CHECK One of the following
has occurred:
• A value specified in the
side_info_entry structure is
not valid
• The first character of the
side_info_entry contains a
space
CM_PRODUCT_SPECIFIC_ERROR For an explanation of
this return code, see Appendix A,
“Common Return Codes.”
State When Issued
The conversation can be in any state.
State Change
There is no state change.
Usage Notes
This call does not modify the side information held in the configuration
file; the change applies only to this application. SNAplus2 stores the
modified information in memory associated with this operating system
process; the change is discarded when the process ends (or when the
application issues the Delete_CPIC_Side_Information call to remove the
entry). For more details, see “Side Information” in Chapter 2.
If the return_code is not CM_OK, the side information is unchanged.
String parameters in the side information that are not valid (for
example, specifying a nonexistent partner LU) are not detected until the
Allocate call is issued. The error is returned on a call following Allocate.