Specify_Secondary_Return_Code - Setting the properties of the secondary return code

The Specify_Secondary_Return_Code (CMSSRC) call causes the program to set the secondary return code property of the CPI-C calls.

This function belongs to the additional UPIC carrier system functions; it is not a component of the CPI-C interface.

Syntax

CMSSRC (return_type, return_code)

Parameters

--> return_type	Specifies the secondary return code property of the CPI-C calls. The following values can be specified: CM_RETURN_TYPE_PRIMARY: The corresponding UPIC calls return the secondary return code. CM_RETURN_TYPE_SECONDARY: The secondary return code can be read out only by means of the CMESRC call. The corresponding UPIC calls do not return a secondary return code.
<-- return_code	Result of the function call.

Result (return_code)

CM_OK

The call is OK

CM_NO_SECONDARY_RETURN_CODE

The secondary return code property is not available.

CM_PROGRAM_PARAMETER_CHECK

The value of return_type is invalid.

CM_PROGRAM_STATE_CHECK

The program is in the “Start” state.

CM_PRODUCT_SPECIFIC_ERROR

The UPIC instance could not be found.

Note

The function can be called directly after an Enable_UTM_UPIC call. It has no effect on the Enable_UTM_UPIC call.

State change

No state change.

Behavior in the event of errors

CM_PROGRAM_PARAMETER_CHECK

Modify program.

CM_PROGRAM_STATE_CHECK

Modify program.

CM_PRODUCT_SPECIFIC_ERROR

The operating system cannot provide sufficient memory for internal buffers. Check whether the memory requirement of your program is too high and if necessary reboot your system.

CM_NO_SECONDARY_RETURN_CODE

Is not necessarily an error. If a UPIC-R application communicates with various UTM partners, some of which can support secondary return codes and some of which cannot, this return code means simply that the application wishes to communicate with a UTM application that does not support secondary return codes. The program can take note of this return code and dispense with further Extract_Secondary_Return_Code calls.

Function declaration: Specify_Secondary_Return_Code

CM_ENTRY Specify_Secondary_Return_Code (
                           CM_INT32        CM_PTR  return_type,
                           CM_RETURN_CODE  CM_PTR  return_code )