Set_Deallocate_Type - Setting deallocate_type

A program uses the Set_Deallocate_Type (CMSDT) call to set the value of the conversation characteristic deallocate_type.

This call is one of the advanced functions.

Syntax

CMSDT (conversation_ID, deallocate_type, return_code)

Parameters

--> conversation_ID	Identifier of the conversation.
--> deallocate_type	Specifies the type of deallocation for a conversation. deallocate_type must have the value CM_DEALLOCATE_ABEND.
<-- return_code	Result of the function call.

Result (return_code)

CM_OK

The call is OK.

CM_PROGRAM_PARAMETER_CHECK

The conversation_ID is invalid or the value of deallocate_type is out of range. The value of deallocate_type remains unchanged.

CM_PRODUCT_SPECIFIC_ERROR

The value of deallocate_type is not CM_DEALLOCATE_ABEND.
The value of deallocate_type remains unchanged.

State change

None.

Note

The deallocate_type CM_DEALLOCATE_ABEND is used by a program to terminate a conversation unconditionally (regardless of the current state). This type of deallocation should be carried out by the program only in exceptional circumstances.

Behavior in the event of errors

CM_PROGRAM_SPECIFIC_ERROR

Modify program.

CM_PROGRAM_PARAMETER_CHECK

Modify program.

Function declaration: Set_Deallocate_Type

CM_ENTRY Set_Deallocate_Type ( unsigned char CM_PTR  conversation_ID,
                          CM_DEALLOCATE_TYPE CM_PTR  deallocate_type,
                          CM_RETURN_CODE     CM_PTR  return_code )