The Extract_Conversation_State call (CMECS) is used to provide the program with the current state of the conversation.
CMECS (conversation_ID, conversation_state, return_code)
Parameters
--> conversation_ID | Conversation identifier |
<-- conversation_state | The conversation_state variable can have one of the following values:
|
<-- return_code | Result of the function call. |
Result (return_code)
CM_OK
The call is OK.
CM_PROGRAM_PARAMETER_CHECK
The value of conversation_ID is invalid.
CM_PRODUCT_SPECIFIC_ERROR
The UPIC instance could not be found.
State change
The call does not change the state of the conversation.
Notes
If the return code is not CM_OK, the value for conversation_state has no significance.
For the states “Start” and “Reset”, there is never a valid conversation_ID.
Behavior in the event of errors
CM_PROGRAM_PARAMETER_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_ENTRY Extract_Conversation_State (unsigned char CM_PTR conversation_ID, CM_CONVERSATION_STATE CM_PTR conversation_state, CM_RETURN_CODE CM_PTR return_code )