RTVLIBD

La commande RTVLIBD (Extraire une description de bibliothèque) permet d'extraire la description d'une bibliothèque et les informations de journalisation concernant cette dernière. Les valeurs sont renvoyées (copiées) aux variables du programme.

Pour les paramètres qui sont renvoyés dans des variables CL par cette commande, le titre descriptif/texte d'invite des paramètres indique la longueur minimale de la variable CL. Pour les variables de type alphanumérique, un seul nombre s'affiche. Pour les variables décimales, deux numéros s'affichent. Le premier indique la longueur minimale de la variable et le second le nombre minimal de positions décimales.

La fonction de table QSYS2.LIBRARY_INFO renvoie des informations similaires.

Restrictions :

1. Vous devez disposer de droits autres que *EXCLUDE pour la bibliothèque afin d'extraire les attributs correspondants.
2. La valeur d'audit par défaut des objets créés dans la bibliothèque ne s'affiche que si vous disposez de droits spéciaux sur tous les objets (*ALLOBJ) ou de droits d'audit (*AUDIT). Si vous ne disposez pas d'au moins un de ces droits spéciaux, la valeur d'audit par défaut s'affiche comme étant non disponible (*NOTAVL).

Paramètres

Biblio (LIB)

Indique la bibliothèque dont les attributs doivent être extraits. Si une variable est indiquée, elle doit avoir une longueur de 10 caractères et contenir un nom de bibliothèque.

Ce paramètre est obligatoire.

nom

Indiquez le nom de la bibliothèque dont les attributs doivent être extraits.

Variable pour TYPE (10) (TYPE)

Indique la variable de 10 caractères destinée à recevoir le type de la bibliothèque. La valeur renvoyée est PROD ou TEST.

Variable pour ASP (2 0) (ASP)

Indique une variable décimale (2 0) utilisée pour renvoyer le numéro du pool de mémoire secondaire (ASP) utilisé par le système pour allouer de la mémoire à la bibliothèque. Les valeurs suivantes peuvent être renvoyées :

1

La bibliothèque se trouve dans le pool de mémoire secondaire système.

2-32

La bibliothèque se trouve dans le pool de mémoire secondaire utilisateur.

-1

La bibliothèque se trouve dans un ASP principal ou secondaire ayant un numéro supérieur à 32. Le nom de l'unité ASP principal ou secondaire peut être extrait à l'aide du paramètre ASPDEV.

Variable pour ASPDEV (10) (ASPDEV)

Indique une variable de 10 caractères utilisée pour récupérer le nom de l'unité ASP qui possède la mémoire allouée à la bibliothèque. L'une des valeurs spéciales suivantes peut être renvoyée :

*N

Le nom de l'unité ASP ne peut pas être identifié.

*SYSBAS

La bibliothèque se trouve dans l'ASP système (ASP 1) ou l'ASP utilisateur de base (ASP 2-32).

Variable CL pour ASPGRP (10) (ASPGRP)

Indique une variable de 10 caractères utilisée pour récupérer le nom du groupe d'ASP qui possède la mémoire allouée à la bibliothèque. Le nom de groupe d'ASP est le nom de l'ASP principal au sein du groupe d'ASP. L'une des valeurs spéciales suivantes peut être renvoyée :

*N

Le nom de l'unité ASP ne peut pas être identifié.

*SYSBAS

La bibliothèque se trouve dans l'ASP système (ASP 1) ou l'ASP utilisateur de base (ASP 2-32).

Variable pour CRTAUT (10) (CRTAUT)

Indique une variable de 10 caractères destinée à recevoir la valeur des droits pour les objets créés dans la bibliothèque. La valeur *SYSVAL, *CHANGE, *ALL, *USE ou *EXCLUDE, ou le nom d'une liste d'autorisation est renvoyée.

Variable pour CRTOBJAUD (10) (CRTOBJAUD)

Indique une variable de 10 caractères permettant de renvoyer la valeur d'audit de la bibliothèque. La valeur *NOTAVL est renvoyée si vous ne disposez pas du droit spécial *ALLOBJ ou *AUDIT. Les valeurs pouvant être renvoyées sont *SYSVAL, *NONE, *USRPRF, *CHANGE, *ALL et *NOTAVL. Pour plus d'informations, reportez-vous au paramètre Audit pour objets créés (CRTOBJAUD) de la commande CRTLIB (Créer une bibliothèque).

