Set_Mode_Name (CPI-C)

L’appel Set_Mode_Name (cmsmn du nom de fonction) est émis par le programme appelant pour spécifier le nom de mode d’une conversation. Cet appel remplace le nom du mode défini par le système dérivé des informations latérales lorsque l’appel Initialize_Conversation a été émis. Cet appel ne peut pas être émis une fois l’allocationémise. L’émission de cet appel n’a aucun effet sur les informations latérales proprement dites.

Syntaxe

  
CM_ENTRY Set_Mode_Name(   
  unsigned char FAR *conversation_ID,    
  unsigned char FAR *mode_name,      
  CM_INT32 FAR *mode_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.

mode_name
Paramètre fourni. Spécifie l’adresse de départ du nom du mode (nom d’un ensemble de caractéristiques réseau définies pendant la configuration). Le nom du mode peut contenir jusqu’à huit caractères ASCII. Les caractères autorisés sont les suivants :

• Lettres majuscules.

• Chiffres de 0 à 9.

  La valeur de mode_name doit correspondre au nom d’un mode associé à l’unité logique partenaire (LU) pendant la configuration. Le nom du mode ne peut pas être SNASVCMG ou CPSVCMG.

  mode_name_length
  Paramètre fourni. Spécifie la longueur du nom du mode. La plage est comprise entre 0 et 8 octets.

  Si mode_name_length est défini sur zéro, Set_Mode_Name est ignoré.

  return_code
  Code retourné à partir de 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 dans 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 mode_name_length est hors plage (supérieure à 8 ou inférieure à 0).

  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.

Modifications d’état

La conversation doit être dans l’état INITIALIZE.

Il n’y a aucune modification d’état.

Remarques

La spécification d’une valeur non valide pour mode_name n’est pas détectée tant que l’allocation n’est pas émise.