RCVMSG

La commande RCVMSG (Recevoir un message) est utilisée par un programme pour recevoir un message envoyé à une file d'attente de messages.

La commande RCVMSG reçoit des messages d'une file d'attente de messages d'un programme ou d'un travail (file d'attente de messages associée à un poste de liste d'appels ou file d'attente de messages externe (*EXT)) ou d'une file d'attente de messages non-programme nommée (par exemple, QSYSOPR ou file d'attente de messages de profil utilisateur). Le programme peut recevoir un message provenant d'une file d'attente de messages associée soit à son propre poste de liste d'appels, soit à un autre poste de liste d'appels.

Cette commande permet de copier, dans les variables CL d'un programme, un message provenant de la file d'attente de messages indiquée. Le message et ses attributs sont copiés dans les variables CL désignées par les paramètres KEYVAR à DTACCSID.

Vous pouvez spécifier le message à recevoir en indiquant le type du message, sa clé de référence ou ces deux éléments. Le programme recevant le message peut également spécifier, dans la commande RCVMSG, si un message est supprimé ou non de la file d'attente de messages. Si la file d'attente de messages spécifiée n'est pas allouée au travail dans lequel cette commande est entrée, ni à un autre travail, elle est allouée implicitement pour le temps nécessaire à l'exécution de la commande.

Si un message du type spécifié n'existe pas dans la file d'attente, le programme demandeur peut attendre qu'un message arrive ou poursuivre un autre traitement. Il est ainsi possible d'interroger un ensemble de files d'attente de messages.

Si le message reçu est un message d'exception non traitée, le programme peut préciser si la commande devra traiter l'exception. Un message d'exception non traitée est un message d'arrêt programme, d'état ou d'avertissement envoyé à une procédure ILE. Lorsque cette commande est lancée, la procédure ILE n'a pas encore effectué d'action pour prévenir le système que l'exception est traitée. Cette action peut être l'appel d'un programme CL recevant le message à l'aide de cette commande. Pour de plus amples informations sur les actions possibles, reportez-vous au manuel ILE Concepts, SC41-5606.

Paramètres

File msg poste liste d'appel (PGMQ)

Indique la file d'attente de messages de poste de liste d'appels dont provient un message. Il peut s'agir de la file d'attente de messages *EXT ou d'une file d'attente de messages associée à un poste de liste d'appels correspondant à un programme ou à une procédure ILE.

Si des valeurs sont précisées à ce paramètre, vous pouvez indiquer *PGMQ au paramètre File attente messages (MSGQ).

Valeurs uniques

*EXT

Le message reçu provient de la file d'attente de messages externe du travail. Celle-ci permet de communiquer avec le demandeur externe du travail tel qu'un utilisateur de clavier-écran.

Elément 1 : Relation

Le premier élément indique si la file d'attente est associée au programme ou à la procédure identifié par le second élément, ou bien à l'appelant de ce programme ou de cette procédure.

*SAME

Le message reçu provient de la file d'attente de messages du programme ou de la procédure identifié par l'élément 2.

*PRV

Le message reçu provient de la file d'attente de messages du programme ou de la procédure ayant appelé le programme ou la procédure identifié par l'élément 2 de ce paramètre.

Remarque :Si la file d'attente de messages qui précède celle identifiée par l'élément 2 est destinée à une PEP (procédure d'entrée de programme) ILE, le message est reçu de la file d'attente de messages qui précède immédiatement la file d'attente de messages PEP. En l'occurrence, il s'agit de deux files d'attente de message précédant celle qui est identifiée par l'élément 2.

Elément 2 : ID poste liste d'appel

Le deuxième élément de ce paramètre permet de fournir les informations nécessaires pour identifier un poste de liste d'appels. ce paramètre comporte trois éléments. L'élément 1 indique un nom de programme OPM ou de procédure ILE, ou encore une valeur spéciale. L'élément 2 précise le nom du module ILE utilisé comme qualificatif de la valeur spécifiée dans l'élément 1. L'élément 3 peut indiquer un nom de programme OPM ou ILE ou encore un nom de programme de service, suivant ce qui a été défini dans l'élément 1. L'élément 3 sert également de qualificatif de la valeur spécifiée dans l'élément 1.

Elément 1 : Poste de liste d'appel

*

Identifie le programme OPM ou la procédure ILE exécutant cette commande.

nom

Indiquez le nom du programme OPM ou de la procédure ILE utilisé(e) pour identifier le poste de liste d'appel.

Le nom de la procédure seul ne permet pas toujours d'identifier la procédure correcte, car différentes procédures portant le même nom peuvent être exécutées dans un travail. Une procédure peut être définie plus précisément en spécifiant l'élément 2 ou les éléments 2 et 3.

Le système commence par rechercher le nom indiqué parmi les programmes ou les procédures ayant été appelés en dernier.

Si cet élément désigne un programme OPM, le nom indiqué ne peut pas dépasser 10 caractères. S'il identifie une procédure ILE, le nom ne peut pas dépasser 256 caractères.

Il est possible d'indiquer des noms de procédure imbriqués en séparant ces derniers par un signe deux-points (:). Dans ce cas, le premier nom identifié est celui de la procédure supérieure, suivi par les procédures qu'elle contient. Le nom de la procédure inférieure est identifié en dernier dans la chaîne.

Vous pouvez indiquer des noms partiels de programmes ou de procédures en tapant trois signes inférieur à (<<<) au début du nom ou trois signes supérieur à (>>>) à la fin du nom. Si vous utilisez à la fois les signes inférieur à et supérieur à, le nom du programme ou de la procédure ne peut pas dépasser 250 caractères.

Pour la recherche d'un nom partiel de programme ou de procédure :

• Les signes inférieur à (<<<) sont tronqués lorsqu'ils sont indiqués seuls au début d'un nom de programme ou de procédure et que le reste de la chaîne de caractère est justifié à droite. Les caractères restants de la chaîne sont comparés au programme ou à la procédure en cours de la pile d'appels, en partant du dernier caractère du nom de programme ou de procédure.
• Les signes supérieur à (>>>) sont tronqués lorsqu'ils sont indiqués seuls à la fin d'un nom de programme ou de procédure. Les caractères restants de la chaîne sont comparés au programme ou à la procédure en cours de la pile d'appels, en partant du premier caractère du nom de programme ou de procédure.
• Les signes inférieur à (<<<) et supérieur à (>>>) sont tronqués lorsqu'ils sont utilisés ensemble pour un nom de programme ou de procédure. Les caractères restants sont utilisés pour analyser et comparer la longueur de la chaîne précisée avec le nom du programme ou de la procédure en cours dans la pile d'appels.

Elément 2 : Module

*NONE

Aucun qualificatif de module ILE n'est fourni.

nom

Indiquez le nom du module ILE à utiliser pour identifier la file d'attente de messages. Ce nom identifie le module dans lequel la procédure a été compilée.

Elément 3 : Programme

*NONE

Aucun qualificatif du programme n'est fourni.

nom

Indiquez le nom du programme à utiliser pour identifier la file d'attente de messages. Ce nom identifie le programme auquel la procédure a été liée.

File attente messages (MSGQ)

Indique la file d'attente de messages (non pas une file d'attente de messages de programme) d'où doit provenir un message.