Variable pour JRNSTS (1) (JRNSTS)

Indique une variable de 1 caractère permettant de renvoyer l'état de journalisation en cours de la bibliothèque. La valeur renvoyée peut être l'une des suivantes :

'0'

La bibliothèque n'est pas en cours de journalisation.

'1'

La bibliothèque est en cours de journalisation.

D'autres zones associées à la journalisation peuvent comporter des données, même si la bibliothèque n'est pas en cours de journalisation. Pour plus d'informations sur le lancement de la journalisation d'une bibliothèque, reportez-vous à la commande (STRJRNLIB) .

Variable pour JRN (10) (JRN)

Indique une variable de 10 caractères permettant de renvoyer le nom du journal qui reçoit les modifications journalisées de la bibliothèque, si cette dernière est en cours de journalisation. Si la bibliothèque a été précédemment journalisée mais ne l'est pas actuellement, cette zone présente le nom du dernier journal dans lequel la bibliothèque a été journalisée. Cette zone est à blanc si la journalisation n'a jamais été lancée pour cette bibliothèque.

Variable pour JRNLIB (10) (JRNLIB)

Indique une variable de 10 caractères permettant de renvoyer le nom de la bibliothèque contenant le journal en cours ou le dernier journal qui reçoit les modifications journalisées de la bibliothèque, si cette dernière est en cours de journalisation. Si la bibliothèque a été précédemment journalisée mais ne l'est pas actuellement, cette zone présente le nom de la bibliothèque contenant le dernier journal dans lequel la bibliothèque a été journalisée. Cette zone est à blanc si la journalisation n'a jamais été lancée pour cette bibliothèque.

Variable pour JRNIMG (1) (JRNIMG)

Indique une variable de 1 caractère permettant de renvoyer les informations relatives aux images de journal. La valeur renvoyée peut être l'une des suivantes :

' '

Un blanc si la journalisation n'a jamais été lancée pour la bibliothèque.

'0'

Seules des images après sont consignées dans le journal pour les modifications apportées à la bibliothèque.

Variable pour JRNOMTE (1) (JRNOMTE)

Indique une variable de 1 caractère permettant de renvoyer les informations relatives aux postes de journal à omettre. La valeur renvoyée peut être l'une des suivantes :

' '

Un blanc si la journalisation n'a jamais été lancée pour la bibliothèque.

'0'

Aucun poste de journal n'est omis.

Les postes de journal ne peuvent pas être omis pour les bibliothèques.

Var CL pour INHERIT (1) (INHERIT)

Indique une variable à 1 caractère utilisée pour renvoyer des informations déterminant si les nouveaux objets admissibles au journal qui sont créés, déplacés ou restaurés dans la bibliothèque doivent hériter la journalisation de la bibliothèque selon les règles d'héritage de journal. Les règles d'héritage de journal peuvent être extraites à l'aide du paramètre INHRULES.

Remarque :Vous devez examiner les règles d'héritage de journal pour déterminer si elles sont substituées par l'existence d'une zone de données portant le nom QDFTJRN de la bibliothèque, indépendamment de la valeur de cette zone.

La valeur renvoyée peut être l'une des suivantes :

'0'

Les nouveaux objets admissibles au journal n'héritent pas la journalisation de la bibliothèque.

'1'

Les nouveaux objets admissibles au journal héritent la journalisation de la bibliothèque selon les règles d'héritage de journal.

Pour plus d'informations sur le lancement de la journalisation d'une bibliothèque, reportez-vous à la commande (STRJRNLIB) .

Variable pour JRNSTRDATE (13) (JRNSTRDATE)

Indique une variable de 13 caractères permettant de renvoyer la date et l'heure du dernier démarrage de la journalisation pour la bibliothèque. La valeur est renvoyée sous la forme SAAMMJJHHMMSS, où S = siècle ('0' désigne les années 19xx et '1' désigne les années 20xx), AA = année, MM = mois, JJ = jour, HH = heure, MM = minutes et SS = secondes. Cette zone est à blanc si la journalisation n'a jamais été lancée pour la bibliothèque.

