Extract_CPIC_Side_Information (CPI-C)

Article
10/14/2023

L’appel Extract_CPIC_Side_Information (nom de fonction xcmesi) retourne les informations latérales d’un numéro d’entrée ou d’un nom de destination symbolique.

Syntaxe

  
CM_ENTRY Extract_CPIC_Side_Information(   
  CM_INT32 FAR *entry_number,          
  unsigned char FAR *sym_dest_name,    
  SIDE_INFO FAR *side_info_entry,      
  CM_INT32 FAR *side_info_entry_length,    
    CM_INT32 FAR *return_code            
);

Paramètres

entry_number
Paramètre fourni. Spécifie le numéro (index) de l’entrée d’informations latérales à retourner. La première entrée est 1.

Le programme peut rechercher l’entrée d’informations latérales par le nom symbolique de destination à la place. Pour ce faire, définissez le numéro d’entrée sur zéro.

sym_dest_name
Paramètre fourni. Spécifie le nom de destination symbolique à rechercher.

Si entry_number est défini sur un nombre supérieur à zéro, ce paramètre est ignoré.

side_info_entry
Paramètre retourné. Spécifie l’entrée d’informations latérales. Pour obtenir une explication détaillée de l’entrée d’informations latérales, consultez Set_CPIC_Side_Information.

Chaque champ de la structure d’informations latérales est aligné à gauche et rempli d’espaces à droite si nécessaire.

side_info_entry_length
Paramètre fourni. Toujours 124.

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 :

Le entry_number spécifié un nombre supérieur au nombre maximal d’entrées dans la table d’informations latérales ou un nombre inférieur à zéro.
Le paramètre sym_dest_name n’est pas valide et entry_number est défini sur zéro.
Le paramètre side_info_entry_length n’est pas défini sur 124.

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

Cet appel n’est pas associé à une conversation et peut être dans n’importe quel état.

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

Remarques

Le mot de passe de sécurité n’est jamais retourné. Si l’identificateur d’utilisateur de sécurité dans les informations latérales n’est pas défini, le champ Identificateur d’utilisateur de sécurité est retourné comme tous les espaces.

Partager via