Valeurs uniques

*PGMQ

Le message reçu ne peut provenir que de la file d'attente de messages de programme indiquée au paramètre File msg poste liste d'appel (PGMQ).

Qualificatif 1 : File attente messages

nom

Indiquez le nom de la file d'attente de messages d'où doit provenir le message. Si un nom de file d'attente de messages est indiqué, le paramètre File msg poste liste d'appel (PGMQ) ne peut pas précisé.

Qualificatif 2 : Biblio

*LIBL

La recherche porte sur toutes les bibliothèques de la liste des bibliothèques de l'unité d'exécution en cours jusqu'à ce que la première occurrence soit trouvée.

*CURLIB

La file d'attente de messages est recherchée dans la bibliothèque en cours du travail. Si cette dernière n'est pas précisée, QGPL est prise par défaut.

nom

Indiquez le nom de la bibliothèque contenant la file d'attente de messages.

Type de message (MSGTYPE)

Indique le type des messages reçus par ce programme.

*ANY

Tous les types de message, quels qu'ils soient, sont reçus (excepté la copie provenant de l'émetteur). Pour recevoir une copie, vous devez indiquer MSGTYPE(*COPY).

*NEXT

Le message reçu est celui qui suit le message indiqué au paramètre Clé du message (MSGKEY). En l'absence d'un autre message, des blancs sont renvoyés dans toutes les variables CL.

Lorsque le message reçu provient d'une file d'attente associée à un poste de liste d'appels, la valeur *NEXT ne s'applique qu'à ce poste de liste d'appels. Elle ne peut être utilisée pour plusieurs postes de liste d'appel du même programme.

*PRV

Le message reçu est celui qui précède le message indiqué au paramètre Clé du message (MSGKEY).

*INFO

Le message reçu est un message d'information.

*INQ

Le message reçu est un message d'interrogation.

*RPY

Le message reçu est un message de réponse. Le programme a envoyé un message d'interrogation à une file d'attente de messages et est en attente d'une réponse.

*FIRST

Le message reçu est le premier message de la file d'attente de messages ou de programme.

*COPY

Le message reçu par le programme est une copie d'un message d'interrogation envoyé précédemment. La file d'attente de messages indiquée au paramètre File msg poste liste d'appel (PGMQ) ou File attente messages (MSGQ) doit être la même que celle qui a été indiquée pour le paramètre File attente msg pour réponse (RPYMSGQ) lors de l'envoi du message INQ.

*COMP

Le message reçu est un message d'achèvement. Ce type de message ne peut provenir que d'une file d'attente de messages de programme. Il indique l'état du travail que ce programme a demandé à un autre programme.

*DIAG

Le message reçu est un message de diagnostic. Ce type de message ne peut provenir que d'une file d'attente de messages de programme. Il fournit des informations sur les erreurs qu'un autre programme a détectées dans l'entrée envoyée par le programme, ou bien les erreurs survenues alors que l'autre programme traitait la fonction demandée.

*EXCP

Le message reçu est un message d'exception. Les messages d'exception (arrêt programme, avertissement, état) sont reçus par le programme dans l'ordre "dernier entré, premier sorti". Le programme récepteur peut intercepter ces messages à l'aide de la commande MONMSG.

Remarque :Les messages autres que les messages d'exception sont reçus dans l'ordre "premier entré, premier sorti".

Si le message reçu est un message d'exception provenant d'une file d'attente de messages de procédure, le traitement de l'exception afférente ne peut pas être simultané à l'exécution de la commande RCVMSG. Le paramètre RMV peut être utilisé pour déterminer si l'exception doit être traitée à l'aide de la commande RCVMSG.

*RQS

Le message reçu est un message de demande. Ce type de message ne peut provenir que d'une file d'attente de messages de programme.

*LAST

Le message reçu est le dernier message de la file d'attente de messages ou de programme.

*NXTJLMSG