Variable pour STRJRNRCV (10) (STRJRNRCV)

Indique une variable de 10 caractères permettant de renvoyer le nom du récepteur de journal le plus ancien requis pour utiliser la commande APYJRNCHG. Cette zone est à blanc si la bibliothèque n'a jamais été journalisée ou si elle n'a pas été sauvegardée et restaurée depuis le lancement de la journalisation.

Variable pour JRNRCVLIB (10) (JRNRCVLIB)

Indique une variable de 10 caractères permettant de renvoyer le nom de la bibliothèque contenant le récepteur de journal de début pour application. Cette zone est à blanc si la bibliothèque n'a jamais été journalisée ou si elle n'a pas été sauvegardée et restaurée depuis le lancement de la journalisation.

Variable pour RCVLIBASP (10) (RCVLIBASP)

Variable de 10 caractères permettant de renvoyer le nom de l'unité ASP qui possède la mémoire allouée à la bibliothèque contenant le récepteur de journal de début. Cette zone est à blanc si la bibliothèque n'a jamais été journalisée ou si elle n'a jamais été sauvegardée et restaurée depuis le lancement de la journalisation. Les valeurs spéciales suivantes peuvent être renvoyées :

*N

Le nom de l'unité ASP ne peut pas être identifié.

*SYSBAS

La bibliothèque se trouve dans l'ASP système (ASP 1) ou l'ASP utilisateur de base (ASP 2-32).

Variable pour RCVLIBGRP (10) (RCVLIBGRP)

Variable de 10 caractères permettant de renvoyer le nom du groupe d'ASP qui possède la mémoire allouée à la bibliothèque contenant le récepteur de journal de début. Le nom de groupe d'ASP est le nom de l'ASP principal au sein du groupe d'ASP. La valeur renvoyée peut être identique à celle renvoyée par la zone de nom d'unité ASP de la bibliothèque de récepteur de journal de début. Cette zone est à blanc si la bibliothèque n'a jamais été journalisée ou si elle n'a pas été sauvegardée et restaurée depuis le lancement de la journalisation. Les valeurs spéciales suivantes peuvent être renvoyées :

*N

Le nom de l'unité ASP ne peut pas être identifié.

*SYSBAS

La bibliothèque se trouve dans l'ASP système (ASP 1) ou l'ASP utilisateur de base (ASP 2-32).

Var CL pour INHRULES (1280) (INHRULES)

Indique une variable à 1280 caractères permettant de renvoyer les informations indiquées pour le mot clé INHRULES dans la commande STRJRNLIB ou CHGJRNOBJ si la journalisation n'a jamais été lancée pour cette bibliothèque. Si la journalisation n'a jamais été lancée pour cette bibliothèque, les règles d'héritage de journal par défaut sont renvoyées. Les règles d'héritage de journal spécifient quels objets admissibles au journal créés, déplacés ou restaurés dans la bibliothèque doivent hériter la journalisation de la bibliothèque. Ces règles n'affectent que les objets créés / restaurés dans la bibliothèque ou déplacés vers la bibliothèque. Si les objets inclus dans la bibliothèque sont rebaptisés, l'état et les attributs de journalisation de ces objets ne sont pas modifiés. Une fois les objets journalisés, leur journalisation n'est pas automatiquement interrompue lorsqu'ils sont extraits de la bibliothèque. Par ailleurs, pour les objets journalisés avant déplacement vers la bibliothèque, ce déplacement ne modifie pas l'état ou les attributs de journalisation.

Les règles d'héritage de journal s'appliquent à la fois lorsque :

• d'une part la valeur renvoyée pour le paramètre INHERIT est un '1', et
• d'autre part la zone de règles d'héritage substituées (rulesOverridden) dans les règles d'héritage de journal ci-dessous est un '0'.

Chaque règle définit les types d'objet, les noms d'objet et les opérations qui vont déterminer les objets auxquels la règle s'applique. Il est possible de définir plusieurs règles pour un même ensemble d'objets. Lorsque plusieurs règles sont appliquées à un même objet, la dernière règle définie pour cet objet est appliquée.

Les zones sont renvoyées dans l'ordre indiqué ci-dessous. A noter que certains champs sont accessibles uniquement par le biais d'une zone de décalage ou de déplacement.

