Set_Partner_LU_Name - Setting the conversation characteristics partner_LU_name

The Set_Partner_LU_Name call (CMSPLN) sets the conversation characteristics partner_LU_name and partner_LU_name_length.

Set_Partner_LU_Name changes the values taken from the side information in the Initialize_Conversation call. The changed values only apply for the duration of a conversation; the values in the side information itself are not changed.

The Set_Partner_LU_Name call cannot be executed after the Allocate call.

This call is one of the advanced functions.

UPIC-R using UTM clusters:

The Set_Partner_LU_Name call is not supported if an openUTM cluster is configured.

Syntax

CMSPLN (conversation_ID, partner_LU_name, partner_LU_name_length, return_code)

Parameters

--> conversation_ID	Conversation identifier
--> partner_LU_name	Defines which partner_LU_name should be used.
--> partner_LU_name_length	Specifies the length of partner_LU_name. Minimum: 1, maximum: 73. UPIC-L: Minimum: 1, maximum: 8.
<-- 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 or partner_LU_name is invalid or the value in partner_LU_name_length is less than 1 or greater than 73.

CM_PROGRAM_STATE_CHECK

The conversation is not in "Initialize" state.

CM_PRODUCT_SPECIFIC_ERROR

The UPIC instance could not be found.

CM_CALL_NOT_SUPPORTED

This function is not supported.

The return code occurs with UPIC-R if an openUTM cluster has been configured. It indicates to the program that the partner_LU_name cannot be modified.

State change

The call does not change the state of the conversation.

Notes

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

• This call only sets the partner_LU_name characteristic. An invalid partner_LU_name is not detected with this call. Only the Allocate call detects an invalid partner_LU_name, if it is unable to establish a transport connection to the UTM application. In this case, it returns the CM_ALLOCATE_FAILURE_NO_RETRY return code.

• The Set_Partner_LU_Name call returns CM_OK if an application is linked with UPIC-L and passes a partner_LU_name with a length > 8. However, the partner_LU_name is cut to length 8 without notification in the following Allocate call.

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.

CM_CALL_NOT_SUPPORTED

Is not necessarily an error: The program can remember this return code and no longer issue any calls for setting address information.

Function declaration: Set_Partner_LU_Name

CM_ENTRY Set_Partner_LU_Name ( unsigned char CM_PTR  conversation_ID,
                              unsigned char  CM_PTR  partner_LU_name, 
                              CM_INT32       CM_PTR  partne_LU_name_length,
                              CM_RETURN_CODE CM_PTR  return_code )