Extract_Conversation_Security_User_ID (CPI-C)

Article
04/19/2022

The Extract_Conversation_Security_User_ID call (function name cmecsu) returns the user identifier being used in a specified conversation.

Syntax

  
CM_ENTRY Extract_Conversation_Security_User_ID(   
  unsigned char FAR *conversation_ID,    
  unsigned char FAR *security_user_ID,    
  CM_INT32 FAR *security_user_ID_length,    
  CM_INT32 FAR *return_code              
);

Parameters

conversation_ID
Supplied parameter. Specifies the identifier for the conversation. The value of this parameter was returned by Initialize_Conversation or Accept_Conversation.

security_user_ID
Returned parameter. Specifies the user identifier that was used to establish the conversation.

security_user_ID_length
Returned parameter. Specifies the length of security_user_ID.

return_code
The code returned from this call. The valid return codes are listed later in this topic.

Return Codes

CM_OK
Primary return code; the call executed successfully.

CM_PROGRAM_PARAMETER_CHECK
Primary return code; the value specified by conversation_ID is invalid.

State Changes

The conversation can be in any state except RESET.

There is no state change.

Remarks

The security_user_ID value is not padded with spaces. It is meaningful only up to security_user_ID_length.

Share via