RTVDLONAM
Extraire nom doc ou dossier
En bref
La commande RTVDLONAM (Extraire un nom de document ou de dossier) permet d'extraire le nom secondaire d'un document, document de distribution, ou dossier classé pour insérer cette valeur dans les variables spécifiées.
RTVDLONAM se lit RTV
(Extraire (récupérer)) + DLONAM.
Sur IBM i, le nom d'une commande associe presque toujours un verbe et un objet.
Syntaxe minimale
RTVDLONAM DLO(…)
Paramètres
-
DLODocument ou dossier obligatoire -
FLRDossier -
DOCIDIdentificateur du document -
LADNTSPHorodatage LADN -
SYSOBJNAMNom d'objet système -
OBJCLSClasse d'objet -
RTNDLOVariable pour RTNDLO (12) -
RTNFLRVariable pour RTNFLR (63) -
RTNDOCIDVariable pour RTNDOCID (24) -
RTNLADNTSPVariable pour RTNLADNTSP (16) -
RTNOBJNAMVariable pour RTNOBJNAM (10) -
RTNOBJCLSVariable pour RTNOBJCLS (8) -
RTNASPVariable pour RTNASP (2 0) -
RTNOVRFLWVariable pour RTNOVRFLW (1)
Astuce : dans une session 5250, tapez RTVDLONAM puis F4 pour
l'invite de saisie, et F1 sur un paramètre pour son aide.
Aide IBM i de la commande
Texte du F1, IBM i 7.5 en français
(bibliothèque QSYS)
Où s'exécute : Compiled CL program or interpreted REXX (*BPGM *IPGM *BREXX *IREXX)
Compatible multitâche : Non
La commande RTVDLONAM (Extraire un nom de document ou de dossier) permet d'extraire le nom secondaire d'un document, document de distribution, ou dossier classé pour insérer cette valeur dans les variables spécifiées. Cette commande n'est admise que dans un programme CL ou un exec REXX.
Restrictions :
- Pour récupérer les différents formats du nom, vous devez disposer du droit *USE (utilisation) sur le document ou le dossier classé.
- Pour récupérer les différents formats du nom du document de distribution, vous devez disposer du droit spécial *ALLOBJ (tous les objets).
Paramètres
| Mot-clé | Description | Valeurs possibles | Remarques |
|---|---|---|---|
| DLO | Document ou dossier | Valeur caractère, *DOCID, *LADNTSP, *SYSOBJNAM | Obligatoire, positionnel 1 |
| FLR | Dossier | Valeur caractère, *NONE | Facultatif, positionnel 2 |
| DOCID | Identificateur du document | Valeur caractère, *NONE | Facultatif |
| LADNTSP | Horodatage LADN | 0000000000000001-FFFFFFFFFFFFFFFF, *NONE | Facultatif |
| SYSOBJNAM | Nom d'objet système | Nom, *NONE | Facultatif |
| OBJCLS | Classe d'objet | *DOC, *FLR, *DST | Facultatif |
| RTNDLO | Variable pour RTNDLO (12) | Valeur caractère | Facultatif |
| RTNFLR | Variable pour RTNFLR (63) | Valeur caractère | Facultatif |
| RTNDOCID | Variable pour RTNDOCID (24) | Valeur caractère | Facultatif |
| RTNLADNTSP | Variable pour RTNLADNTSP (16) | Valeur caractère | Facultatif |
| RTNOBJNAM | Variable pour RTNOBJNAM (10) | Valeur caractère | Facultatif |
| RTNOBJCLS | Variable pour RTNOBJCLS (8) | Valeur caractère | Facultatif |
| RTNASP | Variable pour RTNASP (2 0) | Nombre décimal | Facultatif |
| RTNOVRFLW | Variable pour RTNOVRFLW (1) | Valeur caractère | Facultatif |
Document ou dossier (DLO)
Indique le document ou dossier pour lequel un nom doit être extrait.
Ce paramètre est obligatoire.
- *DOCID
- Le document ou dossier est identifié par son LADN (nom de document attribué par la bibliothèque) précisé au paramètre DOCID. Le paramètre Dossier (FLR) doit avoir pour valeur *NONE.
- *LADNTSP
- Le document ou dossier est identifié par son horodatage LADN (nom de document attribué par la bibliothèque) indiqué au paramètre LADNSTP. Le paramètre FLR doit être *NONE.
- *SYSOBJNAM
- Le document ou dossier est identifié par le nom d'objet système indiqué au paramètre SYSOBJNAM. Le paramètre FLR doit être *NONE.
- nom
- Indiquez le nom attribué par l'utilisateur au document ou au dossier. Le dossier qui contient ce document ou ce dossier est précisé dans le paramètre FLR.
Ce paramètre est obligatoire.
Dossier (FLR)
Indique le chemin du dossier qui contient le document ou le dossier désigné dans le paramètre Document ou dossier (DLO). Le paramètre FLR doit être *NONE lorsque le paramètre DLO est *DOCID, *LADNTSP, ou *SYSOBJNAM.
- *NONE
- Le document ou dossier n'appartient à aucun dossier, ou est identifié par le paramètre DOCID, LADNTSP, ou SYSOBJNAM.
- nom
- Indique le nom du dossier qui contient le document ou le dossier désigné dans le paramètre DLO.
Identificateur du document (DOCID)
Indique le nom attribué au document par la bibliothèque. Il s'agit en fait du nom que le système a attribué au document lors de la création de ce dernier. Les documents classés hors du système local ont exclusivement ce type de nom. Les noms de documents attribués par la bibliothèque peuvent être déterminés à l'aide de la commande QRYDOCLIB (Interroger une bibliothèque de documents) ou à l'aide du message renvoyé par la commande FILDOC (Classer un document).
Les noms de documents attribués par la bibliothèque ont une longueur de 24 caractères, et doivent se conformer au format suivant :
AAAAMMJJHHMNSSCSNSNSNSNS
dans lequel :
AAAA = année
MM = mois
JJ = jour
HH = heures
MN = minutes
SS = secondes
CS = centièmes de seconde
NSNSNSNS = nom système
- *NONE
- Aucun LADN n'est indiqué pour cet objet.
- nom
- Indique le nom attribué par la bibliothèque à l'objet du document ou dossier. Le LADN peut être défini à l'aide de la commande QRYDOCLIB (Interroger une bibliothèque de documents) ou du message renvoyé pour la commande FILDOC (Classer un document) ou une autre commande.
Horodatage LADN (LADNTSP)
Indique l'horodatage LADN du document ou du dossier. L'horodatage LADN est spécifié uniquement lorsque la valeur *LADNTSP est indiquée dans le paramètre Document ou dossier (DLO).
- *NONE
- Aucun horodatage LADN n'est indiqué pour cet objet.
- horodatage
- Indique l'horodatage LADN de la bibliothèque de documents.
Nom d'objet système (SYSOBJNAM)
Indique le nom d'objet système du document ou du dossier. Le nom d'objet système est spécifié uniquement lorsque la valeur *SYSOBJNAM est indiquée dans le paramètre Document ou dossier (DLO).
- *NONE
- Aucun nom d'objet système n'est indiqué pour cet objet.
- nom
- Indique le nom d'objet système de la bibliothèque de documents.
Classe d'objet (OBJCLS)
Indique la classe de l'objet à rechercher.
- *DOC
- Le document ou dossier indiqué est un document classé.
- *FLR
- Le document ou dossier indiqué est un dossier.
- *DST
- Le document ou dossier est un document de distribution.
Variable pour RTNDLO (12) (RTNDLO)
Indique le nom d'une variable CL de 12 caractères utilisée pour recevoir le nom du document ou dossier attribué par l'utilisateur. La valeur *NONE est renvoyée pour un document de distribution ou un document sans dossier.
Variable pour RTNFLR (63) (RTNFLR)
Indique le nom d'une variable CL de 63 caractères utilisée pour recevoir le chemin de dossier du document ou dossier choisi. La valeur *NONE est renvoyée pour un document de distribution, un document sans dossier ou un dossier de premier niveau.
Variable pour RTNDOCID (24) (RTNDOCID)
Indique le nom d'une variable CL de 24 caractères utilisée pour recevoir le LADN (nom de document attribué par la bibliothèque) de l'objet précisé. Pour obtenir le format du LADN, reportez-vous au paramètre Identificateur du document (DOCID).
Variable pour RTNLADNTSP (16) (RTNLADNTSP)
Indique le nom de la variable CL de 16 caractères utilisée pour recevoir l'horodatage du LADN de l'objet choisi. Cette variable se présente au format AAAAMMJJHHMNSSNN, où A représente l'année, M le mois, J le jour, H l'heure, MN les minutes, S les secondes et NN les nano-secondes.
Variable pour RTNOBJNAM (10) (RTNOBJNAM)
Indique le nom d'une variable CL de 10 caractères utilisée pour recevoir le nom d'objet système de l'objet choisi.
Variable pour RTNOBJCLS (8) (RTNOBJCLS)
Indique le nom d'une variable CL de 8 caractères utilisée pour recevoir la classe de l'objet. Les valeurs *DOC, *FLR, et *DST sont renvoyées respectivement pour un document classé, un dossier et un document de distribution.
Variable pour RTNASP (2 0) (RTNASP)
Indique le nom d'une variable CL décimale de longueur (2 0) utilisée pour le renvoi de l'ID du pool de mémoire secondaire. Les valeurs suivantes peuvent être renvoyées :
- 1
- L'objet se trouve dans le pool de mémoire secondaire du système.
- 2-32
- L'objet se trouve dans un pool de mémoire secondaire utilisateur.
Variable pour RTNOVRFLW (1) (RTNOVRFLW)
Indique le nom d'une variable CL à 1 caractère utilisé pour recevoir l'état de dépassement de l'objet, où :
- N = Non, l'objet n'a pas dépassé son ASP
- O = Oui, l'objet a dépassé son ASP et les objets, en partie ou en totalité, se trouvent dans l'ASP système.
Exemples
RTVDLONAM DLO(MYDOC) FLR(MYFLR) OBJCLS(*DOC) +
RTNDOCID(&DOCID)
Cette commande permet de trouver le document MYDOC dans le dossier MYFLR et de renvoyer son identificateur de document dans la variable &DOCID.
Messages d'erreur
Messages *ESCAPE
© Copyright IBM Corp. Texte d'aide reproduit à des fins de formation.