Set_TP_Name (CPI-C)

  • Article

L’appel Set_TP_Name (nom de la fonction cmstpn) est émis par le programme d’appel pour spécifier le nom du programme partenaire (invocable). Cet appel remplace le nom du programme partenaire dérivé des informations latérales lors de l’émission de l’appel Initialize_Conversation . Cet appel ne peut pas être émis après l’émission de l’appel d’allocation . L’émission de cet appel n’a aucun effet sur les informations secondaires elles-mêmes.

Syntaxe

  
CM_ENTRY Set_TP_Name(   
  unsigned char FAR *conversation_ID,    
    unsigned char FAR *TP_name,            
    CM_INT32 FAR *TP_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.

TP_name
Paramètre fourni. Spécifie l’adresse de départ du nom du programme partenaire. Le nom du programme peut contenir jusqu’à 64 caractères ASCII. Les caractères autorisés sont les suivants :

  • Majuscules et minuscules.

  • Chiffres de 0 à 9.

  • Caractères spéciaux, à l’exception de l’espace.

    Vous ne pouvez pas utiliser Set_TP_Name pour spécifier le nom d’un programme de transaction de service SNA (TP). Vous pouvez toutefois utiliser Set_CPIC_Side_Information pour ce faire.

    Les jeux de caractères codés sur deux octets, tels que Kanji, ne sont pas pris en charge.

    TP_name_length
    Paramètre fourni. Spécifie la longueur du nom du programme partenaire. La plage est comprise entre 1 et 64.

    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_STATE_CHECK
Code de retour principal ; la conversation n’est pas à l’état INITIALIZE.

CM_PROGRAM_PARAMETER_CHECK
Code de retour principal ; l’une des opérations suivantes s’est produite :

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

  • La valeur spécifiée par TP_name_length est hors plage (supérieure à 64 ou inférieure à 1).

  • L’adresse d’une variable 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 doit être à l’état INITIALIZE.

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