Set_Partner_Index - Setting the partner application index

The call Set_Partner_Index (CMSPIN) sets the index for the subsequent Set_Partner_xxx calls by the partner application in the conversation. It may no longer be called after the Allocate call. Set_Partner_xxx calls without a preceding Set_Partner_Index call are handled in the same way as after a Set_Partner_Index call with the index 1.

This function is one of the additional functions of the UPIC carrier system; it is not part of the CPI-C interface.

UPIC-Local on Unix, Linux and Windows systems:

The call Set_Partner_Index is not supported for the connection using UPIC-L.

Syntax

CMSPIN (conversation_ID, partner_index, return_code)

Parameter

--> conversation_ID	Identification of the conversation
--> partner_index	Specifies the partner_index to which the following Set_Partner_xxx calls relate. Minimum: 1 (default value); the sequence of partner_index values may not contain any gaps.
<-- return_code	Result of the function call

Result (return_code)

CM_OK

Call ok

CM_CALL_NOT_SUPPORTED

This return code only applies to Unix, Linux and Windows systems.The function is not supported.

For UPIC-L the return code always occurs.

For UPIC-R the return code only occurs if an openUTM cluster has been configured.

CM_PROGRAM_PARAMETER_CHECK

The value of the conversation_ID or for partner_index is invalid.

CM_PROGRAM_STATE_CHECK

The conversation is not in "Initialize” state.

CM_PRODUCT_SPECIFIC_ERROR

The UPIC instance could not be found or there is a memory bottleneck.

State change

The call does not change the state of the conversation.

Behavior in the event of errors

CM_CALL_NOT_SUPPORTED

Normal behavior if

• the application is linked to a UPIC-L library (on Unix, Linux and Windows systems),

• or an openUTM cluster has been configured.

In this case, the functionality is not available.

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.

Function declaration: Set_Partner_Index

CM_ENTRY Set_Partner_Index( unsigned char  CM_PTR  conversation_ID,
                            CM_INT32       CM_PTR  partner_index,
                            CM_RETURN_CODE CM_PTR  return_code )