Set_Log_Data (CPI-C)

  • Article

L’appel Set_Log_Data (nom de la fonction cmsld) spécifie un message de journal (données de journal) et sa longueur à envoyer à l’unité logique partenaire (LU). Cet appel est autorisé uniquement dans les conversations de base. Il remplace les données de journal par défaut, qui sont null, et la longueur des données de journal par défaut, qui est égale à zéro.

Syntaxe

  
CM_ENTRY Set_Log_Data(   
  unsigned char FAR *conversation_ID,    
  unsigned char FAR *log_data,           
  CM_INT32 FAR *log_data_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 ou Accept_Conversation.

log_data
Paramètre fourni. Spécifie l’adresse de départ des données à envoyer à l’unité lu partenaire. Il peut contenir jusqu’à 512 caractères ASCII. Les caractères autorisés sont les suivants :

  • Majuscules et minuscules.

  • Nombres de 0 à 9.

  • Caractères spéciaux.

  • Espace.

    log_data_length
    Paramètre fourni. Spécifie la longueur des données du journal. La plage est comprise entre 0 et 512 octets.

    La longueur 0 indique qu’il n’existe aucune donnée de journal et que le paramètre log_data est ignoré.

    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’un des événements suivants s’est produit :

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

  • Le type de conversation est défini sur mappé.

  • La valeur spécifiée par log_data_length est hors plage (supérieure à 512 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.

Changements d'état

La conversation peut être dans n’importe quel état, à l’exception de RESET.

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

Remarques

Les données de journal spécifiées par Set_Log_Data sont envoyées à l’unité lu partenaire lorsque le programme local émet l’un des appels suivants :

  • Send_Error

  • Libérez avec le type de désallocation des conversations défini sur CM_DEALLOCATE_ABEND

  • Send_Data avec le type d’envoi des conversations défini sur CM_SEND_AND_DEALLOCATE et le type de libération défini sur CM_DEALLOCATE_ABEND

    Après avoir envoyé les données de journal à l’unité lu partenaire, la lu locale réinitialise les données de journal à null et la longueur des données du journal à zéro.

    CPI-C convertit automatiquement les données de journal d’ASCII en d’autres normes d’encodage, telles que EBCDIC, selon les besoins.