Retrieve DLO Name (RTVDLONAM)

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

Parameters

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

Document library object (DLO)

Specifies the document or folder for which a name is to be retrieved.

This is a required parameter.

*DOCID
The document or folder is identified using its library-assigned document name specified in the DOCID parameter. The Folder (FLR) parameter must be *NONE.
*LADNTSP
The document or folder is identified using its library-assigned document name (LADN) timestamp specified in the LADNTSP parameter. The FLR parameter must be *NONE.
*SYSOBJNAM
The document or folder is identified using its system object name specified in the SYSOBJNAM parameter. The FLR parameter must be *NONE.
name
Specify the user-assigned name of the document or folder. The folder containing the specified document or folder is specified in the FLR parameter.

This is a required parameter.

Top

Folder (FLR)

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.

*NONE
The document or folder is not contained in a folder, or is identified using the DOCID, LADNTSP, or SYSOBJNAM parameter.
name
Specify the name of the folder that contains the document or folder named in the DLO parameter.
Top

Document identifier (DOCID)

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

*NONE
A library-assigned document name is not specified for the object.
name
Specify the library-assigned name of the document or folder object. The library-assigned document name can be determined by using the Query Document Library (QRYDOCLIB) command or by the message returned from the File Document (FILDOC) or other command.
Top

LADN timestamp (LADNTSP)

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.

*NONE
A LADN timestamp is not specified for the object.
timestamp
Specify the LADN timestamp of the document library object.
Top

System object name (SYSOBJNAM)

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.

*NONE
A system object name is not specified for the object.
name
Specify the system object name of the document library object.
Top

Object class (OBJCLS)

Specifies the class of the object to locate.

*DOC
The specified DLO is a filed document.
*FLR
The specified DLO is a folder.
*DST
The specified DLO is a distribution document.
Top

CL var for RTNDLO (12) (RTNDLO)

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

CL var for RTNFLR (63) (RTNFLR)

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

CL var for RTNDOCID (24) (RTNDOCID)

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

CL var for RTNLADNTSP (16) (RTNLADNTSP)

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

CL var for RTNOBJNAM (10) (RTNOBJNAM)

Specifies the name of a 10-character CL variable used to retrieve the system object name of the selected object.

Top

CL var for RTNOBJCLS (8) (RTNOBJCLS)

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

CL var for RTNASP (2 0) (RTNASP)

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:

1
The object is in the system auxiliary storage pool.
2-32
The object is in a user auxiliary storage pool.
Top

CL var for RTNOVRFLW (1) (RTNOVRFLW)

Specifies the name of a 1-character CL variable used to retrieve the overflow status of the object, where:

Top

Examples

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

Error messages

*ESCAPE Messages

CPF8AC0
&1 command failed.
CPF8AC1
Not authorized to distribution documents.
CPF8A75
Not authorized to access folder &1.
CPF8A77
Folder &1 not found.
CPF8A82
Document &2 not found in folder &1.
CPF8A83
Not authorized to access document &2 in folder &1.
Top