1. Version : zone au format entier non signé sur 4 octets indiquant la version de la structure. La valeur renvoyée peut être l'une des suivantes :

   1

   Il s'agit de la première version de la structure.

   2

   Il s'agit de la seconde version de la structure.

2. dispEntry : zone au format entier non signé sur 4 octets contenant le décalage du premier poste de règle d'héritage de journal à partir du début des informations sur les règles d'héritage de journal.
3. lengthRules : zone au format entier non signé sur 4 octets contenant la longueur totale de toutes les informations sur les règles d'héritage de journal.
4. numRules : zone au format entier non signé sur 4 octets contenant le nombre de postes de règle d'héritage de journal.
5. rulesOverridden : zone de 1 caractère indiquant si les règles d'héritage de journal de la bibliothèque doivent être substituées par une zone de données QDFTJRN qui existe dans la bibliothèque. Par conséquent, les informations contenues dans la zone de données QDFTJRN prévalent sur les règles d'héritage de journal renvoyées pour la bibliothèque. La valeur renvoyée peut être l'une des suivantes :

   '0'

   La zone de données QDFTJRN ne supplante pas les règles d'héritage de journal de la bibliothèque.

   '1'

   La zone de données QDFTJRN supplante les règles d'héritage de journal de la bibliothèque.

