DSPFLR (Display Folder) Command Description

DSPFLR Command syntax diagram

Purpose

The Display Folder (DSPFLR) command allows the user to display or print a list of folders and documents or to create an out file that contains the list of folders or documents.

More information on displaying or printing lists of folders and documents is in the Use OfficeVision/400 Word Processing book.

Optional Parameters

FLR

Specifies the name of the folders or members on the list.

*ALL: All the folders that the user has authority to see are on the list.

folder-name: Specify the name of the folder whose contents is listed.

TYPE

Specifies whether documents or folders are listed.

*FLR: The list contains folders.

*DOC: The list contains documents.

OUTPUT

Specifies whether the output from the command is shown at the requesting workstation or printed with the job's spooled output. More information on this parameter is in commonly used parameters.

*: Output requested by an interactive job is shown on the display. Output requested by a batch job is printed with the job's spooled output.

*PRINT: The output is printed with the job's spooled output.

*OUTFILE: The output is directed to the database file specified on the OUTFILE parameter.

LEVEL

Specifies whether the list includes folders nested within folders or only folders at the current level. This parameter is not allowed when OUTPUT(*) is specified. For documents, *ALL cannot be specified.

*CURRENT: Only folders at the current level are listed.

*ALL: Nested folders within the folders specified are listed.

OUTFILE

Specifies the qualified name of the database file where the output of the display is directed. If the OUTFILE does not exist, this command creates a database file in the specified library. If the file is created by this function, the text for the database file is 'OUTFILE created by DSPFLR', and the authority given to all users is *EXCLUDE.

The name of the database file can be qualified by one of the following library values:

*LIBL: All libraries in the job's library list are searched until the first match is found.

*CURLIB: The current library for the job is searched. If no library is specified as the current library for the job, the QGPL library is used.

library-name: Specify the name of the library to be searched.

database-file-name: Specifies the qualified name of the database file that receives the output of the display.

OUTMBR

Specifies the name of the database file member to which the output is directed. If a member already exists, the system uses the second element of this parameter to determine whether the member is cleared before the new records are added. If the member does not exist and a member name is not specified, the system creates a member with the name of the output file specified on the OUTFILE parameter. If an output file member name is specified, but the member does not exist, the system creates it.

Element 1: New Member

*FIRST: The first member in the file receives the output. If OUTMBR(*FIRST) is specified and the member does not exist, the system creates a member with the name of the file specified on the OUTFILE parameter.

member-name: Specify the file member that receives the output. If OUTMBR(member-name) is specified and the member does not exist, the system creates it.

Element 2: Existing Member

*REPLACE: The system clears the existing member and adds the new records.

*ADD: The system adds the new records to the end of the existing records.

OUTFILFMT

Specifies the format of the database file to which the output of the display is directed.

*TYPE1: Output is directed to the file format used for Release V2R2 and all releases prior to V2R2. The format used is defined by model output file QADSPSDC (Document format) and QADSPSFR (Folder format) in library QSYS with record formats named DOCDTLS and FLRDTLS respectively.

*TYPE2: Output is directed to the file format used for Release V2R3 and all releases thereafter. The format used is defined by model output file QADSPDOC (Document format) and QADSPFLR (Folder format) in library QSYS with record formats named DOCDTL and FLRDTL respectively.

ASP

Specifies the auxiliary storage pool (ASP) from which the system will search to construct the list of folders or documents.

*ALL: All ASPs defined on the system will be searched. This is the effective value that was used on previous releases when no ASP parameter was provided on the DSPFLR command.

ASP-identifier: Specify a value ranging from 1 through 16 for the ASP identifier. These values depend on how ASPs are defined on the system.

Examples for DSPFLR

Example 1: Displaying or Printing Output

DSPFLR  FLR(GENERAL)  TYPE(*FLR)  OUTPUT(*)

This command shows a list of folders for the folder, GENERAL, at the requesting work station (if requested by an interactive job) or the output is printed with the job's spooled output (if requested by a batch job).

Example 2: Directing Output to a Database File

DSPFLR   FLR(*ALL)  TYPE(*FLR)  OUTPUT(*OUTFILE)
  LEVEL(*ALL)  OUTFILE(MYLIB/MYFILE)
  OUTMBR(MYMBR *REPLACE)

This command shows all the folders that the user has authority to view. The output is directed to MYMBR, in MYFILE located in MYLIB. If member MYMBR already exists, MYMBR is cleared and then the new records are added.

Error messages for DSPFLR

None