Renvoie le message de l'historique de travail après la clé spécifiée. Semblable à *PRVJLMSG, il peut obtenir un message qui réside dans une file d'attente de messages de programme actif ou de programme inactif (où le programme ou la procédure s'est terminé). Ce type est différent de *NEXT, qui renvoie uniquement un message d'une procédure ou d'un programme actif. Utilisez les valeurs par défaut du paramètre PGMQ et le message suivant dans l'historique de travail est renvoyé, quelle que soit la file d'attente de programme.

La valeur spéciale *TOP ou des zéros hexadécimaux (00000000) peuvent être spécifiés pour la clé de message afin de renvoyer le premier message de la file d'attente de messages du programme.

Remarque :Cette valeur est admise uniquement pour les files d'attente de messages du programme, et non pour les files d'attente de messages qui n'appartiennent pas au programme (QSYSOPR, par exemple).

*PRVJLMSG

Renvoie le message de l'historique de travail avant la clé spécifiée. Semblable à *NXTJLMSG, il peut obtenir un message qui réside dans une file d'attente de messages de programme actif ou de programme inactif (où le programme ou la procédure s'est terminé). Ce type est différent de *PRV, qui renvoie uniquement un message d'une procédure ou d'un programme actif. Utilisez les valeurs par défaut du paramètre PGMQ et le message précédent dans l'historique de travail est renvoyé, quelle que soit la file d'attente de programme.

Des zéros hexadécimaux (00000000) peuvent être spécifiés pour la clé de message afin de renvoyer le dernier message de la file d'attente de messages du programme.

Remarque :Cette valeur est admise uniquement pour les files d'attente de messages du programme, et non pour les files d'attente de messages qui n'appartiennent pas au programme (QSYSOPR, par exemple).

Clé du message (MSGKEY)

Indique la clé de référence du message reçu.

*NONE

Aucune clé de référence n'est indiquée.

*TOP

Utilisation du début de la file d'attente de messages. *TOP ne peut être utilisé que si *NEXT est indiqué au paramètre Type de message (MSGTYPE). Le message reçu est le premier de la file d'attente de messages. Pour les files d'attente de messages de programme, il s'agit du message suivant le dernier message de demande reçu, le cas échéant.

nom

Entrez le nom de la variable CL contenant la clé de référence du message que la fonction de réception doit utiliser. Cette clé est attribuée par le système et n'est pas visible lors de l'affichage des détails du message. Cette variable doit être une variable alphanumérique de 4 caractères.

Codage des relations : Les paramètres MSGTYPE et MSGKEY peuvent être utilisés séparément ou conjointement dans la commande RCVMSG (Recevoir un message).

• Si ni MSGTYPE, ni MSGKEY n'est spécifié, la valeur prise en compte est MSGTYPE(*ANY) et le premier nouveau message en file d'attente est reçu - autrement dit, les messages sont reçus dans l'ordre "premier entré, premier sorti".
• Si l'un des types de message indiqués dans le paramètre MSGTYPE est *COMP, *DIAG, *INFO, *INQ, *RPY, *COPY ou *RQS, tout nouveau message de ce type est reçu dans l'ordre "premier entré, premier sorti". Si le type *EXCP est indiqué, les nouveaux messages sont reçus dans l'ordre "dernier entré, premier sorti".
• Si seul MSGKEY est spécifié avec un nom de variable CL et si la file d'attente contient un message avec la clé de référence de message indiquée, ce message est reçu. Si le paramètre MSGKEY spécifié est destiné à un message en copie de l'expéditeur, la réponse à ce message est reçue dès lors qu'elle est disponible. Si cette réponse n'est pas disponible, des blancs sont renvoyés dans toutes les variables CL. Si un message est demandé par la clé et si ce message n'est pas disponible, un message d'arrêt programme est dirigé vers le programme demandeur.
• Si MSGTYPE(*COPY) et MSGKEY (&nom-variable-CL) sont spécifiés, la copie expéditeur d'un message d'interrogation est reçue.
• Si MSGTYPE et MSGKEY (&nom-variable-CL) sont spécifiés et si la file d'attente contient un message de ce type, ce message est reçu par le programme. Si la clé de référence est correcte mais pas le type de message, un message d'erreur est envoyé au programme.
• Si MSGTYPE(*NEXT) est spécifié, MSGKEY doit l'être également. Le message qui fait suite au message avec la clé de référence indiquée est reçu. Si MSGKEY(*TOP) est spécifié avec MSGTYPE(*NEXT), le premier message de la file d'attente est reçu. Pour les files d'attente de messages de poste de liste d'appels, c'est le premier message faisant suite au dernier message de demande qui est reçu.
• Si MSGTYPE(*PRV) est spécifié, MSGKEY doit l'être également. Le message qui précède le message avec la clé de référence indiquée est reçu.

Si MSGTYPE(*RPY) est spécifié avec une valeur MSGKEY faisant référence soit à une copie d'expéditeur, soit à un message d'interrogation, toute réponse à cette copie ou à ce message d'interrogation est renvoyée. En l'absence de réponse à la copie d'expéditeur ou au message d'interrogation, des blancs sont renvoyés. Lorsque la valeur MSGKEY fait référence à un message d'interrogation, le paramètre WAIT est ignoré (ce qui implique WAIT(0), c'est-à-dire la valeur par défaut pour le paramètre WAIT).

Si MSGTYPE(*ANY) est spécifié avec une variable KEYVAR et si le premier message trouvé est un message de réponse, la variable KEYVAR renvoie la clé de référence du message en copie de l'expéditeur. De la même façon, si MSGTYPE(*RPY) est spécifié avec une variable KEYVAR, la clé de référence du message en copie de l'expéditeur est renvoyée.

Temps d'attente (WAIT)

Indique, en secondes, le délai d'attente du programme lorsqu'un message du type indiqué n'est pas encore arrivé dans la file d'attente de messages et que cette commande a été lancée. Si le message n'arrive pas en temps voulu, les variables du langage de contrôle (CL) devant recevoir les zones du message sont remplies par des blancs (ou des zéros, s'il s'agit de variables décimales).

Le programme ne peut pas attendre un message en provenance d'une file d'attente de messages, à moins qu'il ne s'agisse d'une réponse.

Si un temps d'attente est indiqué (non nul), la file d'attente des messages est implicitement allouée au premier utilisateur dont le message est reçu, pour n'être libérée qu'une fois la demande gérée par le programme.

Si un message est envoyé à une file d'attente de messages du même travail, et que la fille d'attente de messages est en communication en mode interruption, ce paramètre est ignoré (ceci implique WAIT(0), qui est la valeur par défaut du paramètre WAIT).

Si la valeur indiquée pour MSGKEY désigne un message d'interrogation, et que MSGTYPE(*RPY) a été indiqué, le programme ignore le paramètre WAIT (valeur de l'attente : 0).

