Set_Prepare_To_Receive_Type (CPI-C)

  • Article

L’appel Set_Prepare_To_Receive_Type (nom de fonction cmsptr) spécifie comment les appels Prepare_To_Receive suivants seront exécutés. Il remplace le traitement de préparation à la réception par défaut établi par Initialize_Conversation ou Accept_Conversation. Par défaut, le traitement de préparation à la réception est basé sur le niveau de synchronisation de la conversation.

Le type de préparation à la réception affecte tous les appels Prepare_To_Receive suivants. Il peut être modifié en rééditant Set_Prepare_To_Receive_Type.

Syntaxe

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

prepare_to_receive_type
Paramètre fourni. Spécifie comment les appels Prepare_To_Receive suivants seront exécutés. Les valeurs possibles sont les suivantes :

CM_PREP_TO_RECEIVE_CONFIRM
Utilisé pour envoyer au programme partenaire le contenu de la mémoire tampon d’envoi de l’unité logique (LU) et une demande de confirmation. À la réception de la confirmation, la conversation passe à l’état RECEIVE.

CM_PREP_TO_RECEIVE_FLUSH
Permet d’envoyer au programme partenaire le contenu de la mémoire tampon d’envoi des unités logiques locales et remplace la conversation par l’état RECEIVE.

CM_PREP_TO_RECEIVE_SYNC_LEVEL
Utilisé par le niveau de synchronisation des conversations pour déterminer le traitement de préparation à la réception. Un niveau de synchronisation par défaut est établi par Initialize_Conversation et peut être remplacé par Set_Sync_Level.

Si le niveau de synchronisation de la conversation est CM_NONE, la valeur par défaut, le contenu de la mémoire tampon d’envoi des unités logiques locales est envoyé au programme partenaire et la conversation passe à l’état RECEIVE. Si le niveau de synchronisation de la conversation est CM_CONFIRM, le contenu des unités logiques locales envoie la mémoire tampon et une demande de confirmation est envoyée au programme partenaire. La conversation passe à l’état RECEIVE lorsque le programme partenaire émet Confirm, répondant à la demande de confirmation.

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 ; l’une des opérations suivantes s’est produite :

  • La valeur spécifiée par prepare_to_receive_type ou conversation_ID n’est pas valide.

  • Le paramètre prepare_to_receive_type est défini sur CM_PREP_TO_RECEIVE_CONFIRM, mais le niveau de synchronisation des conversations est défini sur CM_NONE.

    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.