Extract_Mode_Name

The Extract_Mode_Name call (function name cmemn) returns the mode name and mode name length for a specified conversation.

CM_ENTRY Extract_Mode_Name(

unsigned char FAR *conversation_ID,  
  unsigned char FAR *mode_name,    
  CM_INT32 FAR *mode_name_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.

mode_name

Returned parameter. Specifies the starting address of the mode name.

mode_name_length

Returned parameter. Specifies the length of the mode name.

return_code

The code returned from this call. The valid return codes are listed below.

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.

cm_product_specific_error

Primary return code; a product-specific error occurred and has been logged in the product's error log.

State Changes

The conversation can be in any state except RESET.

There is no state change.