Disable_UTM_UPIC - Signing off from the UPIC carrier system

A program uses the Disable_UTM_UPIC (CMDISA) call to sign off from the UPIC carrier system. After the call has been successfully executed, no further CPI-C calls are permitted. If another connection exists for the program, it is cleared down. In addition, the program signs off from the transport system.

This call must be the last call of a CPI-C program. It is not needed if you continue with a further Initialize call after ending the conversation.

This function is not included in the CPI-C interface, but is one of the additional UPIC functions.

Syntax

CMDISA (local_name, local_name_length, return_code)

Parameters

--> local_name	Name of the program, i.e. the name specified in the preceding Enable_UTM_UPIC call.
--> local_name_length	Length of local_name. Minimum: 0, maximum: 8 local_name_length=0 means that an “empty local application name” is transferred (see section “Enable_UTM_UPIC - Signing on to the UPIC carrier system”)
<-- return_code	Result of the function call.

Result ( return_code )

CM_OK

The call is OK.

CM_PROGRAM_STATE_CHECK

The call is not permitted in the current state.

CM_PROGRAM_PARAMETER_CHECK

The program is not signed on to UPIC with local_name, or the value of
local_name_length is < 1 or > 8.

CM_PRODUCT_SPECIFIC_ERROR

An error occurred when signing off from UPIC or when clearing down the connection.

State change

If the return code is CM_OK, the program is signed off and enters the “Start” state. In all other error conditions, the program does not change its state.

Note

You must use this call if you wish to terminate the process with exit() in the event of an error condition in the application program.
For performance reasons, this function should only be called immediately before the process is terminated, provided no error has occurred.

Behavior in the event of errors

CM_PRODUCT_SPECIFIC_ERROR

Notify the service department and produce diagnostic report.

CM_PROGRAM_STATE_CHECK

Modify program.

CM_PROGRAM_PARAMETER_CHECK

Modify program.

Function declaration: Disable_UTM_UPIC

CM_ENTRY Disable_UTM_UPIC ( unsigned char CM_PTR  local_name,
                           CM_INT32       CM_PTR  local_name_length,
                           CM_RETURN_CODE CM_PTR  return_code)