Send_Data (CPI-C)

L’appel Send_Data (nom de la fonction cmsend) place les données dans la mémoire tampon d’envoi de l’unité logique locale (LU) pour les transmettre au programme partenaire.

Syntaxe

  
CM_ENTRY Send_Data(   
  unsigned char FAR *conversation_ID,    
  unsigned char FAR *buffer,             
    CM_INT32 FAR *send_length,             
    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.

Tampon
Paramètre fourni. Spécifie l’adresse de la mémoire tampon contenant les données à placer dans la mémoire tampon d’envoi de LU locale.

send_length
Paramètre fourni. Spécifie le nombre d’octets de données à placer dans la mémoire tampon d’envoi de LU locale. La plage est comprise entre 0 et 32767.

Pour une conversation mappée, si send_length est défini sur zéro, un enregistrement de données null est envoyé au programme partenaire.

Pour une conversation de base, si send_length est défini sur zéro, aucune donnée n’est envoyée. Le paramètre de mémoire tampon n’est pas pertinent. Toutefois, les autres paramètres sont traités.

request_to_send_received
Paramètre retourné. Il s’agit de l’indicateur request-to-send-received. Les valeurs possibles sont les suivantes :

CM_REQ_TO_SEND_RECEIVED
Le programme partenaire a émis l’appel 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 lancé l’appel Request_To_Send . Cette valeur n’est pas pertinente si return_code est défini sur CM_PROGRAM_PARAMETER_CHECK ou CM_PROGRAM_STATE_CHECK.

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_OPERATION_NOT_ACCEPTED
Code de retour principal ; une opération précédente sur cette conversation est incomplète.

CM_OPERATION_INCOMPLETE
Code de retour principal ; l’opération n’est pas terminée (le mode de traitement n’est pas bloquant uniquement) et est toujours en cours. Le programme peut émettre des Wait_For_Conversation pour attendre la fin de l’opération, ou Cancel_Conversation d’annuler l’opération et la conversation. Si Specify_Windows_Handle a été appelé, l’application doit attendre la notification d’un message Microsoft® Windows® et ne pas appeler Wait_For_Conversation.

CM_PROGRAM_PARAMETER_CHECK
Code de retour principal ; l’un des événements suivants s’est produit :

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

• La valeur spécifiée par send_length est hors de la plage (supérieure à 32767).

• Il s’agit d’une conversation de base et les deux premiers octets de mémoire tampon contiennent une longueur d’enregistrement logique non valide (0x0000, 0x0001, 0x8000 ou 0x8001).

  CM_PROGRAM_STATE_CHECK
  Code de retour principal ; l’un des événements suivants s’est produit :

• L’état de la conversation n’est pas SEND ou SEND_PENDING.

• La conversation de base est à l’état SEND et send_type est défini sur CM_SEND_AND_CONFIRM, CM_SEND_AND_DEALLOCATE ou CM_SEND_AND_PREP_TO_RECEIVE. Toutefois, les données ne se terminent pas sur une limite d’enregistrement logique. Cette condition n’est autorisée que lorsque deallocate_type est défini sur CM_DEALLOCATE_ABEND et que le send_type est défini sur CM_SEND_AND_DEALLOCATE.

  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.

  CM_CONVERSATION_TYPE_MISMATCH
  Code de retour principal ; l’unité lu ou le programme partenaire ne prend pas en charge le type de conversation (de base ou mappé) spécifié dans la demande d’allocation.

  CM_PIP_NOT_SPECIFIED_CORRECTLY
  Code de retour principal ; la demande d’allocation a été rejetée par un programme de transaction (TP) non CPI-C LU 6.2. Le programme partenaire nécessite une ou plusieurs variables de données PIP, qui ne sont pas prises en charge par CPI-C.

  CM_SECURITY_NOT_VALID
  Code de retour principal ; l’identificateur utilisateur ou le mot de passe spécifié dans la demande d’allocation n’a pas été accepté par l’unité lu partenaire.

  CM_SYNC_LEVEL_NOT_SUPPORTED_PGM
  Code de retour principal ; le programme partenaire ne prend pas en charge le niveau de synchronisation spécifié dans la demande d’allocation.

  CM_TPN_NOT_RECOGNIZED
  Code de retour principal ; l’unité lu partenaire ne reconnaît pas le nom du programme spécifié dans la demande d’allocation.

  CM_TP_NOT_AVAILABLE_NO_RETRY
  Code de retour principal ; l’unité lu partenaire ne peut pas démarrer le programme spécifié dans la demande d’allocation en raison d’une condition permanente. La raison de l’erreur peut être consignée sur le nœud distant. Ne réessayez pas l’allocation tant que l’erreur n’a pas été corrigée.

  CM_TP_NOT_AVAILABLE_RETRY
  Code de retour principal ; l’unité lu partenaire ne peut pas démarrer le programme spécifié dans la demande d’allocation en raison d’une condition temporaire. La raison de l’erreur peut être consignée sur le nœud distant. Réessayez l’allocation.

  CM_PROGRAM_ERROR_PURGING
  Code de retour principal ; l’un des événements suivants s’est produit :

• Dans l’état RECEIVE ou CONFIRM, le programme partenaire a émis Send_Error. Les données envoyées mais pas encore reçues sont purgées.

• Dans SEND_PENDING état avec le sens de l’erreur défini sur CM_RECEIVE_ERROR, le programme partenaire a émis Send_Error. Les données n’ont pas été purgées.

  CM_RESOURCE_FAILURE_NO_RETRY
  Code de retour principal ; l’un des événements suivants s’est produit :

• La conversation a été interrompue prématurément en raison d’une condition permanente. Ne réessayez pas tant que l’erreur n’a pas été corrigée.

• Le programme partenaire n’a pas libéré la conversation avant de se terminer normalement.

  CM_RESOURCE_FAILURE_RETRY
  Code de retour principal ; la conversation a été interrompue prématurément en raison d’une condition temporaire, telle qu’une défaillance du modem. Réessayez la conversation.

  CM_DEALLOCATED_ABEND
  Code de retour principal ; la conversation a été libérée pour l’une des raisons suivantes :

• Le programme distant a émis Deallocate avec le paramètre de type défini sur CM_DEALLOCATE_ABEND, ou l’unité lu distante l’a fait en raison d’une condition de fin anormale du programme distant. Si la conversation pour le programme distant était à l’état RECEIVE lors de l’émission de l’appel, les informations envoyées par le programme local et non encore reçues par le programme distant sont purgées.

• Le TP distant s’est terminé normalement, mais n’a pas libéré la conversation avant de se terminer. Les services de nœud au niveau de l’unité lu distante ont libéré la conversation au nom du TP distant.

  CM_DEALLOCATED_ABEND_SVC
  Code de retour principal ; la conversation a été libérée pour l’une des raisons suivantes :

• Le programme partenaire a émis La libération avec le paramètre de type défini sur ABEND_SVC.

• Le programme partenaire n’a pas libéré la conversation avant de se terminer.

  Si la conversation est à l’état RECEIVE pour le programme partenaire lorsque cet appel est émis par le programme local, les données envoyées par le programme local et non encore reçues par le programme partenaire sont purgées.

  CM_DEALLOCATED_ABEND_TIMER
  Code de retour principal ; la conversation a été désallouée, car le programme partenaire a émis Désallouer avec le paramètre de type défini sur ABEND_TIMER. Si la conversation est à l’état RECEIVE pour le programme partenaire lorsque cet appel est émis par le programme local, les données envoyées par le programme local et qui ne sont pas encore reçues par le programme partenaire sont vidées.

  CM_SVC_ERROR_PURGING
  Code de retour principal ; dans l’état SEND, le programme partenaire ou l’unité logique partenaire émis Send_Error avec le paramètre de type défini sur SVC. Les données envoyées au programme partenaire ont peut-être été purgées.

  Changements d’état

  La conversation doit être à l’état SEND ou SEND_PENDING lorsque le programme émet cet appel.

  Le tableau suivant récapitule les changements d’état possibles lorsque return_code est défini sur CM_OK.

Pour une valeur return_code de CM_PROGRAM_ERROR_PURGING ou CM_SVC_ERROR_PURGING, la conversation passe à l’état RECEIVE. Pour les autres valeurs non CM_OK, la conversation passe à l’état RESET.

Remarques

Les données collectées dans la mémoire tampon d’envoi locale des unités logiques locales sont transmises à l’unité logique partenaire et au programme partenaire quand l’une des opérations suivantes se produit :

• La mémoire tampon d’envoi se remplit.

• Le programme local émet un appel de vidage, de confirmation ou de désallocation ou un autre appel qui vide la mémoire tampon d’envoi des unités logiques. (Certains types d’envoi, définis par Set_Send_Type, incluent la fonctionnalité de vidage.)

  Les données à envoyer peuvent être les suivantes :

• Enregistrement de données complet sur une conversation mappée. Un enregistrement de données complet est une chaîne de la longueur spécifiée par le paramètre send_length .

• Un enregistrement logique complet ou une partie de celui-ci sur une conversation de base. Un enregistrement logique complet est déterminé par la valeur LL. (Un enregistrement logique peut se terminer et un nouvel enregistrement commence au milieu de la chaîne de données à envoyer.)

  La lu n’effectue pas automatiquement de conversion entre ASCII et EBCDIC sur la chaîne de données à envoyer. Si nécessaire, le programme peut utiliser le common service verb (CSV) CONVERT pour traduire une chaîne d’un jeu de caractères à l’autre.