Set_Convertion - Setting the CHARACTER_CONVERTION conversation characteristic

The Set_Convertion (CMSCNV) call sets the CHARACTER_CONVERTION conversation characteristic.

Set_Convertion changes the values that were taken from the side information during the Initialize_Conversation call. The changed values apply only for the duration of a conversation. The values in the side information are not changed.

The Set_Convertion call can no longer be issued after the Allocate call.

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

Syntax

CMSCNV (conversation_ID, character_convertion, return_code)

Parameters

--> conversation_ID	Conversation identifier
--> character convertion	Specifies whether code conversion for the user data is to be performed or not. The following values can be set 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 or the value for CHARACTER_CONVERTION 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 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: Set_Convertion

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