Extract_Partner_LU_Name - Querying partner_LU_Name

The Extract_Partner_LU_Name call (CMEPLN) provides the program with the current partner_LU_name of the conversation.

This call belongs to the advanced functions.

Syntax

CMEPLN(conversation_ID, partner_LU_name, partner_LU_name_length, return_code)

Parameters

--> conversation_ID	Conversation identifier
<-- partner_LU_name	Returns the partner_LU_name. The length of the parameter must be at least 32 bytes.
<-- partner_LU_name_length	Specifies the length of the value returned in partner_LU_name. Minimum: 1, maximum: 32.
<-- 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.

If the return code is not CM_OK, the value of partner_LU_name has no significance.

Behavior in the event of errors

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 requirement of your program is too high and if necessary reboot your system.

CM_PROGRAM_STATE_CHECK

Modify program

Function declaration: Extract_Partner_LU_Name

CM_ENTRY Extract_Partner_LU_Name (unsigned char CM_PTR conversation_ID,
                                unsigned char   CM_PTR partner_LU_name,
                                CM_INT32        CM_PTR partner_LU_name_length,
                                CM_RETURN_CODE  CM_PTR return_code)