0

Aucun délai d'attente n'est prévu. Si un message du type indiqué ne se trouve pas dans la file d'attente lorsque cette commande est traitée, les variables CL spécifiées sont remplies avec des blancs (ou avec des zéros s'il s'agit de variables décimales).

*MAX

Le délai d'attente du programme est indéfini.

nombre-secondes

Indique le nombre de secondes pendant lequel le programme attend que le message arrive en file d'attente.

Suppression du message (RMV)

Indique si le message reçu par le programme doit être supprimé de la file d'attente de messages. Pour les messages constituant des exceptions non gérées, ce paramètre indique également si l'exception doit être gérée. Si *INQ est indiqué au paramètre Type de message (MSGTYPE), *NO doit également être indiqué pour ce paramètre pour qu'une réponse au message d'interrogation puisse être envoyée. A défaut, la réponse par défaut sera envoyée avant que l'interrogation restée sans réponse ne soit retirée.

*YES

Le message est enlevé de la file d'attente de messages. S'il concerne une exception non traitée, cette dernière est traitée à l'aide de la commande RCVMSG.

*NO

Le message n'est pas enlevé de la file d'attente de messages. Il y est maintenu en tant que message ancien. S'il concerne une exception non traitée, cette dernière est traitée à l'aide de la commande RCVMSG.

Remarque : Un message ancien est un message qui a été reçu mais non supprimé. Il peut être reçu à nouveau de l'une des manières suivantes :

1. Par l'indication de la clé de référence du message au paramètre MSGKEY.
2. Un type de message *FIRST, *LAST, *NEXT ou *PRV est indiqué au paramètre Type de message (MSGTYPE).

*KEEPEXCP

Lorsqu'il s'agit d'un message d'exception et que l'exception n'a pas encore été traitée, cette dernière demeure non traitée et le message est maintenu dans la file d'attente en tant que nouveau message. Vous pouvez le recevoir à nouveau à l'aide de la commande RCVMSG, en précisant le type de message *EXCP. Lorsqu'il ne s'agit pas d'un message d'exception, ou lorsqu'il s'agit bien d'un message d'exception mais que l'exception a déjà été traitée, le message est maintenu dans la file d'attente en tant que message ancien.

Pour traiter une exception après exécution de la commande RCVMSG, vous pouvez réutiliser cette commande en précisant RMV(*YES) ou RMV(*NO).

ID codé de jeu de caractères (CCSID)

Indique l'ID codé de jeu de caractères (CCSID) dans lequel vous souhaitez que le texte de message soit renvoyé. Ce CCSID s'applique uniquement au texte renvoyé aux paramètres MSG, SECLVL et MSGDTA. Lorsque des données de remplacement sont renvoyées au paramètre MSGDTA ou remplacées dans le texte renvoyé au paramètre MSG ou SECLVL, seule la partie du texte de remplacement qui est définie comme caractère convertible (*CCHAR) est convertie. Pour plus d'informations sur la zone *CCHAR, reportez-vous à la commande ADDMSGD.

*JOB

Avant d'être renvoyé, le message reçu est converti au CCSID du travail.

*HEX

Le message reçu n'est pas converti avant d'être renvoyé.

ID-codé-jeu-caractères

Indiquez le CCSID dans lequel vous souhaitez que le message soit converti avant d'être renvoyé. Les valeurs admises sont comprises entre 1 et 65535. La liste des valeurs de CCSID admises est fournie dans le manuel Internationalisation de l'iSeries Information Center, à l'adresse http://www.ibm.com/eserver/iseries/infocenter. Seuls sont acceptés les CCSID possibles pour le travail concerné.

Pour plus d'informations sur le gestionnaire des messages et la manière dont ce dernier utilise les CCSID, reportez-vous au manuel Rubriques Internationalisation de l'i5/OS dans l'IBM i Information Center, à l'adresse http://www.ibm.com/systems/i/infocenter/.

Rejet réponse par défaut (RJTDFTRPY)

Le retrait d'un message d'interrogation resté sans réponse provoque l'envoi d'une réponse par défaut au message d'interrogation. Cette valeur indique si un programme d'exit de gestion de réponse pourra rejeter une réponse par défaut envoyée par suite de l'utilisation de cette commande. Un programme d'exit de gestion des réponses peut être enregistré à l'aide de la fonction d'enregistrement système pour le point d'exit QIBM_QMH_REPLY_INQ. Ce paramètre ne s'applique que lorsque *YES est spécifié pour le paramètre RMV.

*NOALWRJT

Un programme d'exit de gestion de réponse ne pourra par rejeter une réponse par défaut.

*ALWRJT

