Extract_Mode_Name (CPI-C)

  • Article

L’appel Extract_Mode_Name (nom de fonction cmemn) retourne le nom du mode et la longueur du nom du mode pour une conversation spécifiée.

Syntaxe

  
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          
);

Paramètres

conversation_ID
Paramètre fourni. Spécifie l’identificateur de la conversation. La valeur de ce paramètre a été retournée par Initialize_Conversation ou Accept_Conversation.

mode_name
Paramètre retourné. Spécifie l’adresse de départ du nom du mode.

mode_name_length
Paramètre retourné. Spécifie la longueur du nom du mode.

return_code
Code retourné par cet appel. Les codes de retour valides sont répertoriés plus loin dans cette rubrique.

Codes de retour

CM_OK
Code de retour principal ; l’appel a été exécuté avec succès.

CM_PROGRAM_PARAMETER_CHECK
Code de retour principal ; la valeur spécifiée par conversation_ID n’est pas valide.

CM_PRODUCT_SPECIFIC_ERROR
Code de retour principal ; une erreur spécifique au produit s’est produite et a été enregistrée dans le journal des erreurs des produits.

Changements d'état

La conversation peut être dans n’importe quel état à l’exception de RESET.

Il n’y a aucun changement d’état.