Function :
 CAI_initFlatConversation
 CAI_releaseFlatConversation

Description

Initializes a CAI_FlatConversation structure.
Frees a CAI_FlatConversation structure.
The CAI_FlatConversation structure is a placeholder used to save the conversation when using the CAI_serializeConversationFromFactory() function

API : Application Programming Interface 

 
CaiErr CAI_initFlatConversation(     
   		CAI_FlatConversation       * flat_conversation);

void  CAI_releaseFlatConversation(     
		CAI_FlatConversation 	   * flat_conversation);

 
Field Descriptions

Parameter In/Out Description
flat_conversation In,Out A pointer to the structure that will receive the serialized conversation. The CAI_FlatConversation structure encapsulates the serialized conversation which is a printable encoded ASCII string. This output structure must have been initialized with a call to the CAI_initFlatConversation API first.
  
 
typedef struct{
       char                          *conv;
       unsigned int                  conv_len;
} CAI_FlatConversation;

 

Return Codes

Return Code Description
CAI_OK Serialization successfull
CAI_BAD_ARGS Wrong arguments
CAI_INTERNAL_ERROR Other errors

CAI_releaseFlatConversation  returns nothing.

 
Remark

The structure allocated with CAI_initFlatConversation must be released using the CAI_releaseFlatConversation.