Set_Sync_Level - Setting a synchronization level

The Set_Sync_Level (CMSSL) call sets the value for the sync_level conversation characteristic. The call overwrites the value that was assigned at the Initialize_Conversation call.

The Set_Sync_Level call cannot be executed after an Allocate call.

This function is one of the advanced functions.

Syntax

CMSSL (conversation_ID, sync_level, return_code)

Parameters

--> conversation_ID	Identifier of the conversation.
--> sync_level	Defines the level of synchronization that the local CPI-C program and the remote UTM application can use during this conversation. sync_level must have the value CM_NONE.
<-- return_code	Result of the function call.

Result (return_code)

CM_OK

The call is OK.

CM_PROGRAM_STATE_CHECK

The conversation is not in the “Initialize” state.

CM_PROGRAM_PARAMETER_CHECK

conversation_ID is invalid or the value in sync_level is undefined.

CM_PRODUCT_SPECIFIC_ERROR

The UPIC instance could not be found.

State change

If there are no errors, this function returns the result CM_OK. This call does not change the state of the conversation.

Note

The call serves only to improve the portability of CPI-C programs. Even if it returns CM_OK, sync_level is not changed. UPIC internally always uses "sync_level=CM_NONE".

Behavior in the event of errors

CM_PROGRAM_STATE_CHECK

Modify program.

CM_PROGRAM_PARAMETER_CHECK

Modify program.

CM_PRODUCT_SPECIFIC_ERROR

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

Function declaration: Set_Sync_Level

CM_ENTRY Set_Sync_ Level ( unsigned char  CM_PTR  conversation_ID,
                           CM_SYNC_LEVEL  CM_PTR  sync_level,
                           CM_RETURN_CODE CM_PTR  return_code )