6. Zone réservée de 3 caractères contenant des zéros hexadécimaux.
7. Inherit_Rules_Entry : répétitions de la structure suivante pour le nombre de postes de règles d'héritage de journal. Le déplacement dans la première règle d'héritage de journal est renvoyé dans la zone dispEntry suivante.
   1. nextEntryDisp : zone au format entier non signé sur 4 octets contenant le déplacement vers le poste de règle d'héritage de journal à partir du début de ce poste.
   2. La présentation de la / des zones suivantes dépend de la valeur renvoyée dans le champ Version, à savoir :

      1

      Zone réservée de 20 caractères contenant des zéros hexadécimaux.

      2

      Les zones suivantes sont renvoyées :

      1. namFltr : zone de 10 caractères indiquant le filtre de nom pour les objets auxquels la règle s'applique si les autres critères spécifiés pour cette règle sont satisfaits. La valeur renvoyée peut être l'une des suivantes :

         *ALL

         Dès lors que les autres critères spécifiés pour la règle sont satisfaits, cette règle s'applique à tous les objets du type indiqué, quel que soit le nom de l'objet.

         nom

         Dès lors que les autres critères spécifiés pour la règle sont satisfaits, cette règle s'applique à tous les objets dont le nom correspond exactement au nom indiqué.

         nom-générique

         Dès lors que les autres critères spécifiés pour la règle sont satisfaits, cette règle s'applique à tous les objets dont le nom correspond au nom générique indiqué. Un nom générique est une chaîne de caractères comportant un ou plusieurs caractères (préfixe) suivis d'un astérisque (*). Un nom d'objet correspond donc au nom générique s'il a le même préfixe que ce nom générique.

      2. Zone réservée de 10 caractères contenant des zéros hexadécimaux.

   3. objectType : zone de 10 caractères indiquant le type d'objet admissible au journal auquel s'applique la règle. La valeur renvoyée peut être l'une des suivantes :

      *ALL

      Tous les types d'objet pour lesquels la journalisation est prise en charge.

      *DTAARA

      Zones de données

      *DTAQ

      Files d'attente de données

      *FILE

      Des fichiers base de données

   4. Operation : zone de 1 caractère indiquant si les opérations sur le type d'objet pour lequel les attributs de journalisation doivent être hérités de la bibliothèque. La valeur renvoyée peut être l'une des suivantes :

      '0'

      La journalisation est héritée pour les types d'objet indiqués qui sont créés, ('1'), déplacés ('2') ou restaurés ('3') dans cette bibliothèque. Pour plus d'informations, reportez-vous aux descriptions de chacune des opérations ci-dessous. Notez que l'opération '0' contient les opérations '1', '2' et '3' mais pas l'opération '4'.

      '1'

      La journalisation est héritée pour les types d'objet indiqués qui sont créés dans cette bibliothèque si les autres critères définis pour cette règle sont remplis.

      '2'

      La journalisation est héritée pour les types d'objet indiqués qui sont déplacés dans cette bibliothèque si l'objet n'est pas déjà journalisé et si les autres critères définis pour cette règle sont remplis.

      '3'

      La journalisation est héritée pour les types d'objet indiqués qui sont restaurés dans cette bibliothèque si les autres critères définis pour cette règle sont remplis, sauf si l'objet existe dans la bibliothèque ou s'il a été journalisé au moment de sa sauvegarde. Si l'objet existe dans la bibliothèque, ses attributs de journalisation ne sont pas modifiés. Si l'objet a été journalisé au moment de sa sauvegarde, il conserve dans la mesure du possible ses attributs de journalisation. Si ce n'est pas possible, (par exemple, le journal créé pendant la sauvegarde est introuvable), l'objet restauré hérite la journalisation de la bibliothèque.

      '4'

      La journalisation est héritée pour les types d'objet indiqués qui sont restaurés dans cette bibliothèque si les autres critères définis pour cette règle sont remplis et indépendamment des attributs de journalisation qu'avait l'objet au moment de sa sauvegarde, sauf si l'objet existe dans la bibliothèque. Si l'objet existe dans la bibliothèque, ses attributs de journalisation ne sont pas modifiés.

   5. ruleAction : zone de 1 caractère indiquant si les objets correspondant au type d'objet, au nom d'objet et à l'opération couverts par la règle doivent ou non être inclus dans la liste des objets qui héritent la journalisation de la bibliothèque. La valeur renvoyée peut être l'une des suivantes :

      '0'

      Tous les objets correspondant au type d'objet, au nom d'objet et à l'opération couverts par la règle sont inclus dans la liste des objets qui héritent la journalisation de la bibliothèque selon les règles d'héritage de journal.

      '1'

      Tous les objets correspondant au type d'objet, au nom d'objet et à l'opération couverts par la règle sont omis de la liste des objets qui héritent la journalisation de la bibliothèque.

   6. Images : zone de 1 caractère indiquant les types des images consignées dans le récepteur de journal pour les modifications des objets qui héritent la journalisation de la bibliothèque du fait de la règle. La valeur renvoyée peut être l'une des suivantes :

      '0'

      La valeur par défaut pour chaque type d'objet est utilisée pour cet attribut de journalisation lorsqu'un objet hérite la journalisation de la bibliothèque. Les fichiers base de données (*FILE) contiennent à la fois des images avant et après générées par le système ('2). Les zones de données (*DTAARA) et les files d'attente de données (*DTAQ) ne contiennent que des images après générées par le système ('1).

      '1'

      Seules des images après sont journalisées pour un objet qui hérite la journalisation de la bibliothèque.

      '2'

      Des images avant et après sont toutes les deux journalisées pour un objet qui hérite la journalisation de la bibliothèque. La valeur '2' est valide uniquement pour les zones de données (*DTAARA) et les fichiers base de données (*FILE). Si '2 est indiqué et que *ALL est indiqué pour le type d'objet, le système génère des images avant et après pour les zones de données et les fichiers base de données, et des images après seulement pour les files d'attente de données (*DTAQ).

   7. OmtJrnE : zone de 1 caractère indiquant les postes de journal à omettre (non consignés dans le récepteur de journal) pour les modifications des objets qui héritent la journalisation de la bibliothèque du fait de la règle. La valeur renvoyée peut être l'une des suivantes :

      '0'

      La valeur par défaut pour chaque type d'objet est utilisée pour cet attribut de journalisation lorsqu'un objet hérite la journalisation de la bibliothèque du fait de cette règle. Aucun poste de journal ('1') n'est omis pour les zones de données (*DTAARA) et les files d'attente de données (*DTAQ). Les postes d'ouverture et de fermeture de journal ('2') sont omis pour les fichiers base de données (*FILE).

      '1'

      Aucun poste de journal n'est omis pour les objets qui héritent la journalisation de la bibliothèque du fait de cette règle.

      '2'

      Les postes d'ouverture et de fermeture de journal ne sont pas consignés pour les fichiers base de données (*FILE) qui héritent la journalisation de la bibliothèque du fait de cette règle. La spécification du paramètre '2' empêche l'utilisation des postes TOJOBO et TOJOBC dans les commandes APYJRNCHG (Appliquer les modifications journalisées) et RMVJRNCHG (Supprimer les modifications journalisées) mais elle économise de l'espace mémoire dans les récepteurs de journal. La valeur '2' est valide uniquement pour les fichiers base de données (*FILE). Si le paramètre '2 est indiqué et que *ALL est indiqué pour le type d'objet, les fichiers base de données omettent les postes d'ouverture et de fermeture de journal, alors que les zones de données (*DTAARA) et les files d'attente de données (*DTAQ) n'en omettent aucun.

   8. La présentation des zones suivantes dépend de la valeur renvoyée dans le champ Version, à savoir :

      1

      Zone réservée de 2 caractères contenant des zéros hexadécimaux.

      2

      Les zones suivantes sont renvoyées :

      1. rmtJrnFtr : zone de 1 caractère indiquant la valeur de filtre de journal éloigné pour les objets auxquels la règle s'applique. La valeur renvoyée peut être l'une des suivantes :

         '0'

         La valeur par défaut pour chaque type d'objet est prise en compte pour l'attribut de journalisation lorsqu'un objet hérite la journalisation de la bibliothèque. Pour tous les types d'objet, les postes de journal consignés pour les objets qui héritent la journalisation de la bibliothèque ne sont pas admissibles pour un filtrage par objet du journal éloigné.

         '1'

         Les postes de journal consignés pour les objets qui héritent la journalisation de la bibliothèque du fait de la règle ne sont pas admissibles pour un filtrage par objet du journal éloigné.

         '2'

         Les postes de journal consignés pour les objets qui héritent la journalisation de la bibliothèque du fait de la règle sont admissibles pour un filtrage par objet du journal éloigné.

         Lors d'un filtrage par objet du journal éloigné, les postes du journal pour l'objet ne sont pas envoyés au système cible.

         Pour plus de détails concernant le filtrage d'un journal éloigné, reportez-vous à la commande CHGRMTJRN (Modifier un journal éloigné) ou à l'API QjoChangeJournalState (Modification d'état de journal).

      2. Zone réservée de 1 caractère contenant des zéros hexadécimaux.

Variable pour TEXT (50) (TEXT)

Indique une variable CL de 50 caractères permettant de renvoyer le texte descriptif de la bibliothèque.

Exemples

On part du principe que la bibliothèque TESTLIB a été créée de la manière suivante :

CRTLIB LIB(TESTLIB) CRTAUT(*ALL) TEXT('Bibliothèque de Jean Dupont')

On part également du principe que la journalisation a été lancée pour la bibliothèque nommée TESTLIB à l'aide de la commande STRJRNLIB :

STRJRNLIB LIB(TESTLIB) JRN(TESTLIB/LIBJRN)

Exemple de PGM

DCL   VAR(&CRTAUT)  TYPE(*CHAR)  LEN(10)
DCL   VAR(&JRNSTS)  TYPE(*CHAR)  LEN(1)
DCL   VAR(&JRN)     TYPE(*CHAR)  LEN(10)
DCL   VAR(&JRNLIB)  TYPE(*CHAR)  LEN(10)
RTVLIBD   LIB(TESTLIB)  CRTAUT(&CRTAUT) JRNSTS(&JRNSTS)
          JRN(&JRN) JRNLIB(&JRNLIB)

La commande RTVLIBD renvoie :

• une valeur de '*ALL ' dans la variable de programme &CRTAUT,
• une valeur de '1 ' dans la variable de programme &JRNSTS,
• une valeur de 'LIBJRN ' dans la variable de programme &JRN et
• une valeur de 'TESTLIB ' dans la variable de programme &JRNLIB.

Messages d'erreur

Messages *ESCAPE

CPF21AD

La taille du paramètre INHRULES est trop petite.

CPF210E

Bibliothèque &1 non disponible pour le code raison &2.

CPF2115

Objet &1 de &2 type *&3 endommagé.

CPF2150

Erreur dans la fonction d'informations sur objet.

CPF2151

Erreur de l'opération sur &2 de &1 type *&3.

CPF980B

Objet &1 de bibliothèque &2 indisponible.

CPF9810

Bibliothèque &1 non trouvée.

CPF9820

Non autorisé à utiliser la bibliothèque &1.

CPF9830

Allocation de la bibliothèque &1 impossible.