Set_Conversation_Security_Type - Setting the security type

The Set_Conversation_Security_Type (CMSCST) call sets the value for the conversation characteristic security_type.

The call overwrites the value assigned in the Initialize_Conversation call, and must not be executed after the Allocate call.

This function is one of the advanced functions.

Syntax

CMSCST (conversation_ID, security_type, return_code)

Parameters

--> conversation_ID	Identifier of the conversation.
--> security_type	Specifies the type of access information sent when establishing the conversation with the partner application. This information is used by the partner application to check access authorization. The following values can be set for security_type: CM_SECURITY_NONE No access information is transferred to the partner application. CM_SECURITY_PROGRAM The values of the security_user_ID and security_password characteristics are used as access information. This means that the access information consists of: either a UTM user ID or a UTM user ID and a password.
<-- return_code	Result of the function call.

Result (return_code)

CM_OK

The call is OK.

CM_PROGRAM_STATE_CHECK

The conversation is not in the “Initialize” state.

CM_PROGRAM_PARAMETER_CHECK

The conversation_ID is invalid or the value in security_type is undefined.

CM_PARM_VALUE_NOT_SUPPORTED

A value not supported by CPI-C has been entered in security_type.

CM_PRODUCT_SPECIFIC_ERROR

The UPIC instance could not be found.

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

State change

None.

Notes

• If the value CM_SECURITY_PROGRAM is entered in security_type, the user ID and possibly the password must be set using the following calls: Set_Conversation_Security_User_ID and Set_Conversation_Security_Password.

• If only the user ID is required for the access check, the Set_Conversation_Security_Password call is not necessary.

Behavior in the event of errors

CM_PROGRAM_PARAMETER_CHECK

Modify program.

CM_PARM_VALUE_NOT_SUPPORTED

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.

Function declaration: Set_Conversation_Security_Type

CM_ENTRY Set_Conversation_Security_Type (
           unsigned char                  CM_PTR conversation_ID,
           CM_CONVERSATION_SECURITY_TYPE  CM_PTR conversation_security_type,
           CM_RETURN_CODE                 CM_PTR return_code )