Un programme d'exit de gestion de réponse pourra rejeter une réponse par défaut. Si un programme d'exit rejette la réponse, le message CPD2476 (Réponse rejetée par un programme d'exit de gestion de réponse) sera envoyé en tant que message de diagnostic au programme utilisant cette commande. Le CPD2476 sera suivi d'un message d'arrêt programme CPF2422 (Réponse incorrecte) que le programme utilisant cette commande doit intercepter pour gérer et récupérer suite à une situation d'erreur.

Variable pour KEYVAR (4) (KEYVAR)

Peut indiquer le nom de la variable CL alphanumérique contenant la clé de référence permettant d'identifier le message reçu par le programme contenant cette commande. Lors du traitement de la commande RCVMSG, le système renvoie une clé de référence à la variable indiquée par KEYVAR dans cette commande et modifie le message en ancien message. La clé de référence du message peut être utilisée dans le paramètre MSGKEY d'une commande RCVMSG ultérieure pour la réception de l'ancien message. Si le message n'est pas trouvé ou est en cours de retrait, des blancs sont renvoyés pour la variable KEYVAR. Pour les messages de type réponse, utilisez le paramètre MSGKEY pour cette commande, conjointement au paramètre KEYVAR pour la commande SNDPGMMSG. La clé de référence du message peut également être utilisée par ce programme pour construire des sous-fichiers de message. La variable CL est le nom de la zone pour laquelle le mot-clé SFLMSGKEY est indiqué dans le DDS pour le sous-fichier de messages.

Remarque :Pour les files d'attente de messages non associées à des postes de piles d'appel, les clés de référence de message peuvent être réutilisées une fois le message reçu et retiré (en spécifiant *YES au paramètre RMV).

Cette variable doit être une variable alphanumérique de 4 caractères.

Remarque :Lors de l'utilisation de la clé de référence de message (obtenue dans la variable CL indiquée par le paramètre KEYVAR de la commande SNDPGMMSG (Envoi de message de programme) pour recevoir la réponse à un message d'interrogation, notez que la clé de référence du messagge fait référence à la copie de l'expéditeur. Le message de copie de l'expéditeur est situé dans la file d'attente de message de réponse (qui est par défaut la file d'attente de messages de programme ayant envoyé le message d'interrogation) et non pas la file d'attente à laquelle a été envoyé le message d'interrogation.

Variable texte de 1er niveau (MSG)

Indique, le cas échéant, le nom de la variable de caractère du langage de contrôle (CL) contenant le message reçu par le programme. Ceci inclut les zones de données de message qui ont remplacé les variables de substitution du texte avant l'envoi du message (les réponses et les messages immédiats ne contiennent pas de zones de données de message). Cette zone n'a pas de longueur fixe, mais la plupart des messages ne dépassent pas 132 caractères. Lorsqu'un programme reçoit une réponse pour un message d'interrogation, ce paramètre contient le texte du message de réponse.

Variable pour MSGLEN (5 0) (MSGLEN)

Indique, le cas échéant, le nom de la variable CL décimale qui contient la longueur totale du message devant être reçu. Cette variable doit être une variable décimale comportant 5 positions.

Variable texte de 2e niveau (SECLVL)

Indique, le cas échéant, le nom de la variable de caractère du CL contenant l'aide message reçue par le programme. Ceci inclut les zones de données de message qui ont remplacé les variables de substitution du texte avant l'envoi du message (les réponses et les messages immédiats n'ont pas de messages de second niveau). Cette zone n'a pas de longueur fixe, mais la plupart des aides en ligne sur les messages ne dépassent pas 3000 caractères.

Variable pour SECLVLLEN (5 0) (SECLVLLEN)

Indique, le cas échéant, le nom de la variable CL décimale qui contient la longueur totale du texte de l'aide message. Cette variable doit être une variable décimale comportant 5 positions.

Variable pour données message (MSGDTA)

Indique, le cas échéant, le nom de la variable alphanumérique CL qui contient l'enregistrement des données du message. Cet enregistrement reçu par le programme en tant que partie du message, contient les valeurs de substitution (constituées par une seule chaîne de caractères) utilisées dans le message reçu. Le volume des données renvoyées et leur format dépendent du message. Les pointeurs contenus dans les messages du système sont invalidés.

Remarque :L'utilisation de données comprenant un pointeur invalidé peut entraîner l'envoi d'un message d'erreur.

Variable pour MSGDTALEN (5 0) (MSGDTALEN)

Indique, le cas échéant, le nom de la variable CL décimale qui contient la longueur totale de l'enregistrement des données du message. Cette variable doit être une variable décimale comportant 5 positions.

Variable pour MSGID (7) (MSGID)

Indique, le cas échéant, le nom de la variable CL alphanumérique qui contient l'identificateur du message reçu par le programme. Si le message reçu est un message immédiat, son identificateur est renvoyé sous forme de blancs. La longueur minimale de cette variable est de 7 caractères.

Variable pour SEV (2 0) (SEV)

Indique, le cas échéant, le nom de la variable CL décimale qui contient le code gravité du message reçu par le programme. Si le message reçu est un message immédiat, sa gravité n'est pas retournée. Cette variable doit comporter deux positions.

Variable pour SENDER (80) (SENDER)

Indique, le cas échéant, le nom de la variable CL alphanumérique qui contient l'identification de l'émetteur du message reçu via la commande RCVMSG. La longueur de la variable CL dépend de la valeur du paramètre SENDERFMT. Si SENDERFMT(*SHORT) est indiqué, la variable doit comporter au moins 80 caractères. Si la variable CL comporte plus de 80 caractères, des informations complémentaires sont retournées. Si SENDERFMT(*LONG) est indiqué, la variable doit comporter au moins 720 caractères.

Format d'émetteur (SENDERFMT)

Indique quel format de l'identification de l'émetteur est renvoyé. Ce paramètre est admis uniquement lorsque le paramètre SENDER est indiqué.

*SHORT

Les informations émetteur renvoyées sont au format court. Le format court comporte un minimum de 80 caractères. Si la variable CL est plus longue, des informations complémentaires sont retournées. Les positions de la variable CL situées au-delà de la dernière zone retournée seront remplies de blancs. Les informations renvoyées sont les suivantes :

• Les 26 premiers caractères identifient le travail émetteur
  • Nom du travail (10)
  • Nom de l'utilisateur (10)
  • Numéro du travail (6)
• Les 16 caractères suivants identifient le programme émetteur
  • Nom de programme (12) (pour une procédure ILE, il s'agit du nom du programme lié) ; Si l'émetteur est de type 3, les trois premiers caractères de cette zone sont <<< suivis des neuf derniers caractères du nom du programme.
  • Numéro de l'instruction (4) (pour une procédure ILE, cette zone est laissée à blanc)
• Les 13 caractères suivants composent la date et l'heure.
  • Date (7) (au format 0aammjj)
  • Heure (6) (au format hhmmss)
• Les 14 caractères suivants identifient le poste de liste d'appels récepteur si le message est envoyé à une file d'attente de messages de programme.
  • Nom du programme (10) (pour une procédure ILE, il s'agit du nom du programme lié)
  • Numéro de l'instruction (4) (pour une procédure ILE, cette zone est laissée à blanc)
• Le caractère suivant identifie le type de l'émetteur.
  • "0" si l'émetteur est un programme OPM ou un programme SLIC dont le nom comporte au maximum 12 caractères.
  • "1" si l'émetteur est une procédure ILE dont le nom comporte au maximum 256 caractères.
  • "2" si l'émetteur est une procédure ILE dont le nom comporte plus de 256 caractères.
  • "3" si l'émetteur est un programme SLIC dont le nom comporte plus de 12 caractères.
• Le caractère suivant identifie le type du récepteur.
  • "0" si le récepteur est un programme OPM.
  • "1" si le récepteur est une procédure ILE dont le nom comporte au maximum 256 caractères.
  • "2" si le récepteur est une procédure ILE dont le nom comporte plus de 256 caractères.
• Les 6 caractères suivants indiquent les microsecondes
• Les 10 derniers caractères composent le nom du profil utilisateur sous lequel s'exécutait l'unité d'exécution lors de l'envoi du message, nom qui est renvoyé si la longueur de la variable CL est d'au moins 87 caractères.

*LONG

Les informations émetteur renvoyées sont au format long. Ce format comporte 720 caractères, les 30 derniers étant à blanc. Les informations renvoyées sont les suivantes :

• Les 26 premiers caractères identifient le travail émetteur
  • Nom du travail (10)
  • Nom de l'utilisateur (10)
  • Numéro du travail (6)
• Les 13 caractères suivants composent la date et l'heure.
  • Date (7) (au format 0aammjj)
  • Heure (6) (au format hhmmss)
• Le caractère suivant identifie le type de l'émetteur.
  • "0" si l'émetteur est un programme OPM ou un programme SLIC dont le nom comporte au maximum 12 caractères.
  • "1" si l'émetteur est une procédure ILE dont le nom comporte au maximum 256 caractères.
  • "2" si l'émetteur est une procédure ILE dont le nom comporte plus de 256 caractères.
  • "3" si l'émetteur est un programme SLIC dont le nom comporte plus de 12 caractères.
• Le caractère suivant identifie le type du récepteur.
  • "0" si le récepteur est un programme OPM.
  • "1" si le récepteur est une procédure ILE dont le nom comporte au maximum 256 caractères.
  • "2" si le récepteur est une procédure ILE dont le nom comporte plus de 256 caractères.
• Les 12 caractères suivants correspondent au nom de programme de l'émetteur (pour une procédure ILE, il s'agit du nom du programme lié) ; si l'émetteur est de type 3 et que le nom du programme comporte plus de 12 caractères, les trois premiers caractères de cette zone sont <<< suivis des neuf derniers caractères du nom du programme.
• Les 10 caractères suivants composent le nom du module émetteur (si l'émetteur n'est pas une procédure ILE, cette zone est laissée à blanc).
• Les 256 caractères suivants composent le nom de la procédure émettrice (si l'émetteur n'est pas une procédure ILE, cette zone est laissée à blanc).
  • Pour un nom de procédure imbriqué, les éléments qui le composent sont séparés les uns des autres par un signe deux-points (:), le premier d'entre eux étant le nom de la procédure supérieure et le dernier le nom de la procédure inférieure.
  • Pour un nom de procédure comportant plus de 256 caractères, trois symboles <<< sont renvoyés, suivis des 253 derniers caractères du nom ; l'API QMHRCVPM peut être utilisée pour obtenir le nom complet de la procédure pour les messages d'une file d'attente de messages du programme.
• Le caractère suivant est un blanc.
• Les 4 caractères suivants composent le nombre de numéros d'instruction disponibles.

Remarque :Un numéro d'instruction représente un point du programme émetteur à partir duquel le message a été envoyé. Dans le cas des programmes et des procédures optimisées, le nombre est toujours 1. Pour les procédures optimisées, ce nombre peut être supérieur à 1, et chaque numéro d'instruction représente un point à partir duquel le message est susceptible d'avoir été envoyé. S'il est impossible de retourner des numéros d'instruction, ce nombre est égal à 0.

• Les 30 caractères suivants renvoient 3 numéros d'instruction au plus, comportant 10 caractères chacun.
• Les 320 caractères suivants renvoient des informations de programme ou de procédure si le message reçu a été initialement envoyé dans une file d'attente de messages associée à un poste de liste d'appels (dans le cas contraire, cette zone est laissée à blanc).
  • Nom du programme récepteur (10) (pour une procédure ILE, il s'agit du nom de programme lié)
  • Nom du module récepteur (10) (si l'émetteur n'est pas une procédure ILE, cette zone est laissée à blanc)
  • Nom de la procédure réceptrice (256) (si l'émetteur n'est pas une procédure ILE, cette zone est laissée à blanc)
    • Pour un nom de procédure imbriqué, les éléments qui le composent sont séparés les uns des autres par un signe deux-point (:), le premier d'entre eux étant le nom de la procédure supérieure et le dernier le nom de la procédure inférieure.
    • Pour un nom de procédure comportant plus de 256 caractères, trois symboles <<< sont renvoyés, suivis des 253 derniers caractères du nom ; l'API QMHRCVPM peut être utilisée pour obtenir le nom complet de la procédure pour les messages d'une file d'attente de messages du programme.
  • Blancs (10)
  • Nombre d'instructions disponibles pour le poste de liste d'appels récepteur (4)

    Remarque :Un numéro d'instruction représente un point auquel le programme récepteur a été interrompu (par exemple, du fait d'un appel) au moment où le message a été envoyé. Dans le cas des programmes et des procédures optimisées, le nombre est toujours 1. Pour les procédures optimisées, ce nombre peut être supérieur à 1, et chaque numéro d'instruction représente un point à partir duquel le message est susceptible d'avoir été envoyé. S'il est impossible de retourner des numéros d'instruction, ce nombre est égal à 0.

• Numéros d'instruction (30) (3 numéros d'instruction au plus, comportant 10 caractères chacun)
• Les 6 caractères suivants indiquent les microsecondes
• Le nom du profil utilisateur sous lequel s'exécutait l'unité d'exécution lors de l'envoi du message.

Variable pour RTNTYPE (2) (RTNTYPE)

Indique, le cas échéant, le nom de la variable CL qui contient le code type du message reçu par le programme. Cette variable alphanumérique doit comporter deux positions.

Le type de message est indiqué lors du renvoi des valeurs suivantes :

Valeur

Type de message

01

Achèvement

02

Diagnostic

04

Informations

05

Interrogation

06

Copie

08

Demande

10

Demande avec invite

14

Avertissement (exception déjà traitée au moment du lancement de la commande RCVMSG)

15

Arrêt programme (exception déjà traitée au moment du lancement de la commande RCVMSG)

16

Avertissement (exception non traitée au moment du lancement de la commande RCVMSG)

17

Arrêt programme (exception non traitée au moment du lancement de la commande RCVMSG)

21

Réponse, validité non vérifiée

22

Réponse, validité déjà vérifiée

23

Réponse, message par défaut utilisé

24

Réponse, utilisation de la valeur par défaut du système

25

Réponse à partir de la liste de réponse du système

26

Réponse, à partir du programme d'exit

Variable pour ALROPT (9) (ALROPT)

Indique, le cas échéant, le nom de la variable CL alphanumérique utilisée pour renvoyer l'option d'alerte du message reçu par le programme. Cette variable doit comporter neuf caractères.

Variable pour MSGF (10) (MSGF)

Indique, le cas échéant, le nom de la variable CL alphanumérique utilisée pour renvoyer le nom du fichier du message reçu par le programme. Si le message reçu est stocké dans un fichier, le nom de ce fichier message est renvoyé. Si le message reçu ne se trouve dans aucun fichier, le nom du fichier est remplacé par des blancs. Cette variable doit comporter dix caractères.

Remarque :Le nom du fichier message renvoyé dans ce paramètre correspond au fichier message indiqué ou pris par défaut dans la fonction d'envoi et non pas au fichier message de substitution. Si une substitution a été indiquée lors de l'envoi du message, elle doit également être utilisée lors de la réception du message.

Variable pour MSGFLIB (10) (MSGFLIB)

Indique, le cas échéant, le nom de la variable CL alphanumérique utilisée pour renvoyer le nom de la bibliothèque contenant le fichier du message reçu par le programme. Si le message reçu est stocké dans un fichier, le nom de la bibliothèque contenant ce fichier message est renvoyé. Si la valeur *LIBL a été indiquée dans la commande, cette valeur sera renvoyée. Si le message reçu ne se trouve pas dans un fichier, le nom de la bibliothèque est remplacé par des blancs. Cette variable doit comporter dix caractères.

Remarque :Le nom de bibliothèque de fichiers message retourné dans ce paramètre correspond au fichier message indiqué ou pris par défaut dans la fonction d'envoi et non pas à la bibliothèque de fichiers message de substitution. Si une substitution a été indiquée lors de l'envoi du message, elle doit également être utilisée lors de la réception du message.

Variable pour SNDMSGFLIB (10) (SNDMSGFLIB)

Indique, le cas échéant, le nom de la variable CL utilisée pour renvoyer le nom de la bibliothèque contenant le fichier message. Si le message reçu est stocké dans un fichier, le nom de la bibliothèque contenant ce fichier message est renvoyé. Si la valeur *LIBL a été indiquée dans la commande, le nom réel de la bibliothèque sera renvoyé. Si le message reçu ne se trouve pas dans un fichier, le nom de la bibliothèque est remplacé par des blancs. Si le message reçu est stocké dans un fichier et si le fichier message d'origine est supprimé, le nom de la bibliothèque de ce fichier qui est retourné est remplacé par des blancs. Si le message reçu ne se trouve dans aucun fichier, ce paramètre est retourné rempli de blancs. Cette variable doit comporter dix caractères.

Var pour CCSID texte (5 0) (TXTCCSID)

Indique, le cas échéant, le nom de la variable CL renvoyant l'ID codé de jeu de caractères (CCSID) associé au texte renvoyé par les paramètres MSG et SECLVL. En cas d'erreur de conversion ou si le CCSID dans lequel vous souhaitiez convertir le texte est 65535, le CCSID dans lequel la description de message ou le texte d'un message immédiat sont stockés est renvoyé. Sinon, le CCSID dans lequel vous souhaitiez convertir le texte est renvoyé. Si vous ne souhaitez pas convertir le texte avant qu'il vous soit renvoyé, mais si vous voulez connaître le CCSID dans lequel la description ou le texte du message immédiat est stockée, indiquez 65535 au paramètre CCSID, et le CCSID est renvoyé au paramètre TXTCCSID. Vous pouvez également rechercher une éventuelle erreur de conversion en comparant le CCSID que vous avez transmis avec le paramètre TXTCCSID renvoyé. S'ils ne sont pas identiques et sont différents de 65535, une erreur de conversion s'est produite. Cette variable doit être une variable décimale comportant 5 positions.

Var pour CCSID données (5 0) (DTACCSID)

Indique, le cas échéant, le nom de la variable CL renvoyant l'ID codé de jeu de caractères (CCSID) associé aux données de remplacement auxquelles la valeur *CCHAR a été attribuée. Les autres données de remplacement ne sont pas converties avant d'être renvoyées. En cas d'erreur de conversion ou si le CCSID dans lequel vous souhaitiez convertir le texte est 65535, le CCSID du message est renvoyé. En l'absence de données de remplacement *CCHAR, 65535 est renvoyé. Sinon, le CCSID dans lequel vous souhaitiez convertir le texte est renvoyé. Pour des messages immédiats, 0 est renvoyé. Vous pouvez rechercher une erreur de conversion en comparant le CCSID que vous avez transmis avec le paramètre DTACCSID renvoyé. S'ils ne sont pas identiques et sont différents de 65535, une erreur de conversion s'est produite. Cette variable doit être une variable décimale comportant 5 positions.

Exemples

Exemple 1 : Réception d'un message

RCVMSG   MSGQ(SMITH)  MSGKEY(&KEY)  MSG(&WORK)

Cette commande reçoit le message dont la clé de référence de message est indiquée par la variable de programme &KEY provenant de la file d'attente de messages SMITH. Le texte du message est copié dans la variable CL &WORK.

Exemple 2 : Réception d'un nouveau message

RCVMSG   MSGQ(INV)  WAIT(120)  MSG(&WORK)

Cette commande reçoit un nouveau message de la file d'attente de messages appelée INV dans la variable CL &WORK. Le programme n'attend pas plus de 120 secondes l'arrivée d'un nouveau message s'il n'y a pas de nouveaux messages dans la file d'attente. Si la file d'attente de messages comporte plus d'un nouveau message, le programme reçoit le premier.

Exemple 3 : Réception d'un message provenant d'une procédure

RCVMSG   PGMQ(*SAME CURRENT_MONTH_TOTALS)  MSGTYPE(*EXCP)
         RMV(*KEEPEXCP)  MSGID(&MID)  MSG(&MTEXT)

Cette commande reçoit un message d'exception de la procédure CURRENT_MONTH_TOTALS. Le nom indiqué comportant plus de 10 caractères, le système ne recherche aucun programme. Si le message est une exception non gérée, il est laissé dans la file d'attente de messages d'appel en tant que nouveau message et l'exception n'est pas gérée par la commande RCVMSG. L'ID du message est renvoyé dans la variable CL &MID et le texte du message dans la variable CL &MTEXT. Pour gérer l'exception et retirer le message, exécutez la commande RCVMSG suivante :

RCVMSG   PGMQ(*SAME CURRENT_MONTH_TOTALS)  MSGTYPE(*EXCP)
         RMV(*YES)

Exemple 4: Réception d'un message provenant d'un programme ou d'une procédure

RCVMSG   PGMQ(*SAME TARGETPGM)  MSGTYPE(*EXCP)  RMV(*NO)
         MSGID(&MID)  MSG(&MTEXT)

Cette commande reçoit un message d'exception de la file d'attente de messages ou de la procédure TARGETPGM. Le nom indiqué ne comportant que 9 caractères, le système recherche à la fois dans des programmes et des procédures. RMV(*NO) étant précisé, si le message est une exception non gérée, celle-ci est traitée par la commande RCVMSG. Le message est laissé dans la file d'attente de messages en tant qu'ancien message.

Exemple 5: Réception d'un message à l'aide de qualificateurs

RCVMSG   PGMQ(*SAME PRINT_RPT_FMT1 DEPTRPTS AREARPTS)
         MSGTYPE(*EXCP)  RMV(*YES)
         MSGID(&MID)  MSG(&MTEXT)

Cette commande reçoit un message d'exception de la file d'attente de messages de la procédure PRINT_RPT_FMT1. Cette procédure doit avoir été compilée dans le module DEPTRPTS et liée dans le programme de lien AREARPTS. RMV(*YES) étant précisé, l'exception est traitée si le message d'exception correspond à une exception non gérée. Le message est toujours retiré de la file d'attente de messages.

Exemple 6: Réception d'un message utilisant un nom de procédure partielle

RCVMSG   PGMQ(*SAME 'HANDLE_FORM_NUM>>>')  MSGID(&MID)
         MSG(&MTEXT)

Cette commande reçoit un nouveau message de la procédure la plus récente dont le nom commence par HANDLE_FORM_NUM.

Messages d'erreur

Messages *ESCAPE

CPF2401

Accès non autorisé à la bibliothèque &1.

CPF2403

File d'attente de messages &1 non trouvée dans &2.

CPF2407

fichier message &1 non trouvé dans &2.

CPF2408

Non autorisé à la file d'attente de messages &1.

CPF2411

Accès non autorisé au fichier message &1 dans &2.

CPF241C

La variable du paramètre SENDER est trop courte.

CPF2410

Clé du message non trouvée dans la file d'attente de messages &1.

CPF2415

Fin des demandes.

CPF2422

Réponse incorrecte.

CPF2423

La variable indiquée pour le paramètre SENDER comporte moins de &1 octets.

CPF2433

Fonction non admise pour file d'attente msg historique système &1.

CPF2449

Le message, qui devrait être une réponse, n'est pas une réponse. Message that should be a reply, is not a reply.

CPF2450

File d'attente de msg de poste de travail &1 non allouée à ce travail.

CPF2451

File d'attente de messages &1 allouée à un autre travail.

CPF247A

Entrée de pile d'appels introuvable. Call stack entry not found.

CPF247E

Le CCSID &1 est incorrect.

CPF2471

Longueur de zone incorrecte.

CPF2477

File d'attente de messages &1 en cours d'utilisation.

CPF2479

Entrée de pile d'appels introuvable. Call stack entry not found.

CPF2482

Type de message &1 incorrect.

CPF24A3

Valeur du paramètre de compteur de pile d'appels non valide. Value for call stack counter parameter not valid.

CPF24A8

Valeur du temps d'attente non valide. Value for wait time not valid.

CPF24B3

Type de message &1 non valide. Message type &1 not valid.

CPF2531

fichier message &1 de &2 endommagé pour &3.

CPF2532

File d'attente de msg du travail endommagée. Historique du travail arrêté.

CPF2548

fichier message &1 dans &2 endommagé.

CPF2551

Combinaison de clé et type de message incorrecte.

CPF36F7

La file d'attente de messages QSYSOPR est allouée à un autre travail. Message queue QSYSOPR is allocated to another job.

CPF8127

Dommage &8 sur file d'attente de messages &4 de &9. VLOG-&7.

CPF8176

File attente de messages pour description d'unité &4 endommagée.