The Set_Partner_Tsel_Format (CMSPTF) call sets the value for the T-SEL-FORMAT characteristic of the partner application of the conversation. The call overwrites the value assigned using the Initialize_Conversation call. After the Allocate call, this call can no longer be issued.
This function is one of the additional functions of the UPIC carrier system; it is not a component of the CPI-C interface.
UPIC-Local on Unix, Linux and Windows systems:
Connection via UPIC local does not support the Set_Partner_Tsel_Format call.
CMSPTF (conversation_ID, tsel_format, return_code)
Parameters
--> conversation_ID | Conversation identifier |
--> tsel_format | Specifies which character set is to be used for the transport selector (TSEL). The following values can be entered:
|
<-- return_code | Result of the function call. |
Result (return_code)
CM_OK
The call is OK.
CM_CALL_NOT_SUPPORTED
This return code only applies to Unix, Linux and Windows systems.
The function is not supported. This return code only occurs in UPIC-L. It indicates to the program that a TSEL format cannot be assigned because UPIC-L does not require this information as a result of the underlying communication system.
CM_PROGRAM_PARAMETER_CHECK
The value of either conversation_ID or tsel_format is invalid.
CM_PROGRAM_STATE_CHECK
The conversation is not in the “Initialize” state.
CM_PRODUCT_SPECIFIC_ERROR
The UPIC instance could not be found.
State change
The call does not change the state of the conversation.
Behavior in the event of errors
CM_PROGRAM_PARAMETER_CHECK
Modify program.
CM_PROGRAM_STATE_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.
CM_CALL_NOT_SUPPORTED
This return code only applies to Unix, Linux and Windows systems.
This is not necessarily an error: If the application is intended for both UPIC-L and UPIC-R this return code just means that the application is linked to a UPIC-L library. The program can take note of this return code and avoid making further calls to set address information.
CM_ENTRY Set_Partner_TSEL_Format ( unsigned char CM_PTR conversation_ID, CM_TSEL_Format CM_PTR tsel_format, CM_RETURN_CODE CM_PTR return_code )