RTVCLNUP

La commande RTVCLNUP (Extraire le ménage) permet d'extraire une valeur d'opération de ménage en vue de son utilisation dans un programme CL ou REXX. Cette valeur sera renvoyée (copiée) dans la variable CL précisée dans le programme.

Paramètres

Variable pour ALWCLNUP (4) (ALWCLNUP)

Indique le nom de la variable CL (4 caractères au moins) qui reçoit la valeur autorisant ou non l'opération de ménage. *YES est renvoyé si l'opération de ménage est autorisée, *NO dans le cas contraire.

Variable pour STRTIME (10) (STRTIME)

Indique le nom de la variable CL (10 caractères au moins) qui reçoit l'heure de début du ménage quotidien. La variable doit comporter au minimum 10 caractères. Une valeur spéciale "*NONE" ou "*SCDPWROFF", ou l'heure de début est renvoyée.

Variable pour USRMSG (5) (USRMSG)

Indique le nom de la variable CL (5 caractères au moins) qui reçoit la valeur contrôlant les opérations de ménage dans les files d'attente de messages du profil utilisateur. La variable doit comporter au minimum 5 caractères. La valeur spéciale *KEEP ou la durée de conservation (en nombre de jours) des messages utilisateur est renvoyée.

Variable pour SYSMSG (5) (SYSMSG)

Indique le nom de la variable CL qui reçoit la valeur contrôlant les opérations de ménage dans la file d'attente QSYSOPR et dans les files d'attente des postes de travail. La variable doit comporter au minimum 5 caractères. La valeur spéciale *KEEP ou la durée de conservation en jours des messages système est renvoyée.

Var CL pour CRITSYSMSG (5) (CRITSYSMSG)

Indique le nom de la variable CL utilisée pour la valeur d'option de ménage des messages de la file d'attente de messages QSYSMSG. La variable doit comporter au minimum 5 caractères. La valeur spéciale *KEEP ou la durée de conservation en jours des messages système critiques est renvoyée.

Variable pour SYSPRT (5) (SYSPRT)

Indique le nom de la variable CL qui reçoit la valeur contrôlant les opérations de ménage visant les historiques de travaux et autres sorties du système. La variable doit comporter au minimum 5 caractères. La valeur spéciale *KEEP ou la durée de conservation (en nombre de jours) des historiques des travaux est renvoyée.

Variable pour SYSLOG (5) (SYSLOG)

Indique le nom de la variable CL qui reçoit la valeur contrôlant les opérations de ménage visant les journaux du système, les fichiers historique, les historiques des incidents, la base de données d'alertes du système et les PTF. La variable doit comporter au minimum 5 caractères. La valeur spéciale *KEEP ou la durée de conservation (en nombre de jours) des journaux et historiques du système est renvoyée.

Variable pour nom JOBQ (10) (JOBQ)

Indique le nom de la variable CL qui reçoit le nom de la file d'attente de travaux à laquelle les travaux de ménage par lots sont soumis. La variable doit comporter au minimum 10 caractères. Le nom de la file d'attente de travaux dans laquelle sont placés les travaux de ménage par lots est renvoyé.

Variable pour biblio JOBQ (10) (JOBQLIB)

Indique le nom de la variable CL qui reçoit le nom de la bibliothèque de la file d'attente de travaux à laquelle les travaux de ménage par lots sont soumis. La variable doit comporter au minimum 10 caractères.

Variable pour RUNPTY (2 0) (RUNPTY)

Indique le nom de la variable CL qui contient la valeur à deux chiffres, comprise entre 01 et 99, représentant la priorité d'exécution (ou de traitement) des phases d'activation qui font partie du travail. Pour plus d'informations concernant la priorité d'exécution, reportez-vous à la description de ce paramètre dans la commande CHGJOB (Modifier un travail). Cette variable doit être une variable à deux chiffres sans décimales.

Variable pour JRNRCVSIZ (10 0) (JRNRCVSIZ)

Indique le nom de la variable CL qui reçoit la valeur comprise entre 1 et 1.000.000.000 (ko), représentant la taille du récepteur de journal. Lorsque la taille de l'espace réservé au récepteur de journal est supérieure à la taille spécifiée par cette valeur, la fonction d'apurement automatique de l'Assistant le détache. La variable doit être une valeur à dix chiffres sans décimale.

Variable pour CALITM (5) (CALITM)

En V5R1 et éditions plus récentes, ce paramètre n'est pas pris en charge.

Exemples

Exemple 1 : extraction du nombre de jours de conservation des messages

DCL   VAR(&UMSGDAYS)  TYPE(*CHAR)  LEN(5)
RTVCLNUP   USRMSG(&UMSGDAYS)

Ces commandes extraient le nombre de jours pendant lesquels les messages utilisateur sont conservés avant leur suppression.

Exemple 2 : extraction de l'heure de début du ménage quotidien

DCL   VAR(&CLNUPTIME)  TYPE(CHAR)  LEN(10)
RTVCLNUP   STRTIME(&CLNUPTIME)

Ces commandes permettent d'extraire l'heure de démarrage de l'opération de ménage.

Exemple 3 : extraction de la priorité d'exécution

DCL   VAR(&RPTY)  TYPE(*DEC)  LEN(2 0)
RTVCLNUP  RUNPTY(&RPTY)

Cette commande permet d'extraire la priorité d'exécution pour le travail de ménage. Le nombre de la priorité d'exécution est copié dans la variable CL &RPTY. La variable doit être une variable à 2 chiffres sans décimales.

Exemple 4 : extraction de la taille du récepteur de journal

DCL   VAR(&JRNSIZ) TYPE(*DEC)  LEN(10 0)
RTVCLNUP  JRNRCVSIZ(&JRNSIZ)

Cette commande extrait la taille du récepteur de journal pour le travail de ménage. Celle-ci est copiée dans la variable CL &JRNSIZ. Ce doit être une variable décimale à 10 chiffres, sans décimale.

Messages d'erreur

Messages *ESCAPE

CPF1E2B

Options de mise sous/hors tension et de ménage non trouvées.

CPF1E33

Options de ménage ou planning mise HT/ST utilisé par autre utilisateur.

CPF1E99

Erreur non prévue.