Test_Request_To_Send_Received (CPI-C)

  • Article

L’appel Test_Request_To_Send_Received (nom de fonction cmtrts) détermine si une notification de demande d’envoi a été reçue du programme partenaire.

Syntaxe

  
CM_ENTRY Test_Request_To_Send_Received(   
  unsigned char FAR *conversation_ID,    
  CM_INT32 FAR *request_to_send_received,    
  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.

request_to_send_received
Paramètre retourné. Indicateur de requête à envoyer reçu. Les valeurs possibles sont les suivantes :

CM_REQ_TO_SEND_RECEIVED
Le programme partenaire a émis Request_To_Send, qui demande au programme local de modifier la conversation à l’état RECEIVE.

CM_REQ_TO_SEND_NOT_RECEIVED
Le programme partenaire n’a pas Request_To_Send. Cette valeur n’est pas pertinente si return_code contient une valeur autre que CM_OK.

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 ou l’adresse d’une variable n’est pas valide.

CM_PROGRAM_STATE_CHECK
Code de retour principal ; la conversation est dans un état autre que SEND, RECEIVE ou SEND_PENDING.

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 doit être à l’état SEND, RECEIVE ou SEND_PENDING.

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