Where allowed to run: Compiled CL program or interpreted REXX (*BPGM *IPGM *BREXX *IREXX) Threadsafe: No |
Parameters Examples Error messages |
The Retrieve Document Library Object Name (RTVDLONAM) command is used to retrieve an alternate name for a filed document, folder, or distribution document and place the value into the specified variables. This command is valid only within a CL program or REXX exec.
Restrictions:
Top |
Keyword | Description | Choices | Notes |
---|---|---|---|
DLO | Document library object | Character value, *DOCID, *LADNTSP, *SYSOBJNAM | Required, Positional 1 |
FLR | Folder | Character value, *NONE | Optional, Positional 2 |
DOCID | Document identifier | Character value, *NONE | Optional |
LADNTSP | LADN timestamp | 0000000000000001-FFFFFFFFFFFFFFFF, *NONE | Optional |
SYSOBJNAM | System object name | Name, *NONE | Optional |
OBJCLS | Object class | *DOC, *FLR, *DST | Optional |
RTNDLO | CL var for RTNDLO (12) | Character value | Optional |
RTNFLR | CL var for RTNFLR (63) | Character value | Optional |
RTNDOCID | CL var for RTNDOCID (24) | Character value | Optional |
RTNLADNTSP | CL var for RTNLADNTSP (16) | Character value | Optional |
RTNOBJNAM | CL var for RTNOBJNAM (10) | Character value | Optional |
RTNOBJCLS | CL var for RTNOBJCLS (8) | Character value | Optional |
RTNASP | CL var for RTNASP (2 0) | Decimal number | Optional |
RTNOVRFLW | CL var for RTNOVRFLW (1) | Character value | Optional |
Top |
Specifies the document or folder for which a name is to be retrieved.
This is a required parameter.
This is a required parameter.
Top |
Specifies the folder path that contains the document or folder specified in the Document library object (DLO) parameter. The FLR parameter must be *NONE if the DLO parameter is *DOCID, *LADNTSP, or *SYSOBJNAM.
Top |
Specifies the library-assigned name of the document. This is the name assigned to the document by the system when it was created. Documents filed outside the local system have only library-assigned document names. The library-assigned document names can be determined by using the Query Document Library (QRYDOCLIB) command or by the message returned from the File Document (FILDOC) command.
Library-assigned document names are 24 characters in length with the following format:
YYYYMMDDHHMNSSHSSNSNSNSN
where:
YYYY = year MM = month DD = day HH = hour MN = minute SS = second HS = hundredths of a second SNSNSNSN = system name
Top |
Specifies the library assigned document name (LADN) timestamp of the document or folder object. A LADN timestamp is specified only if *LADNTSP is specified on the Document library object (DLO) parameter.
Top |
Specifies the system object name of the document or folder object. A system object name is specified only if *SYSOBJNAM is specified on the Document library object (DLO) parameter.
Top |
Specifies the class of the object to locate.
Top |
Specifies the name of a 12-character CL variable used to retrieve the user-assigned name of the selected document or folder. The *NONE value is returned for a distribution document or a document without a folder.
Top |
Specifies the name of a 63-character CL variable used to retrieve the folder path of the selected document or folder. The *NONE value is returned for a distribution document, a document without a folder, or a first-level folder.
Top |
Specifies the name of a 24-character CL variable used to retrieve the library-assigned document name of the selected object. Refer to the Document identifier (DOCID) parameter for the format of the library-assigned document name.
Top |
Specifies the name of a 16-character CL variable used to retrieve the timestamp from the LADN of the selected object. The variable is in the form YYYYMMDDHHMNSSNN.
Top |
Specifies the name of a 10-character CL variable used to retrieve the system object name of the selected object.
Top |
Specifies the name of a 8-character CL variable used to retrieve the object class. A value of *DOC is returned for a filed document, *FLR for a folder, and *DST for a distribution document.
Top |
Specifies the name of a variable used to return the auxiliary storage pool ID. In control language (CL) programs, this should be a decimal variable of length (2 0). The following values can be returned:
Top |
Specifies the name of a 1-character CL variable used to retrieve the overflow status of the object, where:
Top |
RTVDLONAM DLO(MYDOC) FLR(MYFLR) OBJCLS(*DOC) + RTNDOCID(&DOCID)
This command finds the document MYDOC in folder MYFLR and returns its document identifier in the variable &DOCID.
Top |
*ESCAPE Messages
Top |