Extract_Convertion - Querying the value of the CHARACTER_CONVERTION conversation characteristic

The Extract_Convertion (CMECNV) call provides the program with the current value of the CHARACTER_CONVERTION conversation characteristic.

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

The Extract_Convertion call is permitted only in the “Initialize” state.

Syntax

CMECNV (conversation_ID, character_convertion, return_code)

Parameters

--> conversation_ID	Conversation identifier
<-- character_convertion	The value specifies whether code conversion is carried out or not for the user ID. The following values can be returned for character_convertion. CM_NO_CHARACTER_CONVERTION There is no automatic code conversion when data is sent or received. CM_IMPLICIT_CHARACTER_CONVERTION Data is automatically converted when sent or received (see also section “Code conversion”).
<-- return_code	Result of the function call.

Result (return_code)

CM_OK

The call is OK

CM_PROGRAM_PARAMETER_CHECK

The value in conversation_ID is invalid.

CM_PRODUCT_SPECIFIC_ERROR

The UPIC instance could not be found.

CM_PROGRAM_STATE_CHECK

The conversation is not in the “Initialize” state.

State change

The call does not change the state of the conversation.

Note

If the return code is not CM_OK, the CHARACTER_CONVERTION characteristic remains unchanged.

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 internal buffers. Check whether the memory requirement of your program is too high and if necessary reboot your system.

Function declaration: Extract_Convertion

CM_ENTRY Extract_Convertion( 
                       unsigned char                 CM_PTR  conversation_ID,
                       CM_CHARACTER_CONVERTION_TYPE  CM_PTR  convertion_type,
                       CM_RETURN_CODE                CM_PTR  return_code )