Cllss

Control Language (CL)
Copyright International Business Machines Corporation 2000. All rights reserved. US Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
Contents
Part 1. Control Language (CL) . . . . 1
Chapter 1. Whats new for V4R5 . . . . 3 Chapter 2. Print this topic . . . . . . . 9 Chapter 3. Monitorable messages . . . 11 Chapter 4. OS/400 commands . . . . . 13
Alphabetical listing of commands . . . . . . . 13 How commands are named . . . . . . . . . 59 Commands operating on OS/400 objects . . . . 59 Commands operating on multiple objects . . . . 60 Files used by CL commands . . . . . . . . . 61 Printing command descriptions on the AS/400 . . 102 SEV parameter . . . SPLNBR parameter . TEXT parameter . . VOL parameter . . . WAITFILE parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153 155 155 156 157
Chapter 8. Command syntax . . . . . 159

Delimiters . . . . . . . . Command continuation . . . . Entering comments . . . . . Summary of general coding rules. . . . . . . . . . . . . . . . . . . . . . . . . 159 161 162 162
Chapter 9. About syntax diagrams

How to read syntax diagrams . . . . . . . How syntax diagrams show command structure Syntax diagram rules . . . . . . . . . .
165
. 165 166 . 166
Chapter 5. OS/400 objects . . . . . . 105

Library objects . . . . . . . . . . . Simple and qualified object names . . . . Example: Simple and qualified object name Generic object names . . . . . . . . . Example: Generic object name . . . . . . . 108 . . 111 . . 111 . . 111 . . 113
Chapter 10. CL character sets and values . . . . . . . . . . . . . . 177

Character sets . . . Special character usage Symbolic operators Predefined values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177 178 179 180
Chapter 6. Command description format . . . . . . . . . . . . . . 115 Chapter 7. Command parts . . . . . 117

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117 118 118 118 119 120 128 129 130 131 137 138 138 140 140 141 142 144 145 145 149 149 151
Chapter 11. Object naming rules . . . 181

Path names (*PNAME) . . . . . Generic names (*GENERIC) . . . Additional rules for unique names . . . . . . . . . . . . . . 182 . 184 . 184
Label . . . . . . . . . . . . . . Name . . . . . . . . . . . . . . Parameters . . . . . . . . . . . . Required, optional, and key parameters . Parameters in keyword and positional form Parameter values . . . . . . . . . Commonly used parameters: Expanded descriptions . . . . . . . . . . . . AUT parameter. . . . . . . . . . CLS parameter . . . . . . . . . . COUNTRY parameter . . . . . . . EXCHTYPE parameter . . . . . . . FILETYPE parameter . . . . . . . . FRCRATIO parameter . . . . . . . IGCFEAT parameter . . . . . . . . Double-byte character text in CL commands JOB parameter . . . . . . . . . . LABEL parameter . . . . . . . . . MAXACT parameter . . . . . . . . OBJ parameter . . . . . . . . . . OBJTYPE parameter . . . . . . . . OUTPUT parameter . . . . . . . . PRTTXT parameter . . . . . . . . REPLACE parameter . . . . . . . . Scheduling priority parameters (JOBPTY, OUTPTY, PTYLMT) . . . . . . . .
Copyright IBM Corp. 2000
Chapter 12. Naming within commands 187 Chapter 13. Folder and document names . . . . . . . . . . . . . . 191 Chapter 14. Expressions in CL commands . . . . . . . . . . . . 193
Arithmetic expressions . . . . . . . . . Character string expressions . . . . . . . Example: Character string expressions . . . Example: Using character strings and variables Relational expressions . . . . . . . . . Logical expressions . . . . . . . . . . Operators in expressions . . . . . . . . Priority of operators when evaluating expressions Built-in functions for CL. . . . . . . . . %BINARY . . . . . . . . . . . . %SUBSTRING . . . . . . . . . . . %SWITCH . . . . . . . . . . . . . 193 . 194 . 195 196 . 196 . 197 . 198 199 . 200 . 200 . 202 . 203
Chapter 15. Command definition statements . . . . . . . . . . . . 205

Creating user-defined commands . . . . . Command definition statement descriptions . . . . 205 . 206
. 152
iii
CMD (command) statement . . . Example: CMD statement . . . DEP (dependent) statement. . . . Example: DEP statement . . . ELEM (element) statement . . . . Example: ELEM statement . . . PARM (Parameter) statement . . . Examples: PARM statement . . PMTCTL (Prompt Control) statement Example: PMTCTL statement . . QUAL (Qualifier) statement . . .
. . . . . . . . . . .
. . . . . . . . . . .
. . . . . . . . . . .
. . . . . . . . . . .
. . . . . . . . . . .
206 207 207 210 210 226 227 247 247 249 249
Example: QUAL statement .
. 258
Chapter 16. Parameter values used for testing and debugging . . . . . . . 261
Program-variable description . . . Basing-pointer description . . . . Subscript description . . . . . . Qualified-name description . . . . Rules for qualified name description . . . . . . . . . . . . . . . . . . . . . . . . . 261 261 262 262 263
iv
Part 1. Control Language (CL)

This topic provides the information necessary for system programmers and system administrators to write programs using the Control Language commands. In this topic you will also find an alphabetical list of the base operating system commands for easy retrieval. v Chapter 1. Whats new for V4R5 on page 3 v Chapter 2. Print this topic on page 9 v v v v v v Chapter 3. Chapter 4. Chapter 5. Chapter 6. Chapter 7. Chapter 8. Monitorable messages on page 11 OS/400 commands on page 13 OS/400 objects on page 105 Command description format on page 115 Command parts on page 117 Command syntax on page 159
v Chapter 9. About syntax diagrams on page 165 v Chapter 10. CL character sets and values on page 177 v v v v v Chapter 11. Object naming rules on page 181 Chapter 12. Naming within commands on page 187 Chapter 13. Folder and document names on page 191 Chapter 14. Expressions in CL commands on page 193 Chapter 15. Command definition statements on page 205
Chapter 1. Whats new for V4R5

The information found in this topic is new to the Information Center for V4R5. This information replaces what was formerly known as CL Reference. CL Reference is no longer available as a printed manual. To print CL information, including command descriptions, see Chapter 2. Print this topic on page 9. Following is a list of new and deleted CL commands for tihs release, new object types, and new system values. Links are provided for easy access to the changes. How to see whats new or changed: To see changes made to the conceptual information, view or print the Control Language PDF. To help you see where technical changes have been made to the CL command descriptions, this information uses: v The v The image to mark where new or changed information begins. image to mark where new or changed information ends.
New Object Types There were no new object types in the OS/400 licensed program for Version 4 Release 5 Modification 0 (V4R5M0). New CL Commands The following commands are new in the OS/400 licensed program for Version 4 Release 5 Modification 0 (V4R5M0): TRCCNN (Trace Connection) Deleted Commands The following commands were removed from the OS/400 licensed program for Version 4 Release 5 Modification 0 (V4R5M0):
ADDRMTSVR CHGM36 CHGM36CFG CHGNWSALS CRTM36 CRTM36CFG CRTNWSALS DLTM36 DLTM36CFG DLTNWSALS DSPM36 DSPM36CFG DSPNWSALS
DSPNWSSSN DSPNWSSTC ENDM36 INSFLMSVR INSNTWSVR SNDNWSMSG STRM36 STRM36PRC TFRM36 WRKM36 WRKM36CFG WRKNWSALS WRKNWSSSN
Changed Commands The following command descriptions changed for Version 4 Release 5 Modification 0 (V4R5M0): ADDMSGD (Add Message Description) ADDNWSSTGL (Add Network Server Storage Link) ADDTCPIFC (Add TCP/IP Interface) ADDTCPRTE (Add TCP/IP Route) ALCOBJ (Allocate Object) APYJRNCHG (Apply Journaled Changes) CHGAUT (Change Authority) CHGCTLVWS (Change Controller Description - Virtual Work Station) CHGDEVDSP (Change Device Description - Display) CHGDEVPRT (Change Device Description Printer) CHGDSPF (Change Display File) CHGJOB (Change Job) CHGJOBD (Change Job Description) CHGJOBSC (Change Job Schedule Entry) CHGJRN (Change Journal) CHGLINETH (Change Line Description) CHGLINTRN (Change Line Description -Token-Ring Network) CHGMOD (Change Module) CHGMSGD (Change Message) CHGNWSA (Change Network Server Attributes) CHGNWSD (Change Network Server Description) CHGOPTA (Change Optical Attributes) CHGPGM (Change Program) CHGPRTF (Change Printer File) CHGSRVPGM (Change Service Program)
CHGTCPA (Change TCP/IP Attributes) CHGTCPIFC (Change TCP/IP Interface) CHGTCPRTE (Change TCP/IP Route) CHKCMNTRC (Check Communications Trace) CPYF (Copy File) CPYFRMDKT (Copy From Diskette) CPYFRMIMPF (Copy From Import File) CPYFRMQRYF (Copy From Query File) CPYOPT (Copy Optical) CPYPTF (Copy Program Temporary Fix) CPYTODKT (Copy to Diskette) CPYTOTAP (Copy To Tape) CRTLINTR (Create Line Description (TokenRing Network) ) CRTCMD (Create Command) CRTCTLVWS (Create Controller Description - Virtual Work Station) CRTDEVDSP (Create Device Description - Display) CRTDEVPRT (Create Device Description - Printer) CRTDSPF (Create Display File) CRTDTAQ (Create Data Queue) CRTDUPOBJ (Create Duplicate Object) CRTJOBD (Create Job Description) CRTJRN (Create Journal) CRTJRNRCV (Create Journal Receiver) CRTLINETH (Create Line Description - Ethernet) CRTNWSD (Create Network Server Description ) CRTNWSSTG (Create Network Server Storage Space) CRTPRTF (Create Printer File) CRTSBSD (Create Subsystem Description)
DLCOBJ (Deallocate Object) DLKTCMNTRC (Delete Communications Trace) DSCJOB (Disconnect Job) DSPAUDJRNE (Display Audit Journal Entries) DSPDTAARA (Display Data Area) DSPHDWRSC (Display Hardware Resources) DSPNWSA (Display Network Server Attributes) DSPNWSUSRA (Display Network Server User Attributes) DSPNWSUSR (Display Network Server Users) DSPOPCLNK (Display OptiConnect Link Status) DSPSFWRSC (Display Software Resources) DUPOPT (Duplicate Optical) ENDCMNTRC (End Communications Trace) ENDGRPJOB (End Group Job) ENDJOBABN (End Job Abnormal) ENDTCPIFC (End TCP/IP Interface) ENDTCPSVR (End TCP/IP Server) INSPTF (Install Program Temporary Fix) INZOPT (Initialize Optical) INZPFM (Initialize Physical File Member) LODPTF (Load Program Temporary Fix) LODRUN (Load and Run Media Program) OVRDBF (Override with Database File) OVRDSPF (Override with Display File) OVRPRTF (Override with Printer File) PRTCMNTRC (Print Communications Trace) PWRDWNSYS (Power Down System) RLSJOB (Release Job)
RMVJRNCHG (Remove Journaled Changes) RMVTCPIFC (Remove TCP/IP Interface) RMVTDCPRTE (Remove TCP/IP Route) RST (Restore) RSTCFG (Restore Configuration) RSTDLO (Restore Document Library Object) RSTLIB (Restore Library) RSTLICPGM (Restore Licensed Program) RSTOBJ (Restore Object) RSTUSRPRF (Restore User Profiles) RTVJOBAl (Retrieve Job Attributes) SAV (Save) SAVCFG (Save Configuration) SAVCHGOBJ (Save Changed Object) SAVDLO (Save Documnet Library Object) SAVLIB (Save Library) SAVLICPGM (Save Licensed Program) SAVOBJ (Save Object) SAVSAVFDA (Save Save File Data) SAVSECDTA (Save Security Data) SAVSYS (Save System) SBMJOB (Submit Job) SBMNWSCMD (Submit Network Server Command) SNDDST (Send Distribution) STRCMNTRC (Start Communications Trace) STRTCPIFC (Start TCP/IP Interface) STRTCPSVR (Start TCP/IP Server) TRCINIT (Trace Internal)
VRYCFG (Vary Configuration) WRKNWSSTS (Work with Network Server Status) WRKOPTVOL (Work with Optical Volumes)
Chapter 2. Print this topic

You can view or download a PDF version of this document for viewing or printing. You must have Adobe Acrobat Reader installed to view PDF files. You can download a copy from Adobe. The following links provide the PDF versions of the basic CL information, as well as the CL commands.The PDF versions of the commands do not contain the syntax diagram. To view or download a PDF, select one of the following links: v v v v v v v Control Language (basic CL information) (1.5KB / 225 pages). Commands ADDACC ADDNTWAE (570KB / 260 pages) Commands ADDNWSSTGL ASKQST (445KB / 200 pages) Commands CALL CHGLINBSC (1, 483KB / 515 pages) Commands CHGLINDDI CHGWTR (1,437KB / 515 pages) Commands CHKCMNTRC CPYTOTAP (582KB / 190 pages) Commands CRTALRTBL CRTWSCST(1,933KB / 670 pages)
v Commands DATA EXPORTS (2,217KB / 675 pages) v Commands FILDOC RPLDOC (1,781KB / 575 pages) v Commands RQSORDAST SBMRMTCMD (1,112KB / 400 pages) v Commands SETATNPGM UPDSYSINF (812KB / 270 pages) v Commands VFYAPPC WRKWTR (984KB / 300 pages) To 1. 2. 3. 4. 5. save a PDF on your workstation for viewing or printing: Open the PDF in your browser (click the link above). In the menu of your browser, click File. Click Save As... Navigate to the directory in which you would like to save the PDF. Click Save.
10
Chapter 3. Monitorable messages

Monitorable messages are those *ESCAPE, *STATUS, and *NOTIFY messages that can be issued by each CL command that can be used in a program. You can use this information to determine which messages you want to monitor for in your program. Using the Monitor Message (MONMSG) CL command, you can monitor for one or more messages and then specify (on the MONMSG command) what action you want taken when any of those messages are issued by the commands(s) being monitored. You can view the monitorable messages listed at the bottom of each command description by selecting a command from the Alphabetical listing of commands on page 13. If you have a V4R2 or later system, you can refer to the online help for an individual command to obtain its monitorable message information. To view the online command help on an AS/400 system, type the command name on a command line and press F1 (Help). The error message information follows the brief description of the purpose for the command. Please refer to Chapter 8 of the CL Programming book for information concerning messages that are sent to the QSYSMSG queue.
11
12
Chapter 4. OS/400 commands

This section of the CL topic provides an Alphabetical listing of commands for easy command retrieval. This section also provides valuable information about how commands are named and how commands act on individual and multiple OS/400 objects. In addition it provides information about Printing command descriptions on the AS/400 on page 102. v Alphabetical listing of commands v How commands are named on page 59 v Commands operating on OS/400 objects on page 59 v Commands operating on multiple objects on page 60 v Files used by CL commands on page 61 v Printing command descriptions on the AS/400 on page 102
Alphabetical listing of commands

ABCDEFGHILMNOPQRSTUVW A v Add Acces Code (ADDACC) Command, ADDACC syntax diagram v Add Autostart Job Entry (ADDAJE) Command, ADDAJE syntax diagram v Add Alert Action Entry (ADDALRACNE) Command, ADDALRACNE syntax diagram v Add Alert Description (ADDALRD) Command, ADDALRD syntax diagram v Add Alert Selection Entry (ADDALRSLTE) Command, ADDALRSLTE syntax diagram v Add Authorization List Entry (ADDAUTLE) Command, ADDAUTLE syntax diagram v Add Breakpoint (ADDBKP) Command, ADDBKP syntax diagram v Add Binding Directory Entry (ADDBNDDIRE) CommandADDBNDDIRE syntax diagram v Add Circuit Route (ADDCCTRTE) Command, ADDCCTRTE syntax diagram v Add Circuit Service (ADDCCTSRV) Command, ADDCCTSRV syntax diagram v Add Configuration List Entries (ADDCFGLE) Command, ADDCFGLE syntax diagram v Add Communications Entry (ADDCMNE) Command, ADDCMNE syntax diagram v Add Connection List Entry (ADDCNNLE) Command, ADDCNNLE syntax diagram v Add Community for SNMP (ADDCOMSNMP) CommandADDCOMSNMP syntax diagram v Add Directory Entry (ADDDIRE) Command, ADDDIRE syntax diagram v Add Directory Shadow System (ADDDIRSHD) Command, ADDDIRSHD syntax diagram v Add Document Library Object Authority (ADDDLOAUT)Command, ADDDLOAUT syntax diagram
13
v Add Distribution List Entry (ADDDSTLE) Command, ADDDSTLE syntax diagram v Add Distribution Queue (ADDDSTQ) Command, ADDDSTQ syntax diagram v Add Distribution Route (ADDDSTRTE) Command, ADDDSTRTE syntax diagram v Add Distribution Secondary System Name (ADDDSTSYSN)Command, ADDDSTSYSN syntax diagram v Add Data Definition (ADDDTADFN) Command, ADDDTADFN syntax diagram v Add Emulation Configuration Entry (ADDEMLCFGE)Command, ADDEMLCFGE syntax diagram v Add Environment Variable (ADDENVVAR) Command, ADDENVVAR syntax diagram v Add Extended Wireless Controller Bar Code Entry (ADDEWCBCDE) Command, ADDEWCBCDE syntax diagram v Add Extended Wireless Controller Member (ADDEWCM)Command, ADDEWCM syntax diagram v Add Extended Wireless Controller PTC Entry (ADDEWCPTCE)Command, ADDEWCPTCE syntax diagram v Add Extended Wireless Line Member (ADDEWLM) Command, ADDEWLM syntax diagram v Add Exit Program (ADDEXITPGM) Command, ADDEXITPGM syntax diagram v Add Font Table Entry (ADDFNTTBLE) Command, ADDFNTTBLE syntax diagram v Add Host Database to DataLink File Manager (ADDHDBDLFM) CommandAdd Host Database to DataLink File Manager (ADDHDBDLFM) Command v Add Intersystem Communications Function ProgramDevice Entry (ADDICFDEVE) Command, ADDICFDEVE syntax diagram v Add IP over IPX Address Description (ADDIPIADR),ADDIPIADR syntax diagram v Add IP over IPX Interface (ADDIPIIFC) Command, ADDIPIIFC syntax diagram v Add IP over IPX Route (ADDIPIRTE) Command, ADDIPIRTE syntax diagram v Add IP over SNA Interface (ADDIPSIFC) Command, ADDIPSIFC syntax diagram v Add IP over SNA location entry (ADDIPSLOC) Command, ADDIPSLOC syntax diagram v Add IP over SNA Route (ADDIPSRTE) Command, ADDIPSRTE syntax diagram v Add IPX Circuit (ADDIPXCCT) Command, ADDIPXCCT syntax diagram v Add Job Queue Entry (ADDJOBQE) Command, ADDJOBQE syntax diagram v Add Job Schedule Entry (ADDJOBSCDE) Command, ADDJOBSCDE syntax diagram v Add Local Area Network Adapter Information (ADDLANADPI)Command, ADDLANADPI syntax diagram v Add Logical File Member (ADDLFM) Command, addlfm syntax diagram v Add Library List Entry (ADDLIBLE) Command, ADDLIBLE syntax diagram v Add License Key Information (ADDLICKEY) Command, ADDLICKEY syntax diagram v Add Link (ADDLNK) Command, addlnk syntax diagram v Add Mounted File System (ADDMFS) Command, addmfs syntax diagram
14
v Add Message Description (ADDMSGD) Command, ADDMSGD syntax diagram v Add Nickname (ADDNCK) Command, ADDNCK syntax diagram v Add Network Job Entry (ADDNETJOBE) Command, ADDNETJOBE syntax diagram v Add Network Table Entry (ADDNETTBLE) Command, ADDNETTBLE syntax diagram v Add Node List Entry (ADDNODLE) Command, ADDNODLE syntax diagram v (ADDNTWAE), ADDNTWAE syntax diagram v Add Network Server Storage Link (ADDNWSSTGL) Command, ADDNWSSTGL syntax diagram v Add Optical Cartridge (ADDOPTCTG) Command, ADDOPTCTG syntax diagram v Add Optical Server (ADDOPTSVR) Command, ADDOPTSVR syntax diagram v Add Protocol Table Entry (ADDPCLTBLE) Command, ADDOPTCTG syntax diagram v Add Performance Explorer Definition (ADDPEXDFN)Command, ADDPEXDFN syntax diagram v Add Physical File Constraint (ADDPFCST) Command, ADDPFCST syntax diagram v Add Physical File Member (ADDPFM) Command, ADDPFM syntax diagram v Add Performance Collection (ADDPFRCOL) Command, ADDPFRCOL syntax diagram v Add Physical File Trigger (ADDPFTRG) Command, ADDPFTRG syntax diagram v Add Program (ADDPGM) Command, ADDPGM syntax diagram v Add Prestart Job Entry (ADDPJE) Command, ADDPJE syntax diagram v Add Problem Action Entry (ADDPRBACNE) Command, ADDPRBACNE syntax diagram v Add Problem Selection Entry (ADDPRBSLTE) Command, ADDPRBSLTE syntax diagram v Add Relational Database Directory Entry (ADDRDBDIRE)Command, ADDRDBDIRE syntax diagram v Add REXX Buffer (ADDREXBUF) Command, ADDREXBUF syntax diagram v Add Remote Definition (ADDRMTDFN) Command, ADDRMTDFN syntax diagram v Add Remote Journal (ADDRMTJRN) Command, ADDRMTJRN syntax diagram v Add Reply List Entry (ADDRPYLE) Command, ADDRPYLE syntax diagram v Add Routing Entry (ADDRTGE) Command, ADDRTGE syntax diagram v Add Search Index Entry (ADDSCHIDXE) Command, ADDSCHIDXE syntax diagram v Add SNA over IPX Location (ADDSNILOC) Command, ADDSNILOC syntax diagram v Add Sphere of Control Entry (ADDSOCE) Command, ADDSOCE syntax diagram v Add Service Table Entry (ADDSRVTBLE) Command, ADDSRVTBLE syntax diagram v Add Server Authentication Entry (ADDSVRAUTE) Command, ADDSVRAUTE syntax diagram v Add Tape Cartridge (ADDTAPCTG) Command, ADDTAPCTG syntax diagram
15
v Add TCP/IP Host Table Entry (ADDTCPHTE) Command, ADDTCPHTE syntax diagram v Add TCP/IP Interface (ADDTCPIFC) Command, ADDTCPIFC syntax diagram v Add TCP/IP Port Restriction (ADDTCPPORT) Command, ADDTCPPORT syntax diagram v Add TCP/IP Remote System Information (ADDTCPRSI)Command, ADDTCPRSI syntax diagram v Add TCP/IP Route (ADDTCPRTE) Command, ADDTCPRTE syntax diagram v Add Trace (ADDTRC) Command, ADDTRC syntax diagram v Add Ultimedia System Facilities Connection Entry (ADDUSFCNNE) Command, ADDUSFCNNE syntax diagram v Add Ultimedia System Facilities Device Entry (ADDUSFDEVE) Command, ADDUSFDEVE syntax diagram v Add Ultimedia System Facilities Server Entry (ADDUSFSVRE) Command, ADDUSFSVRE syntax diagram v Add Work Station Entry (ADDWSE) Command, ADDWSE syntax diagram v Allocate Object (ALCOBJ) Command, ALCOBJ syntax diagram v Answer Line (ANSLIN) Command, ANSLIN syntax diagram v Answer Questions (ANSQST) Command, ANSQST syntax diagram v Analyze Default Passwords (ANZDFTPWD) Command, ANZDFTPWD syntax diagram v Analyze Problem (ANZPRB) Command, ANZPRB syntax diagram v Analyze Profile Activity (ANZPRFACT) Command, ANZPRFACT syntax diagram v Analyze Query (ANZQRY) Command, ANZQRY syntax diagram v Analyze User Objects (ANZUSROBJ) Command, ANZUSROBJ syntax diagram v APING Command, APING syntax diagram v Apply Journaled Changes (APYJRNCHG) Command, APYJRNCHG syntax diagram v Apply Program Temporary Fix (APYPTF) Command, APYPTF syntax diagram v AREXEC Command, AREXEC syntax diagram v Ask Question (ASKQST) Command, ASKQST syntax diagram B (Back to the top) v Batch Job (BCHJOB) Command, BCHJOB syntax diagram C (Back to the top) v Call Program (CALL) Command, CALL syntax diagram v v v v Call Bound Procedure (CALLPRC) Command, CALLPRC syntax diagram Change Current Directory (CD) Command, CD syntax diagram Change Current Directory (CHDIR) Command, CHDIR syntax diagram Change Accounting Code (CHGACGCDE) Command, CHGACGCDE syntax diagram v Change Active Profile List (CHGACTPRFL) Command, CHGACTPRFL syntax diagram v Change Activation Schedule Entry (CHGACTSCDE) Command, CHGACTSCDE syntax diagram v Change Autostart Job Entry (CHGAJE) Command, CHGAJE syntax diagram
16
v Change Alert Action Entry (CHGALRACNE) Command, CHGALRACNE syntax diagram v Change Alert Description (CHGALRD) Command, CHGALRD syntax diagram v Change Alert Selection Entry (CHGALRSLTE) Command, CHGALRSLTE syntax diagram v Change Alert Table (CHGALRTBL) Command, CHGALRTBL syntax diagram v Change Auditing Value (CHGAUD) Command, CHGAUD syntax diagram v Change Authority (CHGAUT) Command, CHGAUT syntax diagram v Change Authorization List Entry (CHGAUTLE) Command, CHGAUTLE syntax diagram v Change Backup Options (CHGBCKUP) Command, CHGBCKUP syntax diagram v Change BOOTP Attributes (CHGBPA) Command, CHGBPA syntax diagram v Change Circuit Route (CHGCCTRTE) Command, CHGCCTRTE syntax diagram v Change Circuit Service (CHGCCTSRV) Command, CHGCCTSRV syntax diagram v Change Configuration List (CHGCFGL) Command, CHGCFGL syntax diagram v Change Configuration List Entry (CHGCFGLE) Command, CHGCFGLE syntax diagram v Change Cleanup (CHGCLNUP) Command, CHGCLNUP syntax diagram v Change Class (CHGCLS) Command, CHGCLS syntax diagram v Change Coded Font (CHGCDEFNT) Command, CHGCDEFNT syntax diagram v Change Command (CHGCMD) Command, CHGCMD syntax diagram v Change Command Default (CHGCMDDFT) Command, CHGCMDDFT syntax diagram v Change Communications Entry (CHGCMNE) Command, CHGCMNE syntax diagram v Change Connection List (CHGCNNL) Command, CHGCNNL syntax diagram v Change Connection List Entry (CHGCNNLE) Command, CHGCNNLE syntax diagram v Change Community for SNMP (CHGCOMSNMP) Command, CHGCOMSNMP syntax diagram v Change Class-of-Service Description (CHGCOSD) Command, CHGCOSD syntax diagram v Change Change Request Description (CHGCRQD) Command, CHGCRQD syntax diagram v Change Communications Side Information (CHGCSI) Command, CHGCSI syntax diagram v Change Controller Description (APPC) (CHGCTLAPPC) Command, CHGCTLAPPC syntax diagram v Change Controller Description (Async) (CHGCTLASC) Command, CHGCTLASC syntax diagram v Change Controller Description (BSC) (CHGCTLBSC) Command, CHGCTLBSC syntax diagram v Change Controller Description (Finance) (CHGCTLFNC) Command, CHGCTLFNC syntax diagram v Change Controller Description (SNA Host) (CHGCTLHOST) Command, CHGCTLHOST syntax diagram v Change Controller Description (Local Work Station) (CHGCTLLWS) Command, CHGCTLLWS syntax diagram
17
v Change Controller Description (Network) (CHGCTLNET) Command, CHGCTLNET syntax diagram v Change Controller Description (Retail) (CHGCTLRTL) Command, CHGCTLRTL syntax diagram v Change Controller Description (Remote Work Station) (CHGCTLRWS) Command, CHGCTLRWS syntax diagram v Change Controller Description (TAPE) (CHGCTLTAP) Command, CHGCTLTAP syntax diagram v Change Controller Description (Virtual Work Station) (CHGCTLVWS) Command, CHGCTLVWS syntax diagram v Change Current Directory (CHGCURDIR) Command, CHGCURDIR syntax diagram v Change Current Library (CHGCURLIB) Command, CHGCURLIB syntax diagram v Change Debug (CHGDBG) Command, CHGDBG syntax diagram v Change Distributed Data Management File (CHGDDMF) Command, CHGDDMF syntax diagram v Change DDM TCP/IP Attributes (CHGDDMTCPA) Command, CHGDDMTCPA syntax diagram v Change Device Description syntax diagram v Change Device Description syntax diagram v Change Device Description syntax diagram v Change Device Description syntax diagram v Change Device Description syntax diagram (APPC) (CHGDEVAPPC) Command, CHGDEVAPPC (Async) (CHGDEVASC) Command, CHGDEVASC (BSC) (CHGDEVBSC) Command, CHGDEVBSC (Crypto) (CHGDEVCRP) Command, CHGDEVCRP (Diskette) (CHGDEVDKT) Command, CHGDEVDKT
v Change Device Description (Display) (CHGDEVDSP) Command, CHGDEVDSP syntax diagram v Change Device Description (Finance) (CHGDEVFNC) Command, CHGDEVFNC syntax diagram v Change Device Description (SNA Host) (CHGDEVHOST) Command, CHGDEVHOST syntax diagram v Change Device Description (Intrasystem) (CHGDEVINTR) Command, CHGDEVINTR syntax diagram v Change Device Description (Media Library) (CHGDEVMLB) Command, CHGDEVMLB syntax diagram v Change Device Description (Network) (CHGDEVNET) Command, CHGDEVNET syntax diagram v Change Device Description (Optical) (CHGDEVOPT) Command, CHGDEVOPT syntax diagram v Change Device Description (Printer) (CHGDEVPRT) Command, CHGDEVPRT syntax diagram v Change Device Description (Retail) (CHGDEVRTL) Command, CHGDEVRTL syntax diagram v Change Device Description (SNA Pass-Through) (CHGDEVSNPT) Command, CHGDEVSNPT syntax diagram
18
v Change Device Description (SNUF) (CHGDEVSNUF) Command, CHGDEVSNUF syntax diagram v Change Device Description (Tape) (CHGDEVTAP) Command, CHGDEVTAP syntax diagram v Change DHCP Attributes (CHGDHCPA) Command, CHGDHCPA syntax diagram v Change Directory Entry (CHGDIRE) Command, CHGDIRE syntax diagram v Change Directory Shadow System (CHGDIRSHD) Command, CHGDIRSHD syntax diagram v Change Diskette File (CHGDKTF) Command, CHGDKTF syntax diagram v Change Document Library Object Audit (CHGDLOAUD) Command, CHGDLOAUD syntax diagram v Change Document Library Object Authority (CHGDLOAUT) Command, CHGDLOAUT syntax diagram v Change Document Library Object Owner (CHGDLOOWN) Command, CHGDLOOWN syntax diagram v Change Document Library Object Primary Group (CHGDLOPGP) Command, CHGDLOPGP syntax diagram v Change Document Description (CHGDOCD) Command, CHGDOCD syntax diagram v Change Display File (CHGDSPF) Command, CHGDSPF syntax diagram v Change Distribution Attributes (CHGDSTA) Command, CHGDSTA syntax diagram v Change Distribution Description (CHGDSTD) Command, CHGDSTD syntax diagram v Change Distribution List (CHGDSTL) Command, CHGDSTL syntax diagram v Change Dedicated Service Tools Password (CHGDSTPWD) Command, CHGDSTPWD syntax diagram v Change Distribution Queue (CHGDSTQ) Command, CHGDSTQ syntax diagram v Change Distribution Route (CHGDSTRTE) Command, CHGDSTRTE syntax diagram v Change Data Area (CHGDTAARA) Command, CHGDTAARA syntax diagram v Change Emulation Configuration Entry (CHGEMLCFGE) Command, CHGEMLCFGE syntax diagram v Change Environment Variable (CHGENVVAR) Command, CHGENVVAR syntax diagram v Change Extended Wireless Controller Bar Code Entry (CHGEWCBCDE) Command, CHGEWCBCDE syntax diagram v Change Extended Wireless Controller Member (CHGEWCM) Command, CHGEWCM syntax diagram v Change Extended Wireless Controller PTC Entry (CHGEWCPTCE) Command, CHGEWCPTCE syntax diagram v Change Extended Wireless Line Member (CHGEWLM) Command, CHGEWLM syntax diagram v Change Expiration Schedule Entry (CHGEXPSCDE) Command, CHGEXPSCDE syntax diagram v Change Font Resource (CHGFNTRSC) Command, CHGFNTRSC syntax diagram v Change Font Table Entry (CHGFNTTBLE) Command, CHGFNTTBLE syntax diagram
19
v Change Filter (CHGFTR) Command, CHGFTR syntax diagram v Change Group Attributes (CHGGRPA) Command, CHGGRPA syntax diagram v Change High-Level Language Pointer (CHGHLLPTR) Command, CHGHLLPTR syntax diagram v Change ICF Program Device Entry (CHGICFDEVE) Command, CHGICFDEVE syntax diagram v Change Intersystem Communications Function File (CHGICFF) Command, CHGICFF syntax diagram v Change IP over IPX Address (CHGIPIADR) Command, CHGIPIADR syntax diagram v Change IP over IPX Interface (CHGIPIIFC) Command, CHGIPIIFC syntax diagram v Change IPL Attributes (CHGIPLA) Command, CHGIPLA syntax diagram v Change IP over SNA Interface (CHGIPSIFC) Command, CHGIPSIFC syntax diagram v Change IP over SNA Location (CHGIPSLOC) Command, CHGIPSLOC syntax diagram v Change IP over SNA Type of Service (CHGIPSTOS) Command, CHGIPSTOS syntax diagram v Change IPX Circuit (CHGIPXCCT) Command, CHGIPXCCT syntax diagram v Change IPX Description (CHGIPXD) Command, CHGIPXD syntax diagram v Change Job (CHGJOB) Command, CHGJOB syntax diagram v Change Job Description (CHGJOBD) Command, CHGJOBD syntax diagram v Change Job Media Library Attributes (CHGJOBMLBA) Command, CHGJOBMLBA syntax diagram v Change Job Queue Entry (CHGJOBQE) Command, CHGJOBQE syntax diagram v Change Job Schedule Entry (CHGJOBSCDE) Command, CHGJOBSCDE syntax diagram v Change Journal (CHGJRN) Command, CHGJRN syntax diagram v Change Keyboard Map (CHGKBDMAP) Command, CHGKBDMAP syntax diagram v Change LAN Adapter Information (CHGLANADPI) Command, CHGLANADPI syntax diagram v Change Logical File (CHGLF) Command, chglf syntax diagram v Change Logical File Member (CHGLFM) Command, CHGLFM syntax diagram v Change Library (CHGLIB) Command, CHGLIB syntax diagram v Change Library List (CHGLIBL) Command, CHGLIBL syntax diagram v Change License Information (CHGLICINF) Command, CHGLICINF syntax diagram v Change Line Description (Async) (CHGLINASC) Command, CHGLINASC syntax diagram v Change Line Description (BSC) (CHGLINBSC) Command, CHGLINBSC syntax diagram v Change Line Description (DDI Network) (CHGLINDDI) Command, CHGLINDDI syntax diagram v Change Line Description (Ethernet) (CHGLINETH) Command, CHGLINETH syntax diagram
20
v Change Line Description (Fax) (CHGLINFAX) Command, CHGLINFAX syntax diagram v Change Line Description (Frame Relay Network) (CHGLINFR) Command, CHGLINFR syntax diagram v Change Line Description (IDLC) (CHGLINIDLC) Command, CHGLINIDLC syntax diagram v Change Line Description (Network) (CHGLINNET) Command, CHGLINNET syntax diagram v Change Line Description (PPP) (CHGLINPPP) Command Description, CHGLINPPP syntax diagram v Change Line Description (SDLC) (CHGLINSDLC) Command, CHGLINSDLC syntax diagram v Change Line Description (TDLC) (CHGLINTDLC) Command, CHGLINTDLC syntax diagram v Change Line Description (Token-Ring Network) (CHGLINTRN) Command, CHGLINTRN syntax diagram v Change Line Description (Wireless) (CHGLINWLS) Command, CHGLINWLS syntax diagram v Change Line Description (X.25) (CHGLINX25) Command, CHGLINX25 syntax diagram v Change Menu (CHGMNU) Command, CHGMNU syntax diagram v Change Module (CHGMOD) Command, CHGMOD syntax diagram v Change Mode Description (CHGMODD) Command, CHGMODD syntax diagram v Change Message Description (CHGMSGD) Command, CHGMSGD syntax diagram v Change Message File (CHGMSGF) Command, CHGMSGF syntax diagram v Change Message Queue (CHGMSGQ) Command, CHGMSGQ syntax diagram v Change Nickname (CHGNCK) Command, CHGNCK syntax diagram v Change NetWare Authentication Entry (CHGNTWAUTE) CommandCHGNTWAUTE syntax diagram v Change NetWare Volume (CHGNTWVOL) CommandCHGNTWVOL syntax diagram v Change Network Attributes (CHGNETA) Command, CHGNETA syntax diagram v Change Network Job Entry (CHGNETJOBE) Command, CHGNETJOBE syntax diagram v Change Network File System Export (CHGNFSEXP) Command, CHGNFSEXP syntax diagram v Change Node Group Attributes (CHGNODGRPA) Command, CHGNODGRPA syntax diagram v Change NetBIOS Description (CHGNTBD) Command, CHGNTBD syntax diagram v Change Network Interface (ATM Network) (CHGNWIATM) Command, CHGNWIATM syntax diagram v Change Network Interface (Frame Relay Network) (CHGNWIFR) Command, CHGNWIFR syntax diagram v Change Network Interface Description for ISDN (CHGNWIISDN) Command, CHGNWIISDN syntax diagram
21
v Change Network Interface Description for T1 (CHGNWIT1) CommandCHGNWIT1 syntax diagram v Change Network Server Attributes (CHGNWSA) Command, CHGNWSA syntax diagram v Change Network Server Description (CHGNWSD) Command, CHGNWSD syntax diagram v Change Network Server User Attributes (CHGNWSUSRA) Command, CHGNWSUSRA syntax diagram v Change Object Auditing (CHGOBJAUD) Command, CHGOBJAUD syntax diagram v Change Object Description (CHGOBJD) Command, CHGOBJD syntax diagram v Change Object Owner (CHGOBJOWN) Command, CHGOBJOWN syntax diagram v Change Object Primary Group (CHGOBJPGP) Command, CHGOBJPGP syntax diagram v Change Optical Attributes (CHGOPTA) Command, CHGOPTA syntax diagram v Change Optical Volume (CHGOPTVOL) Command, CHGOPTVOL syntax diagram v Change Output Queue (CHGOUTQ) Command, CHGOUTQ syntax diagram v Change Owner (CHGOWN) Command, CHGOWN syntax diagram v Change Print Descriptor Group Profile (CHGPDGPRF) Command, CHGPDGPRF syntax diagram v Change Performance Explorer Definition (CHGPEXDFN) Command, CHGPEXDFN syntax diagram v Change Physical File (CHGPF) Command, CHGPF syntax diagram v Change Physical File Constraint (CHGPFCST) Command, CHGPFCST syntax diagram v Change Physical File Member (CHGPFM) Command, CHGPFM syntax diagram v Change Performance Collection (CHGPFRCOL) Command, CHGPFRCOL syntax diagram v Change Program (CHGPGM) Command, CHGPGM syntax diagram v Change Program Variable (CHGPGMVAR) Command, CHGPGMVAR syntax diagram v Change Primary Group (CHGPGP) Command, CHGPGP syntax diagram v Change Prestart Job (CHGPJ) Command, CHGPJ syntax diagram v Change Prestart Job Entry (CHGPJE) Command, CHGPJE syntax diagram v Change Problem (CHGPRB) Command, CHGPRB syntax diagram v Change Problem Action Entry (CHGPRBACNE) Command, CHGPRBACNE syntax diagram v Change Problem Selection Entry (CHGPRBSLTE) Command, CHGPRBSLTE syntax diagram v Change Profile (CHGPRF) Command, CHGPRF syntax diagram v Change Printer File (CHGPRTF) Command, CHGPRTF syntax diagram v Change Print Services Facility Configuration (CHGPSFCFG) Command, CHGPSFCFG syntax diagram v Change Pointer (CHGPTR) Command, CHGPTR syntax diagram v Change Password (CHGPWD) Command, CHGPWD syntax diagram
22
v Change Power On/Off Schedule (CHGPWRSCD) Command, CHGPWRSCD syntax diagram v Change Power On/Off Schedule Entry (CHGPWRSCDE) Command, CHGPWRSCDE syntax diagram v Change Query Attributes (CHGQRYA) Command, CHGQRYA syntax diagram v Change Question-and-Answer Database (CHGQSTDB) Command, CHGQSTDB syntax diagram v Change Recovery for Access Paths (CHGRCYAP) Command, CHGRCYAP syntax diagram v Change Relational Database Directory Entry (CHGRDBDIRE) Command, CHGRDBDIRE syntax diagram v Change Remote Definition (CHGRMTDFN) Command, CHGRMTDFN syntax diagram v Change Remote Journal (CHGRMTJRN) Command, CHGRMTJRN syntax diagram v Change Reply List Entry (CHGRPYLE) Command, CHGRPYLE syntax diagram v Change RouteD Attributes (CHGRTDA) Command, CHGRTDA syntax diagram v Change Routing Entry (CHGRTGE) Command, CHGRTGE syntax diagram v Change RWS Controller Password (CHGRWSPWD) Command, CHGRWSPWD syntax diagram v Change Save File (CHGSAVF) Command, chgsavf syntax diagram v Change Subsystem Description (CHGSBSD) Command, CHGSBSD syntax diagram v Change Search Index (CHGSCHIDX) Command, CHGSCHIDX syntax diagram v Change Security Attributes (CHGSECA) Command, CHGSECA syntax diagram v Change Security Auditing Values (CHGSECAUD) Command, CHGSECAUD syntax diagram v Change Shared Storage Pool (CHGSHRPOOL) Command, CHGSHRPOOL syntax diagram v Change SNA over IPX Location (CHGSNILOC) Command, CHGSNILOC syntax diagram v Change SNMP Attributes (CHGSNMPA) Command, CHGSNMPA syntax diagram v Change Spooled File Attributes (CHGSPLFA) Command, CHGSPLFA syntax diagram v Change Source Physical File (CHGSRCPF) Command, CHGSRCPF syntax diagram v Change Service Attributes (CHGSRVA) Command, CHGSRVA syntax diagram v Change Service Program (CHGSRVPGM) Command, CHGSRVPGM syntax diagram v Change Session Maximum (CHGSSNMAX) Command, CHGSSNMAX syntax diagram v Change Server Authentication Entry (CHGSVRAUTE) Command, CHGSVRAUTE syntax diagram v Change System Directory Attributes (CHGSYSDIRA) Command, CHGSYSDIRA syntax diagram v Change System Job (CHGSYSJOB) Command, CHGSYSJOB syntax diagram v Change System Library List (CHGSYSLIBL) Command, CHGSYSLIBL syntax diagram
23
v v v v v v v v
Change System Value (CHGSYSVAL) Command, CHGSYSVAL syntax diagram Change System/36 (CHGS36) Command, CHGS36 syntax diagram Change System/36 Attributes (CHGS36A) Command, CHGS36A syntax diagram Change System/36 Message List (CHGS36MSGL) Command, CHGS36MSGL syntax diagram Change System/36 Program Attributes (CHGS36PGMA) Command, CHGS36PGMA syntax diagram Change System/36 Procedure Attributes (CHGS36PRCA) Command, CHGS36PRCA syntax diagram Change System/36 Source Attributes (CHGS36SRCA) Command, CHGS36SRCA syntax diagram Change Tape Cartridge (CHGTAPCTG) Command, CHGTAPCTG syntax diagram
v Change Tape File (CHGTAPF) Command, CHGTAPF syntax diagram v Change TCP/IP Attributes (CHGTCPA) Command, CHGTCPA syntax diagram v Change TCP/IP Domain (CHGTCPDMN) Command, CHGTCPDMN syntax diagram v Change TCP/IP Host Table Entry) (CHGTCPHTE) Command, CHGTCPHTE syntax diagram v Change TCP/IP Interface (CHGTCPIFC) Command, CHGTCPIFC syntax diagram v Change TCP/IP Route (CHGTCPRTE) Command, CHGTCPRTE syntax diagram v Change TFTP Server Attributes (CHGTFTPA) Command, CHGTFTPA syntax diagram v Change Ultimedia System Facilities Device Entry (CHGUSFDEVE) Command, CHGUSFDEVE syntax diagram v Change User Audit (CHGUSRAUD) Command, CHGUSRAUD syntax diagram v Change User Print Information (CHGUSRPRTI) Command, CHGUSRPRTI syntax diagram v Change User Profile (CHGUSRPRF) Command, CHGUSRPRF syntax diagram v Change User Trace Buffer (CHGUSRTRC) Command, CHGUSRTRC syntax diagram v Change Variable (CHGVAR) Command, CHGVAR syntax diagram v Change Work Station Entry (CHGWSE) Command, CHGWSE syntax diagram v Change Writer (CHGWTR) Command, CHGWTR syntax diagram v Check Communications Trace (CHKCMNTRC) Command, CHKCMNTRC syntax diagram v Check Diskette (CHKDKT) Command, CHKDKT syntax diagram v Check Document Library Object (CHKDLO) Command, CHKDLO syntax diagram v Check DBCS Font Table (CHKIGCTBL) Command, CHKIGCTBL syntax diagram v Check In (CHKIN) Command, CHKIN syntax diagram v v v v v v Check Check Check Check Check Check Object (CHKOBJ) Command, CHKOBJ syntax diagram Object Integrity (CHKOBJITG) Command, CHKOBJITG syntax diagram Out (CHKOUT) Command, CHKOUT syntax diagram Product Option (CHKPRDOPT) Command, CHKPRDOPT syntax diagram Password (CHKPWD) Command, CHKPWD syntax diagram Record Locks (CHKRCDLCK) Command, CHKRCDLCK syntax diagram
24
v v v v v v v v v v v v
Check Tape (CHKTAP) Command, CHKTAP syntax diagram Close File (CLOF) Command, CLOF syntax diagram Clear Diskette (CLRDKT) Command, CLRDKT syntax diagram Clear Job Queue (CLRJOBQ) Command, CLRJOBQ syntax diagram Clear Library (CLRLIB) Command, CLRLIB syntax diagram
Clear Message Queue (CLRMSGQ) Command, CLRMSGQ syntax diagram Clear Output Queue (CLROUTQ) Command, CLROUTQ syntax diagram Clear Physical File Member (CLRPFM) Command, CLRPFM syntax diagram Clear Pool (CLRPOOL) Command, CLRPOOL syntax diagram Clear Save File (CLRSAVF) Command, CLRSAVF syntax diagram Clear Trace Data (CLRTRCDTA) Command, CLRTRCDTA syntax diagram Compare Journal Images (CMPJRNIMG) Command, CMPJRNIMG syntax diagram v Commit (COMMIT) Command, COMMIT syntax diagram v Convert CL Source (CVTCLSRC) Command, CVTCLSRC syntax diagram v Configure Device Media Library (CFGDEVMLB) Command, CFGDEVMLB syntax diagram v Configure Distribution Services (CFGDSTSRV) Command, CFGDSTSRV syntax diagram v Configure IP over IPX (CFGIPI) Command, CFGIPI syntax diagram v Configure IP over SNA Interface (CFGIPS) Command, CFGIPS syntax diagram v Configure IPX (CFGIPX) Command, CFGIPX syntax diagram v Configure System Security (CFGSYSSEC) Command, CFGSYSSEC syntax diagram v Configure TCP/IP (CFGTCP) Command, CFGTCP syntax diagram v Configure diagram v Configure v Configure diagram v Configure diagram v Configure diagram TCP/IP Applications (CFGTCPAPP) Command, CFGTCPAPP syntax TCP/IP BOOTP (CFGTCPBP) Command, CFGTCPBP syntax diagram Point-to-Point TCP/IP (CFGTCPPTP) Command, CFGTCPPTP syntax TCP/IP RouteD (CFGTCPRTD) Command, CFGTCPRTD syntax TCP/IP SNMP (CFGTCPSNMP) Command, CFGTCPSNMP syntax
v Convert Date (CVTDAT) Command, CVTDAT syntax diagram v Convert Document Library Services Name (CVTDLSNAM) Command, CVTDLSNAM syntax diagram v Convert Education (CVTEDU) Command, CVTEDU syntax diagram v Convert IP over SNA Interface (CVTIPSIFC) Command, CVTIPSIFC syntax diagram v Convert IP over SNA Location Entry (CVTIPSLOC) Command, CVTIPSLOC syntax diagram v Convert Optical Backup (CVTOPTBKU) Command, CVTOPTBKU syntax diagram v Convert Performance Data (CVTPFRDTA) Command, CVTPFRDTA syntax diagram v Convert Performance Thread Data (CVTPFRTHD) Command, CVTPFRTHD syntax diagram
25
v Convert RPC Source (CVTRPCSRC) Command, CVTRPCSRC syntax diagram v Convert TCP/IP CL Source (CVTTCPCL) Command, CVTTCPCL syntax diagram v Copy (COPY) Command, COPY syntax diagram v COPYRIGHT (COPYRIGHT) Command, COPYRIGHT syntax diagram v Compress Object (CPROBJ) Command, CPROBJ syntax diagram v Copy (CPY) Command, CPY syntax diagram v Copy Configuration List (CPYCFGL) Command, CPYCFGL syntax diagram v v v v v v v v v v v v v v Copy Document (CPYDOC) Command, CPYDOC syntax diagram Copy File (CPYF) Command, CPYF syntax diagram Copy From Directory (CPYFRMDIR) Command, CPYFRMDIR syntax diagram Copy from Diskette (CPYFRMDKT) Command, CPYFRMDKT syntax diagram Copy From Import File (CPYFRMIMPF) Command, CPYFRMIMPF syntax diagram Copy From PCF File (CPYFRMPCFF) Command, CPYFRMPCFF syntax diagram Copy From Query File (CPYFRMQRYF) Command, CPYFRMQRYF syntax diagram Copy from Stream File (CPYFRMSTMF) Command, CPYFRMSTMF syntax diagram Copy from Tape (CPYFRMTAP) Command, CPYFRMTAP syntax diagram Copy DBCS Font Table (CPYIGCTBL) Command, CPYIGCTBL syntax diagram Copy Copy Copy Copy Library (CPYLIB) Command, CPYLIB syntax diagram Optical (CPYOPT) Command, CPYOPT syntax diagram Program Temporary Fix (CPYPTF) Command, CPYPTF syntax diagram Spooled File (CPYSPLF) Command, CPYSPLF syntax diagram
v Copy Source File (CPYSRCF) Command, CPYSRCF syntax diagram v Copy To Directory (CPYTODIR) Command, CPYTODIR syntax diagram v Copy to Diskette (CPYTODKT) Command, CPYTODKT syntax diagram v v v v v Copy To Import File (CPYTOIMPF) Command, CPYTOIMPF syntax diagram Copy To PCF File (CPYTOPCFF) Command, CPYTOPCFF syntax diagram Copy to Stream File (CPYTOSTMF) Command, CPYTOSTMF syntax diagram Copy to Tape (CPYTOTAP) Command, CPYTOTAP syntax diagram Create Alert Table (CRTALRTBL) Command, CRTALRTBL syntax diagram
v Create Authority Holder (CRTAUTHLR) Command, CRTAUTHLR syntax diagram v Create Authorization List (CRTAUTL) Command, CRTAUTL syntax diagram v Create Bound Control Language Program (CRTBNDCL) Command, CRTBNDCL syntax diagram v Create Binding Directory (CRTBNDDIR) Command, CRTBNDDIR syntax diagram v Create Configuration List (CRTCFGL) Command, CRTCFGL syntax diagram v Create Control Language Module (CRTCLMOD) Command, CRTCLMOD syntax diagram v Create Control Language Program (CRTCLPGM) Command, CRTCLPGM syntax diagram v Create Class (CRTCLS) Command, CRTCLS syntax diagram v Create Command (CRTCMD) Command, CRTCMD syntax diagram
26
v Create Connection List (CRTCNNL) Command, CRTCNNL syntax diagram v Create Class-of-Service Description (CRTCOSD) Command, CRTCOSD syntax diagram v Create Change Request Description (CRTCRQD) Command, CRTCRQD syntax diagram v Create Communications Side Information (CRTCSI) Command, CRTCSI syntax diagram v Create Controller Description (APPC) (CRTCTLAPPC) Command, CRTCTLAPPC syntax diagram v Create Controller Description (Async) (CRTCTLASC) Command, CRTCTLASC syntax diagram v Create Controller Description (BSC) (CRTCTLBSC) Command, CRTCTLBSC syntax diagram v Create Controller Description (Finance) (CRTCTLFNC) Command, CRTCTLFNC syntax diagram v Create Controller Description (SNA Host) (CRTCTLHOST) Command, CRTCTLHOST syntax diagram v Create Controller Description (Local Work Station) (CRTCTLLWS) Command, CRTCTLLWS syntax diagram v Create Controller Description (Network) (CRTCTLNET) Command, CRTCTLNET syntax diagram v Create Controller Description (Retail) (CRTCTLRTL) Command, CRTCTLRTL syntax diagram v CRTCTLRWS (Create Controller Description (Remote Work Station)), CRTCTLRWS syntax diagram v Create Controller Description (Tape) (CRTCTLTAP) Command, CRTCTLTAP syntax diagram v Create Controller Description (Virtual Work Station) (CRTCTLVWS) Command, CRTCTLVWS syntax diagram v Create Distributed Data Management File (CRTDDMF) Command, CRTDDMF syntax diagram v Create Device Description (APPC) (CRTDEVAPPC) Command, CRTDEVAPPC syntax diagram v Create Device Description (Async) (CRTDEVASC) Command, CRTDEVASC syntax diagram v Create Device Description (BSC) (CRTDEVBSC) Command, CRTDEVBSC syntax diagram v Create Device Description (Diskette) (CRTDEVDKT) Command, CRTDEVDKT syntax diagram v Create Device Description (Crypto) (CRTDEVCRP) Command, CRTDEVCRP syntax diagram v Create Device Description (Display) (CRTDEVDSP) Command, CRTDEVDSP syntax diagram v Create Device Description (Finance) (CRTDEVFNC) Command, CRTDEVFNC syntax diagram v Create Device Description (SNA Host) (CRTDEVHOST) Command, CRTDEVHOST syntax diagram v Create Device Description (Intrasystem) (CRTDEVINTR ) Command, CRTDEVINTR syntax diagram
27
v Create Device Description (Media Library) (CRTDEVMLB) Command, CRTDEVMLB syntax diagram v Create Device Description (Network) (CRTDEVNET) Command, CRTDEVNET syntax diagram v Create Device Description (Optical) (CRTDEVOPT) Command, CRTDEVOPT syntax diagram v Create Device Description (Printer) (CRTDEVPRT) Command, CRTDEVPRT syntax diagram v Create Device Description (Retail) (CRTDEVRTL) Command, CRTDEVRTL syntax diagram v Create Device Description (SNUF) (CRTDEVSNUF) Command, CRTDEVSNUF syntax diagram v Create Device Description (SNA Pass-Through) (CRTDEVSNPT) Command, CRTDEVSNPT syntax diagram v Create Device Description (Tape) (CRTDEVTAP) Command, CRTDEVTAP syntax diagram v Create Directory (CRTDIR) Command, CRTDIR syntax diagram v v v v v Create Create Create Create Create Diskette File (CRTDKTF) Command, CRTDKTF syntax diagram Document (CRTDOC) Command, CRTDOC syntax diagram Display File (CRTDSPF) Command, CRTDSPF syntax diagram Distribution List (CRTDSTL) Command, CRTDSTL syntax diagram Data Area (CRTDTAARA) Command, CRTDTAARA syntax diagram
v Create a Data Dictionary (CRTDTADCT) Command, CRTDTADCT syntax diagram v Create Data Queue (CRTDTAQ) Command, CRTDTAQ syntax diagram v Create Duplicate Object (CRTDUPOBJ) Command, CRTDUPOBJ syntax diagram v Create Edit Description (CRTEDTD) Command, CRTEDTD syntax diagram v Create Folder (CRTFLR) Command, CRTFLR syntax diagram v Create Font Table (CRTFNTTBL) Command, CRTFNTTBL syntax diagram v Create Font Resources (CRTFNTRSC) Command, CRTFNTRSC syntax diagram v Create Form Definition (CRTFORMDF) Command, CRTFORMDF syntax diagram v Create Filter (CRTFTR) Command, CRTFTR syntax diagram v Create Graphics Symbol Set (CRTGSS) Command, CRTGSS syntax diagram v Create Intersystem Communications Function File (CRTICFF) Command, CRTICFF syntax diagram v Create DBCS Conversion Dictionary (CRTIGCDCT) Command, CRTIGCDCT syntax diagram v Create IPX Description (CRTIPXD) Command, CRTIPXD syntax diagram v v v v v v v Create Job Description (CRTJOBD) Command, CRTJOBD syntax diagram Create Job Queue (CRTJOBQ) Command, CRTJOBQ syntax diagram Create Journal (CRTJRN) Command, CRTJRN syntax diagram Create Journal Receiver (CRTJRNRCV) Command, CRTJRNRCV syntax diagram Create Logical File (CRTLF) Command, CRTLF syntax diagram Create Library (CRTLIB) Command, CRTLIB syntax diagram Create Line Description (Async) (CRTLINASC) Command, CRTLINASC syntax diagram
28
v Create Line Description (BSC) (CRTLINBSC) Command, CRTLINBSC syntax diagram v Create Line Description (DDI Network) (CRTLINDDI) Command, CRTLINDDI syntax diagram v Create Line Description (Ethernet) (CRTLINETH) Command, CRTLINETH syntax diagram v Create Line Description (Fax) (CRTLINFAX) Command, CRTLINFAX syntax diagram v Create Line Description (Frame Relay Network) (CRTLINFR) Command, CRTLINFR syntax diagram v Create Line Description (IDLC) (CRTLINIDLC) Command, CRTLINIDLC syntax diagram v Create Line Description (Network) (CRTLINNET) Command, CRTLINNET syntax diagram v Create Line Description (SDLC) (CRTLINSDLC) Command, CRTLINSDLC syntax diagram v Create Line Description (TDLC) (CRTLINTDLC) Command, CRTLINTDLC syntax diagram v Create Line Description (Token-Ring Network) (CRTLINTRN) Command, CRTLINTRN syntax diagram v Create Line Description (Wireless) (CRTLINWLS) Command, CRTLINWLS syntax diagram v CRTLINX25 (Create Line Description (X.25)), CRTLINX25 syntax diagram v Create Locale (CRTLOCALE) Command, CRTLOCALE syntax diagram v Create Menu (CRTMNU) Command, CRTMNU syntax diagram v Create Mode Description (CRTMODD) Command, CRTMODD syntax diagram v Create Message File (CRTMSGF) Command, CRTMSGF syntax diagram v Create Message File Menu (CRTMSGFMNU) Command, CRTMSGFMNU syntax diagram v Create Message Queue (CRTMSGQ) Command, CRTMSGQ syntax diagram v Create Node Group (CRTNODGRP) Command, CRTNODGRP syntax diagram v Create Node List (CRTNODL) Command, CRTNODL syntax diagram v Create NetBIOS Description (CRTNTBD) Command, CRTNTBD syntax diagram v Create NetWare Volume (CRTNTWVOL) Command, CRTNTBD syntax diagram v Create Network Interface (ATM Network) (CRTNWIATM) Command, CRTNWIATM syntax diagram v Create Network Interface (Frame Relay Network) (CRTNWIFR) Command, CRTNWIFR syntax diagram v Create Network Interface Description for ISDN (CRTNWIISDN) Command, CRTNWIISDN syntax diagram v Create Network Interface Description for T1 (CRTNWIT1) Command Description, CRTNWIN1 syntax diagram v Create Network Server Description (CRTNWSD) Command, CRTNWSD syntax diagram v Create Network Server Storage Space (CRTNWSSTG) Command, CRTNWSSTG syntax diagram v Create Output Queue (CRTOUTQ) Command, CRTOUTQ syntax diagram v Create Overlay (CRTOVL) Command, CRTOVL syntax diagram
29
v v v v v
Create Page Definition (CRTPAGDFN) Command, CRTPAGDFN syntax diagram Create Page Segment (CRTPAGSEG) Command, CRTPAGSEG syntax diagram Create Print Descriptor Group (CRTPDG) Command, CRTPDG syntax diagram Create Physical File (CRTPF) Command, CRTPF syntax diagram Create Performance Data (CRTPFRDTA) Command, CRTPFRDTA syntax diagram v Create Program (CRTPGM) Command, CRTPGM syntax diagram v Create Panel Group (CRTPNLGRP) Command, CRTPNLGRP syntax diagram v Create Printer File (CRTPRTF) Command, CRTPRTF syntax diagram v Create Print Services Facility Configuration (CRTPSFCFG) Command, CRTPSFCFG syntax diagram v Create Query Management Form (CRTQMFORM) Command, CRTQMFORM syntax diagram v Create Query Management Query (CRTQMQRY) Command, CRTQMQRY syntax diagram v Create Question-and-Answer Database (CRTQSTDB) Command, CRTQSTDB syntax diagram v Create Question-and-Answer Load (CRTQSTLOD) Command, CRTQSTLOD syntax diagram v Create Save File (CRTSAVF) Command, CRTSAVF syntax diagram v Create Subsystem Description (CRTSBSD) Command, CRTSBSD syntax diagram v Create Search Index (CRTSCHIDX) Command, CRTSCHIDX syntax diagram v Create Spelling Aid Dictionary (CRTSPADCT) Command, CRTSPADCT syntax diagram v Create Structured Query Language Package (CRTSQLPKG) Command, CRTSQLPKG syntax diagram v Create Source Physical File (CRTSRCPF) Command, CRTSRCPF syntax diagram v Create Service Program (CRTSRVPGM) Command, CRTSRVPGM syntax diagram v Create System/36 Display File (CRTS36DSPF) Command, CRTS36DSPF syntax diagram v Create System/36 Menu (CRTS36MNU) Command, CRTS36MNU syntax diagram v Create System/36 Message File (CRTS36MSGF) Command, CRTS36MSGF syntax diagram v v v v Create Tape Category (CRTTAPCGY) Command, CRTTAPCGY syntax diagram Create Tape File (CRTTAPF) Command, CRTTAPF syntax diagram Create Table (CRTTBL) Command, CRTTBL syntax diagram Create User-Defined File System (CRTUDFS) Command, CRTUDFS syntax diagram v Create User Profile (CRTUSRPRF) Command, CRTUSRPRF syntax diagram v Create Validation List (CRTVLDL) Command, CRTVLDL syntax diagram v Create Work Station Customizing Object (CRTWSCST) Command, CRTWSCST syntax diagram D (Back to the top) v Data (DATA) Command, DATA syntax diagram v Declare CL Variable (DCL) Command, DCL syntax diagram
30
v v v v v
Declare File (DCLF) Command, DCLF syntax diagram Decompress Object (DCPOBJ) Command, DCPOBJ syntax diagram DEL (Remove Link) Command, DEL (Remove Link) syntax diagram Deallocate Object (DLCOBJ) Command, DLCOBJ syntax diagram Delete Alert (DLTALR) Command, DLTALR syntax diagram
v Delete Alert Table (DLTALRTBL) Command, DLTALRTBL syntax diagram v Delete APAR Data (DLTAPARDTA) Command, DLTAPARDTA syntax diagram v Delete Authority Holder (DLTAUTHLR) Command, DLTAUTHLR syntax diagram v Delete Authorization List (DLTAUTL) Command, DLTAUTL syntax diagram v Delete Binding Directory (DLTBNDDIR) Command, DLTBNDDIR syntax diagram v Delete Configuration List (DLTCFGL) Command, DLTCFGL syntax diagram v Delete Class (DLTCLS) Command, DLTCLS syntax diagram v Delete Command (DLTCMD) Command, DLTCMD syntax diagram v Delete Communications Trace (DLTCMNTRC) Command, DLTCMNTRC syntax diagram v Delete Connection List (DLTCNNL) Command, DLTCNNL syntax diagram v Delete Class-of-Service Description (DLTCOSD) Command, DLTCOSD syntax diagram v Delete Change Request Description (DLTCRQD) Command, DLTCRQD syntax diagram v Delete Communications Side Information (DLTCSI) Command, DLTCSI syntax diagram v v v v v v v v Delete Delete Delete Delete Delete Delete Delete Delete Controller Description (DLTCTLD) Command, DLTCTLD syntax diagram Device Description (DLTDEVD) Command, DLTDEVD syntax diagram Diskette Label (DLTDKTLBL) Command, DLTDKTLBL syntax diagram Document Library Object (DLTDLO) Command, DLTDLO syntax diagram Document List (DLTDOCL) Command, DLTDOCL syntax diagram Distribution (DLTDST) Command, DLTDST syntax diagram Distribution List (DLTDSTL) Command, DLTDSTL syntax diagram Data Area (DLTDTAARA) Command, DLTDTAARA syntax diagram
v Delete Data Dictionary (DLTDTADCT) Command, DLTDTADCT syntax diagram v Delete Data Queue (DLTDTAQ) Command, DLTDTAQ syntax diagram v Delete Edit Description (DLTEDTD) Command, DLTEDTD syntax diagram v Delete File (DLTF) Command, DLTF syntax diagram v v v v v Delete Delete Delete Delete Delete Font Table (DLTFNTTBL) Command, DLTFNTTBL syntax diagram Font Resources (DLTFNTRSC) Command, DLTFNTRSC syntax diagram Form Definition (DLTFORMDF) Command, DLTFORMDF syntax diagram Filter (DLTFTR) Command, DLTFTR syntax diagram Graphics Symbol Set (DLTGSS) Command, DLTGSS syntax diagram
v Delete DBCS Conversion Dictionary (DLTIGCDCT) Command, DLTIGCDCT syntax diagram v Delete DBCS Font Table (DLTIGCTBL) Command, DLTIGCTBL syntax diagram v Delete IPX Description (DLTIPXD) Command, DLTIPXD syntax diagram v Delete Job Description (DLTJOBD) Command, DLTJOBD syntax diagram
31
v v v v v
Delete Job Queue (DLTJOBQ) Command, DLTJOBQ syntax diagram Delete Journal (DLTJRN) Command, DLTJRN syntax diagram Delete Journal Receiver (DLTJRNRCV) Command, DLTJRNRCV syntax diagram Delete Library (DLTLIB) Command, DLTLIB syntax diagram Delete Licensed Program (DLTLICPGM) Command, DLTLICPGM syntax diagram v Delete Line Description (DLTLIND) Command, DLTLIND syntax diagram v Delete Locale (DLTLOCALE) Command, DLTLOCALE syntax diagram v v v v v v v Delete Delete Delete Delete Delete Delete Delete Menu (DLTMNU) Command, DLTMNU syntax diagram Module (DLTMOD) Command, DLTMOD syntax diagram Mode Description (DLTMODD) Command, DLTMODD syntax diagram Message File (DLTMSGF) Command, DLTMSGF syntax diagram Message Queue (DLTMSGQ) Command, DLTMSGQ syntax diagram Network File (DLTNETF) Command, DLTNETF syntax diagram Node Group (DLTNODGRP) Command, DLTNODGRP syntax diagram
v Delete Node List (DLTNODL) Command, DLTNODL syntax diagram v Delete NetBIOS Description (DLTNTBD) Command, DLTNTBD syntax diagram v Delete Network Interface Description (DLTNWID) Command, DLTNWID syntax diagram v Delete Network Server Application (DLTNWSAPP) Command, DLTNWSAPP syntax diagram v Delete Network Server Description (DLTNWSD) Command, DLTNWSD syntax diagram v Delete Network Server Storage Space (DLTNWSSTG) Command, DLTNWSSTG syntax diagram v Delete Output Queue (DLTOUTQ) Command, DLTOUTQ syntax diagram v Delete Overlay (DLTOVL) Command, DLTOVL syntax diagram v Delete Override (DLTOVR) Command, DLTOVR syntax diagram v Delete Override Device Entry (DLTOVRDEVE) Command, DLTOVRDEVE syntax diagram v Delete Page Definition (DLTPAGDFN) Command, DLTPAGDFN syntax diagram v Delete Page Segment (DLTPAGSEG) Command, DLTPAGSEG syntax diagram v Delete Print Descriptor Group (DLTPDG) Command, DLTPDG syntax diagram v Delete Performance Explorer Data (DLTPEXDTA) Command, DLTPEXDTA syntax diagram v Delete Program (DLTPGM) Command, DLTPGM syntax diagram v Delete Panel Group (DLTPNLGRP) Command, DLTPNLGRP syntax diagram v Delete Problem (DLTPRB) Command, DLTPRB syntax diagram v Delete Print Services Facility Configuration (DLTPSFCFG) Command, DLTPSFCFG syntax diagram v Delete PTF (DLTPTF) Command, DLTPTF syntax diagram v Delete Query Management Form (DLTQMFORM) Command, DLTQMFORM syntax diagram v Delete Query Management Query (DLTQMQRY) Command, DLTQMQRY syntax diagram v Delete Query (DLTQRY) Command, DLTQRY syntax diagram v Delete Question (DLTQST) Command, DLTQST syntax diagram
32
v Delete Question-and-Answer Database (DLTQSTDB) Command, DLTQSTDB syntax diagram v Delete Subsystem Description (DLTSBSD) Command, DLTSBSD syntax diagram v Delete Search Index (DLTSCHIDX) Command, DLTSCHIDX syntax diagram v Delete Spelling Aid Dictionary (DLTSPADCT) Command, DLTSPADCT syntax diagram v Delete Spooled File (DLTSPLF) Command, DLTSPLF syntax diagram v Delete Structured Query Language Package (DLTSQLPKG) Command, DLTSQLPKG syntax diagram v Delete Service Program (DLTSRVPGM) Command, DLTSRVPGM syntax diagram v Delete Tape Category (DLTTAPCGY) Command, DLTTAPCGY syntax diagram v Delete Table (DLTTBL) Command, DLTTBL syntax diagram v Delete User-Defined File System (DLTUDFS) Command, DLTUDFS syntax diagram v Delete User Index (DLTUSRIDX) Command, DLTUSRIDX syntax diagram v Delete User Profile (DLTUSRPRF) Command, DLTUSRPRF syntax diagram v Delete User Queue (DLTUSRQ) Command, DLTUSRQ syntax diagram v Delete User Space (DLTUSRSPC) Command, DLTUSRSPC syntax diagram v Delete User Trace Buffer (DLTUSRTRC) Command, DLTUSRTRC syntax diagram v Delete Validation List (DLTVLDL) Command, DLTVLDL syntax diagram v Delete Work Station Customizing Object (DLTWSCST) Command, DLTWSCST syntax diagram v Delay Job (DLYJOB) Command, DLYJOB syntax diagram v Dump (DMP) Command, DMP syntax diagram v Dump Control Language Program (DMPCLPGM) Command, DMPCLPGM syntax diagram v Dump Document Library Object (DMPDLO) Command, DMPDLO syntax diagram v Dump Job (DMPJOB) Command, DMPJOB syntax diagram v v v v v v Dump Job Internal (DMPJOBINT) Command, DMPJOBINT syntax diagram Dump Object (DMPOBJ) Command, DMPOBJ syntax diagram Dump System Object (DMPSYSOBJ) Command, DMPSYSOBJ syntax diagram Dump Tape (DMPTAP) Command, DMPTAP syntax diagram Dump Trace (DMPTRC) Command, DMPTRC syntax diagram Dump User Trace Buffer (DMPUSRTRC) Command, DMPUSRTRC syntax diagram v Do (DO) Command, DO syntax diagram v Disconnect Job (DSCJOB) Command, DSCJOB syntax diagram v Display Access Code (DSPACC) Command, DSPACC syntax diagram v Display Access Code Authority (DSPACCAUT) Command, DSPACCAUT syntax diagram v Display Active Prestart Jobs (DSPACTPJ) Command, DSPACTPJ syntax diagram v Display Active Profile List (DSPACTPRFL) Command, DSPACTPRFL syntax diagram v Display Activation Schedule (DSPACTSCD) Command, DSPACTSCD syntax diagram
33
v Display APPN Information (DSPAPPNINF) Command, DSPAPPNINF syntax diagram v Display Audit Journal Entries (DSPAUDJRNE) Command, DSPAUDJRNE syntax diagram v Display Authority (DSPAUT) Command, DSPAUT syntax diagram v Display Authority Holder (DSPAUTHLR) Command, DSPAUTHLR syntax diagram v Display Authorization List (DSPAUTL) Command, DSPAUTL syntax diagram v Display Authorization List Document Library Objects (DSPAUTLDLO) Command, DSPAUTLDLO syntax diagram v Display Authorization List Objects (DSPAUTLOBJ) Command, DSPAUTLOBJ syntax diagram v Display Authorized Users (DSPAUTUSR) Command, DSPAUTUSR syntax diagram v Display Backup Status (DSPBCKSTS) Command, DSPBCKSTS syntax diagram v Display Backup Options (DSPBCKUP) Command, DSPBCKUP syntax diagram v Display Backup List (DSPBCKUPL) Command, DSPBCKUPL syntax diagram v Display Breakpoints (DSPBKP) Command, DSPBKP syntax diagram v Display Binding Directory (DSPBNDDIR) Command, DSPBNDDIR syntax diagram v Display Circuit Route (DSPCCTRTE) Command, DSPCCTRTE syntax diagram v Display Circuit Service (DSPCCTSRV) Command, DSPCCTSRV syntax diagram v v v v Display Display Display Display Coded Font (DSPCDEFNT) Command, DSPCDEFNT syntax diagram Configuration List (DSPCFGL) Command, DSPCFGL syntax diagram Class (DSPCLS) Command, DSPCLS syntax diagram Command (DSPCMD) Command, DSPCMD syntax diagram
v Display Connection List (DSPCNNL) Command, DSPCNNL syntax diagram v Display Connection Status (DSPCNNSTS) Command, DSPCNNSTS syntax diagram v Display Class-of-Service Description (DSPCOSD) Command, DSPCOSD syntax diagram v Display Check Pending Constraint (DSPCPCST) Command, DSPCPCST syntax diagram v Display Communications Side Information (DSPCSI) Command, DSPCSI syntax diagram v Display Controller Description (DSPCTLD) Command, DSPCTLD syntax diagram v Display Current Directory (DSPCURDIR) Command, DSPCURDIR syntax diagram v Display Debug (DSPDBG) Command, DSPDBG syntax diagram v Display Debug Watches (DSPDBGWCH) Command, DSPDBGWCH syntax diagram v Display Database Relations (DSPDBR) Command, DSPDBR syntax diagram v Display Distributed Data Management File (DSPDDMF) Command, DSPDDMF syntax diagram v Display Device Description (DSPDEVD) Command, DSPDEVD syntax diagram v Display Directory Entries (DSPDIRE) Command, DSPDIRE syntax diagram v Display Diskette (DSPDKT) Command, DSPDKT syntax diagram
34
v Display Document Library Object Audit (DSPDLOAUD) Command, DSPDLOAUD syntax diagram v Display Document Library Object Authority (DSPDLOAUT) Command, DSPDLOAUT syntax diagram v Display Document Library Object Name (DSPDLONAM) Command, DSPDLONAM syntax diagram v Display Document (DSPDOC) Command, DSPDOC syntax diagram v Display Distribution List (DSPDSTL) Command, DSPDSTL syntax diagram v Display Distribution Log (DSPDSTLOG) Command, DSPDSTLOG syntax diagram v Display Distribution Services (DSPDSTSRV) Command, DSPDSTSRV syntax diagram v Display Data Area (DSPDTAARA) Command, DSPDTAARA syntax diagram v Display Data Dictionary (DSPDTADCT) Command, DSPDTADCT syntax diagram v Display Edit Description (DSPEDTD) Command, DSPEDTD syntax diagram v Display Extended Wireless Controller Bar Code Entry (DSPEWCBCDE) Command, DSPEWCBCDE syntax diagram v Display Extended Wireless Controller Member (DSPEWCM) Command, DSPEWCM syntax diagram v Display Extended Wireless Controller PTC Entry (DSPEWCPTCE) Command, DSPEWCPTCE syntax diagram v Display Extended Wireless Line Member (DSPEWLM) Command, DSPEWLM syntax diagram v Display Expiration Schedule (DSPEXPSCD) Command, DSPEXPSCD syntax diagram v Display File Description (DSPFD) Command, DSPFD syntax diagram v Display File Field Description (DSPFFD) Command, DSPFFD syntax diagram v Display Folder (DSPFLR) Command, DSPFLR syntax diagram v Display Font Table (DSPFNTTBL) Command, DSPFNTTBL syntax diagram v Display Font Resource Attributes (DSPFNTRSCA) Command, DSPFNTRSCA syntax diagram v Display Hardware Resources (DSPHDWRSC) Command, DSPHDWRSC syntax diagram v Display Hierarchical File Systems (DSPHFS) Command, DSPHFS syntax diagram v Display Help Document (DSPHLPDOC) Command, DSPHLPDOC syntax diagram v Display DBCS Conversion Dictionary (DSPIGCDCT) Command, DSPIGCDCT syntax diagram v Display IPL Attributes (DSPIPLA) Command, DSPIPLA syntax diagram v Display IPX Circuit (DSPIPXCCT) Command, DSPIPXCCT syntax diagram v Display IPX Description (DSPIPXD) Command, DSPIPXD syntax diagram v Display Job (DSPJOB) Command, DSPJOB syntax diagram v v v v Display Display Display Display Job Description (DSPJOBD) Command, DSPJOBD syntax diagram Job Log (DSPJOBLOG) Command, DSPJOBLOG syntax diagram Job Tables (DSPJOBTBL) Command, DSPJOBTBL syntax diagram Journal (DSPJRN) Command, DSPJRN syntax diagram
35
v Display Journal Receiver Attributes (DSPJRNRCVA) Command, DSPJRNRCVA syntax diagram v Display Keyboard Map (DSPKBDMAP) Command, DSPKBDMAP syntax diagram v Display Local Area Network Adapter Profile (DSPLANADPP) Command, DSPLANADPP syntax diagram v Display LAN Media Library (DSPLANMLB) Command, DSPLANMLB syntax diagram v Display Local Area Network Status (DSPLANSTS) Command, DSPLANSTS syntax diagram v Display Library (DSPLIB) Command, DSPLIB syntax diagram v Display Library Description (DSPLIBD) Command, DSPLIBD syntax diagram v Display Library List (DSPLIBL) Command, DSPLIBL syntax diagram v Display License Key Information (DSPLICKEY) Command, DSPLICKEY syntax diagram v Display Line Description (DSPLIND) Command, DSPLIND syntax diagram v Display Object Links (DSPLNK) Command, DSPLNK syntax diagram v Display Log (DSPLOG) Command, DSPLOG syntax diagram v Display Mounted File System Information (DSPMFSINF) Command, DSPMFSINF syntax diagram v Display Menu Attributes (DSPMNUA) Command, DSPMNUA syntax diagram v Display Module (DSPMOD) Command, DSPMOD syntax diagram v Display Mode Description (DSPMODD) Command, DSPMODD syntax diagram v Display Module Source (DSPMODSRC) Command, DSPMODSRC syntax diagram v Display Mode Status (DSPMODSTS) Command, DSPMODSTS syntax diagram v Display Messages (DSPMSG) Command, DSPMSG syntax diagram v Display Message Descriptions (DSPMSGD) Command, DSPMSGD syntax diagram v Display Nickname (DSPNCK) Command, DSPNCK syntax diagram v Display Network Attributes (DSPNETA) Command, DSPNETA syntax diagram v Display Node Group (DSPNODGRP) Command, DSPNODGRP syntax diagram v Display NetBIOS Description (DSPNTBD) Command, DSPNTBD syntax diagram v Display Network Interface Description (DSPNWID) Command, DSPNWID syntax diagram v Display Network Server Attributes (DSPNWSA) Command, DSPNWSA syntax diagram v Display Network Server Description (DSPNWSD) Command, DSPNWSD syntax diagram v Display Network Server Storage Space (DSPNWSSTG) Command, DSPNWSSTG syntax diagram v Display Network Server Users (DSPNWSUSR) Command, DSPNWSUSR syntax diagram v Display Network Server User Attributes (DSPNWSUSRA) Command, DSPNWSUSRA syntax diagram v Display Object Authority (DSPOBJAUT) Command, DSPOBJAUT syntax diagram v Display Object Description (DSPOBJD) Command, DSPOBJD syntax diagram
36
v Display OptiConnect Link Status (DSPOPCLNK) Command, DSPOPCLNK syntax diagram v Display Optical (DSPOPT) Command, DSPOPT syntax diagram v Display Optical Locks (DSPOPTLCK) Command, DSPOPTLCK syntax diagram v Display Optical Server (DSPOPTSVR) Command, DSPOPTSVR syntax diagram v Display Override (DSPOVR) Command, DSPOVR syntax diagram v Display Print Descriptor Group Profile (DSPPDGPRF) Command, DSPPDGPRF syntax diagram v Display Physical File Member (DSPPFM) Command, DSPPFM syntax diagram v Display Program (DSPPGM) Command, DSPPGM syntax diagram v Display Programs that Adopt (DSPPGMADP) Command, DSPPGMADP syntax diagram v Display Program References (DSPPGMREF) Command, DSPPGMREF syntax diagram v Display Program Variable (DSPPGMVAR) Command, DSPPGMVAR syntax diagram v Display Problem (DSPPRB) Command, DSPPRB syntax diagram v Display Print Services Facility Configuration (DSPPSFCFG) Command, DSPPSFCFG syntax diagram v Display Program Temporary Fix (DSPPTF) Command, DSPPTF syntax diagram v Display Power On/Off Schedule (DSPPWRSCD) Command, DSPPWRSCD syntax diagram v Display Record Locks (DSPRCDLCK) Command, DSPRCDLCK syntax diagram v Display Recovery for Access Paths (DSPRCYAP) Command, DSPRCYAP syntax diagram v Display Relational Database Directory Entry (DSPRDBDIRE) Command, DSPRDBDIRE syntax diagram v Display Remote Definition (DSPRMTDFN) Command, DSPRMTDFN syntax diagram v Display Save File (DSPSAVF) Command, DSPSAVF syntax diagram v Display Subsystem Description (DSPSBSD) Command, DSPSBSD syntax diagram v Display Security Attributes (DSPSECA) Command, DSPSECA syntax diagram v Display Security Auditing Values (DSPSECAUD) Command, DSPSECAUD syntax diagram v Display Software Resources (DSPSFWRSC) Command, DSPSFWRSC syntax diagram v Display Sphere of Control Status (DSPSOCSTS) Command, DSPSOCSTS syntax diagram v Display Spooled File (DSPSPLF) Command, DSPSPLF syntax diagram v Display Service Attributes (DSPSRVA) Command, DSPSRVA syntax diagram v Display Service Program (DSPSRVPGM) Command, DSPSRVPGM syntax diagram v v v v v v Display Display Display Display Display Display Service Status (DSPSRVSTS) Command, DSPSRVSTS syntax diagram System Status (DSPSYSSTS) Command, DSPSYSSTS syntax diagram System Value (DSPSYSVAL) Command, DSPSYSVAL syntax diagram System/36 (DSPS36) Command, DSPS36 syntax diagram Tape (DSPTAP) Command, DSPTAP syntax diagram Tape Category (DSPTAPCGY) Command, DSPTAPCGY syntax diagram
37
v v v v v
Display Display Display Display Display
Tape Cartridge (DSPTAPCTG) Command, DSPTAPCTG syntax diagram Tape Status (DSPTAPSTS) Command, DSPTAPSTS syntax diagram Trace (DSPTRC) Command, DSPTRC syntax diagram Trace Data (DSPTRCDTA) Command, DSPTRCDTA syntax diagram Trademarks (DSPTM) Command, DSPTM syntax diagram
v Display User-Defined File System (DSPUDFS) Command, DSPUDFS syntax diagram v Display User Permission (DSPUSRPMN) Command, DSPUSRPMN syntax diagram v Display User Profile (DSPUSRPRF) Command, DSPUSRPRF syntax diagram v Display User Print Information (DSPUSRPRTI) Command, DSPUSRPRTI syntax diagram v Display Work Station User (DSPWSUSR) Command, DSPWSUSR syntax diagram v Duplicate Diskette (DUPDKT) Command, DUPDKT syntax diagram v Duplicate Optical (DUPOPT) Command, DUPOPT syntax diagram v Duplicate Tape (DUPTAP) Command, DUPTAP syntax diagram E (Back to the top) v Edit Authorization List (EDTAUTL) Command, EDTAUTL syntax diagram v Edit Backup List (EDTBCKUPL) Command, EDTBCKUPL syntax diagram v Edit Check Pending Constraints (EDTCPCST) Command, EDTCPCST syntax diagram v Edit Document Library Object Authority (EDTDLOAUT) Command, EDTDLOAUT syntax diagram v Edit Document (EDTDOC) Command, EDTDOC syntax diagram v Edit DBCS Conversion Dictionary (EDTIGCDCT) Command, EDTIGCDCT syntax diagram v Edit Library List (EDTLIBL) Command, EDTLIBL syntax diagram v Edit Object Authority (EDTOBJAUT) Command, EDTOBJAUT syntax diagram v Edit Questions and Answers (EDTQST) Command, EDTQST syntax diagram v Edit Rebuild of Access Paths (EDTRBDAP) Command, EDTRBDAP syntax diagram v Edit Recovery for Access Paths (EDTRCYAP) Command, EDTRCYAP syntax diagram v Edit System/36 Program Attributes (EDTS36PGMA) Command, EDTS36PGMA syntax diagram v Edit System/36 Procedure Attributes (EDTS36PRCA) Command, EDTS36PRCA syntax diagram v Edit System/36 Source Attributes (EDTS36SRCA) Command, EDTS36SRCA syntax diagram v Edit Workstation Object Authority (EDTWSOAUT) Command, EDTWSOAUT syntax diagram v v v v v Eject Emulation Output (EJTEMLOUT) Command, EJTEMLOUT syntax diagram Else (ELSE) Command, ELSE syntax diagram Emulate Printer Key (EMLPRTKEY) Command, EMLPRTKEY syntax diagram End Batch Job (ENDBCHJOB) Command, ENDBCHJOB syntax diagram End Cleanup (ENDCLNUP) Command, ENDCLNUP syntax diagram
38
v End Communications Server (ENDCMNSVR) Command, ENDCMNSVR syntax diagram v End Communications Trace (ENDCMNTRC) Command, ENDCMNTRC syntax diagram v End Commitment Control (ENDCMTCTL) Command, ENDCMTCTL syntax diagram v End Copy Screen (ENDCPYSCN) Command, ENDCPYSCN syntax diagram v End Controller Recovery (ENDCTLRCY) Command, ENDCTLRCY syntax diagram v End Debug (ENDDBG) Command, ENDDBG syntax diagram v v v v v v v v v v End Debug Server (ENDDBGSVR) Command, ENDDBGSVR syntax diagram End Database Monitor (ENDDBMON) Command, ENDDBMON syntax diagram End Device Recovery (ENDDEVRCY) Command, ENDDEVRCY syntax diagram End Directory Shadowing (ENDDIRSHD) Command, ENDDIRSHD syntax diagram End Do (ENDDO) Command, ENDDO syntax diagram End Disk Reorganization (ENDDSKRGZ) Command, ENDDSKRGZ syntax diagram End Group Job (ENDGRPJOB) Command, ENDGRPJOB syntax diagram End Host Server (ENDHOSTSVR) Command, ENDHOSTSVR syntax diagram End Input (ENDINP) Command, ENDINP syntax diagram End IP over IPX Interface (ENDIPIIFC) Command, ENDIPIIFC syntax diagram
v End IP over SNA Interface (ENDIPSIFC) Command, ENDIPSIFC syntax diagram v End IPX (ENDIPX) Command, ENDIPX syntax diagram v End IPX Circuit (ENDIPXCCT) Command, ENDIPXCCT syntax diagram v End Job (ENDJOB) Command, ENDJOB syntax diagram v End Job Abnormal (ENDJOBABN) Command, ENDJOBABN syntax diagram v v v v v v v v v v v End Journal Access Path (ENDJRNAP) Command, ENDJRNAP syntax diagram End Journal Physical File (ENDJRNPF) Command, ENDJRNPF syntax diagram End Line Recovery (ENDLINRCY) Command, ENDLINRCY syntax diagram End Mode (ENDMOD) Command, ENDMOD syntax diagram End Mail Server Framework (ENDMSF) Command, ENDMSF syntax diagram End Network File System Server (ENDNFSSVR) Command, ENDNFSSVR syntax diagram End Network Interface Recovery (ENDNWIRCY) Command, ENDNWIRCY syntax diagram End Network Server Application (ENDNWSAPP) Command, ENDNWSAPP syntax diagram End Pass-Through (ENDPASTHR) Command, ENDPASTHR syntax diagram End Performance Explorer (ENDPEX) Command, ENDPEX syntax diagram End Performance Collection (ENDPFRCOL) Command, ENDPFRCOL syntax diagram
v End Performance Monitor (ENDPFRMON) Command, ENDPFRMON syntax diagram v End Program (ENDPGM) Command, ENDPGM syntax diagram v End Program Profiling (ENDPGMPRF) Command, ENDPGMPRF syntax diagram
39
v v v v v v v v v v v v v v v v v v
End End End End End
Prestart Jobs (ENDPJ) Command, ENDPJ syntax diagram Printer Emulation (ENDPRTEML) Command, ENDPRTEML syntax diagram Receive (ENDRCV) Command, ENDRCV syntax diagram Reader (ENDRDR) Command, ENDRDR syntax diagram Remote Support (ENDRMTSPT) Command, ENDRMTSPT syntax diagram
End Request (ENDRQS) Command, ENDRQS syntax diagram End Subsystem (ENDSBS) Command, ENDSBS syntax diagram End Service Job (ENDSRVJOB) Command, ENDSRVJOB syntax diagram End System (ENDSYS) Command, ENDSYS syntax diagram End System/36 (ENDS36) Command, ENDS36 syntax diagram End TCP/IP (ENDTCP) Command, ENDTCP syntax diagram End TCP/IP Connection (ENDTCPCNN) Command, ENDTCPCNN syntax diagram End TCP/IP Interface (ENDTCPIFC) Command, ENDTCPIFC syntax diagram End Point-to-Point TCP/IP (ENDTCPPTP) Command, ENDTCPPTP syntax diagram End TCP/IP Server (ENDTCPSVR) Command, ENDTCPSVR syntax diagram End Technical Information Exchange Session (ENDTIESSN) Command, ENDTIESSN syntax diagram End Trap Manager (ENDTRPMGR) Command, ENDTRPMGR syntax diagram End Ultimedia System Facilities (ENDUSF) Command, ENDUSF syntax diagram
v End Writer (ENDWTR) Command, ENDWTR syntax diagram v Remove Link (ERASE) Command, ERASE syntax diagram v Change Network File System Export (EXPORTFS) Command, EXPORTFS syntax diagram F (Back to the top) v File Document (FILDOC) Command, FILDOC syntax diagram G (Back to the top) v Merge Message Catalog (GENCAT) Command, GENCAT syntax diagram v Go to Menu (GO) Command, GO syntax diagram v Go To (GOTO) Command, GOTO syntax diagram v Grant Access Code Authority (GRTACCAUT) Command, GRTACCAUT syntax diagram v Grant Object Authority (GRTOBJAUT) Command, GRTOBJAUT syntax diagram v Grant User Authority (GRTUSRAUT) Command, GRTUSRAUT syntax diagram v Grant User Permission (GRTUSRPMN) Command, GRTUSRPMN syntax diagram v Grant Workstation Object Authority (GRTWSOAUT) Command, GRTWSOAUT syntax diagram H (Back to the top) v Hold Communications Device (HLDCMNDEV) Command, HLDCMNDEV syntax diagram v Hold Distribution Queue (HLDDSTQ) Command, HLDDSTQ syntax diagram v Hold Job (HLDJOB) Command, HLDJOB syntax diagram v Hold Job Queue (HLDJOBQ) Command, HLDJOBQ syntax diagram
40
v Hold Job Schedule Entry (HLDJOBSCDE) Command, HLDJOBSCDE syntax diagram v Hold Output Queue (HLDOUTQ) Command, HLDOUTQ syntax diagram v Hold Reader (HLDRDR) Command, HLDRDR syntax diagram v Hold Spooled File (HLDSPLF) Command, HLDSPLF syntax diagram v Hold Writer (HLDWTR) Command, HLDWTR syntax diagram I (Back to the top) v If (IF) Command, IF syntax diagram v Install Network Server Application (INSNWSAPP) Command, INSNWSAPP syntax diagram v Install Program Temporary Fix (INSPTF) Command, INSPTF syntax diagram v Initialize Diskette (INZDKT) Command, INZDKT syntax diagram v Initialize Distribution Queue (INZDSTQ) Command, INZDSTQ syntax diagram v Initialize Optical (INZOPT) Command, INZOPT syntax diagram v Initialize Client Access (INZPCS) Command, INZPCS syntax diagram v Initialize Physical File Member (INZPFM) Command, INZPFM syntax diagram v Initialize System (INZSYS) Command, INZSYS syntax diagram v Initialize Tape (INZTAP) Command, INZTAP syntax diagram v IPXPING Command, IPXPING syntax diagram L (Back to the top) v Link Data Definition (LNKDTADFN) Command, LNKDTADFN syntax diagram v Load Program Temporary Fix (LODPTF) Command, LODPTF syntax diagram v Load Question-and-Answer Database (LODQSTDB) Command, LODQSTDB syntax diagram v Load and Run Media Program (LODRUN) Command, LODRUN syntax diagram M (Back to the top) v v v v v Create Directory (MD) Command, MD syntax diagram Create Directory (MKDIR) Command, MKDIR syntax diagram Monitor Message (MONMSG) Command, MONMSG syntax diagram Add Mounted File System (MOUNT) Command, MOUNT syntax diagram Move (MOV) Command, MOV syntax diagram
v Move Document (MOVDOC) Command, MOVDOC syntax diagram v Move (MOVE) Command, MOVE syntax diagram v Move Object (MOVOBJ) Command, MOVOBJ syntax diagram v Merge Message Catalog (MRGMSGCLG) Command, MRGMSGCLG syntax diagram v Merge Message File (MRGMSGF) Command, MRGMSGF syntax diagram v MRGTCPHT (Merge TCP/IP Host Table)MRGTCPHT syntax diagram N (Back to the top) v NETSTAT Command, NETSTAT syntax diagram O (Back to the top) v Open Query File (OPNQRYF) Command, OPNQRYF syntax diagram v Override with Database File (OVRDBF) Command, OVRDBF syntax diagram
41
v Override with Diskette File (OVRDKTF) Command, OVRDKTF syntax diagram v Override with Display File (OVRDSPF) Command, OVRDSPF syntax diagram v Override with Intersystem Communications Function Program Device Entry (OVRICFDEVE) Command, OVRICFDEVE syntax diagram v Override with Intersystem Communications Function File (OVRICFF) Command, OVRICFF syntax diagram v Override with Message File (OVRMSGF) Command, OVRMSGF syntax diagram v Override with Printer File (OVRPRTF) Command, OVRPRTF syntax diagram v Override with Save File (OVRSAVF) Command, OVRSAVF syntax diagram v Override with Tape File (OVRTAPF) Command, OVRTAPF syntax diagram P v v v v (Back to the top) Program (PGM) Command, PGM syntax diagram PING Command, PING syntax diagram Position Database File (POSDBF) Command, POSDBF syntax diagram Print Adopting Objects (PRTADPOBJ) Command, PRTADPOBJ syntax diagram
v Print Advanced Function Printer Data (PRTAFPDTA) Command, PRTAFPDTA syntax diagram v Print Command Usage (PRTCMDUSG) Command, PRTCMDUSG syntax diagram v Print Communications Security (PRTCMNSEC) Command, PRTCMNSEC syntax diagram v Print Communications Trace (PRTCMNTRC) Command, PRTCMNTRC syntax diagram v Print Device Addresses (PRTDEVADR) Command, PRTDEVADR syntax diagram v Print Document (PRTDOC) Command, PRTDOC syntax diagram v Print Disk Information (PRTDSKINF) Command, PRTDSKINF syntax diagram v Print Error Log (PRTERRLOG) Command, PRTERRLOG syntax diagram v Print Internal Data (PRTINTDTA) Command, PRTINTDTA syntax diagram v Print IP over SNA Configuration (PRTIPSCFG) Command, PRTIPSCFG syntax diagram v Print Job Description Authority (PRTJOBDAUT) Command, PRTJOBDAUT syntax diagram v Print Profile Internals (PRTPRFINT) Command, PRTPRFINT syntax diagram v Print Publicly Authorized Objects (PRTPUBAUT) Command, PRTPUBAUT syntax diagram v Print Private Authorities (PRTPVTAUT) Command, PRTPVTAUT syntax diagram v Print Queue Authority (PRTQAUT) Command, PRTQAUT syntax diagram v Print Subsystem Description Authority (PRTSBSDAUT) Command, PRTSBSDAUT syntax diagram v Print Structured Query Language Information (PRTSQLINF) Command, PRTSQLINF syntax diagram v Print Stop Word List (PRTSWL) Command, PRTSWL syntax diagram v Print System Information (PRTSYSINF) Command, PRTSYSINF syntax diagram v Print System Security Attributes (PRTSYSSECA) Command, PRTSYSSECA syntax diagram v Print Trigger Program (PRTTRGPGM) Command, PRTTRGPGM syntax diagram
42
v Print User Objects (PRTUSROBJ) Command, PRTUSROBJ syntax diagram v Print User Profile (PRTUSRPRF) Command, PRTUSRPRF syntax diagram v Power Down System (PWRDWNSYS) Command, PWRDWNSYS syntax diagram Q (Back to the top) v Query Document Library (QRYDOCLIB) Command, QRYDOCLIB syntax diagram v Query Distribution (QRYDST) Command, QRYDST syntax diagram v Query Problem Status (QRYPRBSTS) Command, QRYPRBSTS syntax diagram v Query Technical Information Exchange File (QRYTIEF) Command, QRYTIEF syntax diagram v QSH (QSH) Command, QSH syntax diagram R (Back to the top) v Reclaim Activation Group (RCLACTGRP) Command, RCLACTGRP syntax diagram v Reclaim Distributed Data Management Conversations (RCLDDMCNV) Command, RCLDDMCNV syntax diagram v Reclaim Document Library Object (RCLDLO) Command, RCLDLO syntax diagram v Reclaim Library (RCLLIB) Command, RCLLIB syntax diagram v Reclaim Optical (RCLOPT) Command, RCLOPT syntax diagram v v v v v v v v Reclaim Resources (RCLRSC) Command, RCLRSC syntax diagram Reclaim Spool Storage (RCLSPLSTG) Command, RCLSPLSTG syntax diagram Reclaim Storage (RCLSTG) Command, RCLSTG syntax diagram Reclaim Temporary Storage (RCLTMPSTG) Command, RCLTMPSTG syntax diagram Receive Receive Receive Receive Distribution (RCVDST) Command, RCVDST syntax diagram File (RCVF) Command, RCVF syntax diagram Journal Entry (RCVJRNE) Command, RCVJRNE syntax diagram Message (RCVMSG) Command, RCVMSG syntax diagram
v Receive Network File (RCVNETF) Command, RCVNETF syntax diagram v Receive Technical Information Exchange File (RCVTIEF) Command, RCVTIEF syntax diagram v Remove Directory (RD) Command, RD syntax diagram v Rename (REN) Command, REN syntax diagram v Return (RETURN) Command, RETURN syntax diagram v Reorganize Document Library Object (RGZDLO) Command, RGZDLO syntax diagram v Reorganize Physical File Member (RGZPFM) Command, RGZPFM syntax diagram v Release Communications Device (RLSCMNDEV) Command, RLSCMNDEV syntax diagram v Release Distribution Queue (RLSDSTQ) Command, RLSDSTQ syntax diagram v Release Integrated File System Locks (RLSIFSLCK) Command, RLSIFSLCK syntax diagram v Release Job (RLSJOB) Command, RLSJOB syntax diagram v Release Job Queue (RLSJOBQ) Command, RLSJOBQ syntax diagram
43
v Release Job Schedule Entry (RLSJOBSCDE) Command, RLSJOBSCDE syntax diagram v Release Output Queue (RLSOUTQ) Command, RLSOUTQ syntax diagram v Release Reader (RLSRDR) Command, RLSRDR syntax diagram v Release Remote Phase (RLSRMTPHS) Command, RLSRMTPHS syntax diagram v Release Spooled File (RLSSPLF) Command, RLSSPLF syntax diagram v Release Writer (RLSWTR) Command, RLSWTR syntax diagram v Remove Directory (RMDIR) Command, RMDIR syntax diagram v v v v Remove Access Code (RMVACC) Command, RMVACC syntax diagram Remove Autostart Job Entry (RMVAJE) Command, RMVAJE syntax diagram Remove Alert Description (RMVALRD) Command, RMVALRD syntax diagram Remove Authorization List Entry (RMVAUTLE) Command, RMVAUTLE syntax diagram
v Remove Breakpoint (RMVBKP) Command, RMVBKP syntax diagram v Remove Circuit Route (RMVCCTRTE) Command, RMVCCTRTE syntax diagram v Remove Circuit Service (RMVCCTSRV) Command, RMVCCTSRV syntax diagram v Remove Binding Directory Entry (RMVBNDDIRE) Command, RMVBNDDIRE syntax diagram v Remove Configuration List Entries (RMVCFGLE) Command, RMVCFGLE syntax diagram v Remove Communications Entry (RMVCMNE) Command, RMVCMNE syntax diagram v Remove Connection List Entry (RMVCNNLE) Command, RMVCNNLE syntax diagram v Remove Community for SNMP (RMVCOMSNMP) Command, RMVCOMSNMP syntax diagram v Remove Directory (RMVDIR) Command, RMVDIR syntax diagram v Remove Directory Entry (RMVDIRE) Command, RMVDIRE syntax diagram v Remove Directory Shadow System (RMVDIRSHD) Command, RMVDIRSHD syntax diagram v Remove Document Library Object Authority (RMVDLOAUT) Command, RMVDLOAUT syntax diagram v Remove Distribution List Entry (RMVDSTLE) Command, RMVDSTLE syntax diagram v Remove Distribution Queue (RMVDSTQ) Command, RMVDSTQ syntax diagram v Remove Distribution Route (RMVDSTRTE) Command, RMVDSTRTE syntax diagram v Remove Distribution Secondary System Name (RMVDSTSYSN) Command, RMVDSTSYSN syntax diagram v Remove Emulation Configuration Entry (RMVEMLCFGE) Command, RMVEMLCFGE syntax diagram v Remove Extended Wireless Controller Bar Code Entry (RMVEWCBCDE) Command, RMVEWCBCDE syntax diagram v Remove Extended Wireless Controller PTC Entry (RMVEWCPTCE) Command, RMVEWCPTCE syntax diagram v Remove Exit Program (RMVEXITPGM) Command, RMVEXITPGM syntax diagram
44
v Remove Font Table Entry (RMVFNTTBLE) Command, RMVFNTTBLE syntax diagram v Remove Filter Action Entry (RMVFTRACNE) Command, RMVFTRACNE syntax diagram v Remove Filter Selection Entry (RMVFTRSLTE) Command, RMVFTRSLTE syntax diagram v Remove Intersystem Communications Function Program Device Entry (RMVICFDEVE) Command, RMVICFDEVE syntax diagram v Remove IP over IPX Address (RMVIPIADR) Command, RMVIPIADR syntax diagram v Remove IP over IPX Interface (RMVIPIIFC) Command, RMVIPIIFC syntax diagram v Remove IP over IPX Route (RMVIPIRTE) Command, RMVIPIRTE syntax diagram v Remove IP over SNA interface (RMVIPSIFC) Command, RMVIPSIFC syntax diagram v Remove IP over SNA Location Entry (RMVIPSLOC) Command, RMVIPSLOC syntax diagram v Remove IP over SNA Route (RMVIPSRTE) Command, RMVIPSRTE syntax diagram v Remove IPX Circuit (RMVIPXCCT) Command, RMVIPXCCT syntax diagram v Remove Job Queue Entry (RMVJOBQE) Command, RMVJOBQE syntax diagram v Remove Job Schedule Entry (RMVJOBSCDE) Command, RMVJOBSCDE syntax diagram v Remove Journaled Changes (RMVJRNCHG) Command, RMVJRNCHG syntax diagram v Remove LAN Adapter Information (RMVLANADPI) Command, RMVLANADPI syntax diagram v Remove LAN Adapter (RMVLANADPT) Command, RMVLANADPT syntax diagram v Remove Library List Entry (RMVLIBLE) Command, RMVLIBLE syntax diagram v Remove License Key Information (RMVLICKEY) Command, RMVLICKEY syntax diagram v (RMVLNK) Command, RMVLNK syntax diagram v v v v Remove Member (RMVM) Command, RMVM syntax diagram Remove Mounted File System (RMVMFS) Command, RMVMFS syntax diagram Remove Message (RMVMSG) Command, RMVMSG syntax diagram Remove Message Description (RMVMSGD) Command, RMVMSGD syntax diagram v Remove Nickname (RMVNCK) Command, RMVNCK syntax diagram v Remove Network Job Entry (RMVNETJOBE) Command, RMVNETJOBE syntax diagram v Remove Network Table Entry (RMVNETTBLE) Command, RMVNETTBLE syntax diagram v Remove Node List Entry (RMVNODLE) Command, RMVNODLE syntax diagram v Remove Network Server Storage Link (RMVNWSSTGL) Command, RMVNWSSTGL syntax diagram
45
v Remove Optical Cartridge (RMVOPTCTG) Command, RMVOPTCTG syntax diagram v Remove Optical Server (RMVOPTSVR) Command, RMVOPTSVR syntax diagram v Remove Protocol Table Entry (RMVPCLTBLE) Command, RMVPCLTBLE syntax diagram v Remove Performance Explorer Definition (RMVPEXDFN) Command, RMVPEXDFN syntax diagram v Remove Physical File Constraint (RMVPFCST) Command, RMVPFCST syntax diagram v Remove Physical File Trigger (RMVPFTRG) Command, RMVPFTRG syntax diagram v Remove Program (RMVPGM) Command, RMVPGM syntax diagram v Remove Prestart Job Entry (RMVPJE) Command, RMVPJE syntax diagram v Remove Program Temporary Fix (RMVPTF) Command, RMVPTF syntax diagram v Remove Relational Database Directory Entry (RMVRDBDIRE) Command, RMVRDBDIRE syntax diagram v Remove REXX Buffer (RMVREXBUF) Command, RMVREXBUF syntax diagram v Remove Remote Definition (RMVRMTDFN) Command, RMVRMTDFN syntax diagram v Remove Remote Journal (RMVRMTJRN) Command, RMVRMTJRN syntax diagram v Remove Reply List Entry (RMVRPYLE) Command, RMVRPYLE syntax diagram v Remove Routing Entry (RMVRTGE) Command, RMVRTGE syntax diagram v Remove Search Index Entry (RMVSCHIDXE) Command, RMVSCHIDXE syntax diagram v Remove SNA over IPX Location (RMVSNILOC) Command, RMVSNILOC syntax diagram v Remove Sphere of Control Entry (RMVSOCE) Command, RMVSOCE syntax diagram v Remove Service Table Entry (RMVSRVTBLE) Command, RMVSRVTBLE syntax diagram v Remove Server Authentication Entry (RMVSVRAUTE) Command, RMVSVRAUTE syntax diagram v Remove Tape Cartridge (RMVTAPCTG) Command, RMVTAPCTG syntax diagram v Remove TCP/IP Host Table Entry (RMVTCPHTE) Command, RMVTCPHTE syntax diagram v Remove TCP/IP Interface (RMVTCPIFC) Command, RMVTCPIFC syntax diagram v Remove TCP/IP Port Restriction (RMVTCPPORT) Command, RMVTCPPORT syntax diagram v Remove TCP/IP Remote System Information (RMVTCPRSI) Command, RMVTCPRSI syntax diagram v Remove TCP/IP Route (RMVTCPRTE) Command, RMVTCPRTE syntax diagram v Remove TCP/IP Table (RMVTCPTBL) Command, RMVTCPTBL syntax diagram v Remove Trace (RMVTRC) Command, RMVTRC syntax diagram
46
v Remove Ultimedia System Facilities Connection Entry (RMVUSFCNNE) Command, RMVUSFCNNE syntax diagram v Remove Ultimedia System Facilities Device Entry (RMVUSFDEVE) Command, RMVUSFDEVE syntax diagram v Remove Ultimedia System Facilities Server Entry (RMVUSFSVRE) Command, RMVUSFSVRE syntax diagram v Remove Work Station Entry (RMVWSE) Command, RMVWSE syntax diagram v Rename (RNM) Command, RNM syntax diagram v Rename Connection List Entry (RNMCNNLE) Command, RNMCNNLE syntax diagram v Rename Directory Entry (RNMDIRE) Command, RNMDIRE syntax diagram v Rename Diskette (RNMDKT) Command, RNMDKT syntax diagram v Rename Document Library Object (RNMDLO) Command, RNMDLO syntax diagram v Rename Distribution List (RNMDSTL) Command, RNMDSTL syntax diagram v Rename Local Area Network Adapter Information (RNMLANADPI) Command, RNMLANADPI syntax diagram v v v v v v v v Rename Member (RNMM) Command, RNMM syntax diagram Rename Nickname (RNMNCK) Command, RNMNCK syntax diagram Rename Object (RNMOBJ) Command, RNMOBJ syntax diagram Rename TCP/IP Host Table Entry (RNMTCPHTE) Command, RNMTCPHTE syntax diagram Rollback (ROLLBACK) Command, ROLLBACK syntax diagram Start RPC Binder Daemon (RPCBIND) Command, RPCBIND syntax diagram Convert RPC Source (RPCGEN) Command, RPCGEN syntax diagram Replace Document (RPLDOC) Command, RPLDOC syntax diagram
v Request Order Assistance (RQSORDAST) Command, RQSORDAST syntax diagram v Reroute Job (RRTJOB) Command, RRTJOB syntax diagram v Resume Breakpoint (RSMBKP) Command, RSMBKP syntax diagram v Resume Controller Recovery (RSMCTLRCY) Command, RSMCTLRCY syntax diagram v Resume Device Recovery (RSMDEVRCY) Command, RSMDEVRCY syntax diagram v Resume Line Recovery (RSMLINRCY) Command, RSMLINRCY syntax diagram v Resume Network Interface Recovery (RSMNWIRCY) Command, RSMNWIRCY syntax diagram v Restore (RST) Command, RST syntax diagram v Restore Authority (RSTAUT) Command, RSTAUT syntax diagram v Restore Configuration (RSTCFG) Command, RSTCFG syntax diagram v Restore Document Library Object (RSTDLO) Command, RSTDLO syntax diagram v Restore Library (RSTLIB) Command, RSTLIB syntax diagram v Restore Licensed Program (RSTLICPGM) Command, RSTLICPGM syntax diagram v Restore Object (RSTOBJ) Command, RSTOBJ syntax diagram v Restore System/36 File (RSTS36F) Command, RSTS36F syntax diagram
47
v Restore System/36 Folder (RSTS36FLR) Command, RSTS36FLR syntax diagram v Restore System/36 Library Members (RSTS36LIBM) Command, RSTS36LIBM syntax diagram v Restore Ultimedia System Facilities Container (RSTUSFCNR) Command, RSTUSFCNR syntax diagram v Restore User Profiles (RSTUSRPRF) Command, RSTUSRPRF syntax diagram v Retrieve Authorization List Entry (RTVAUTLE) Command, RTVAUTLE syntax diagram v Retrieve Backup (RTVBCKUP) Command, RTVBCKUP syntax diagram v Retrieve Binder Source (RTVBNDSRC) Command, RTVBNDSRC syntax diagram v Retrieve Configuration Source (RTVCFGSRC) Command, RTVCFGSRC syntax diagram v Retrieve Configuration Status (RTVCFGSTS) Command, RTVCFGSTS syntax diagram v Retrieve Cleanup (RTVCLNUP) Command, RTVCLNUP syntax diagram v Retrieve CL Source (RTVCLSRC) Command, RTVCLSRC syntax diagram v Retrieve Current Directory (RTVCURDIR) Command, RTVCURDIR syntax diagram v Retrieve Document Library Object Authority (RTVDLOAUT) Command, RTVDLOAUT syntax diagram v Retrieve Document Library Object Name (RTVDLONAM) Command, RTVDLONAM syntax diagram v Retrieve Document (RTVDOC) Command, RTVDOC syntax diagram v Retrieve Disk Information (RTVDSKINF) Command, RTVDSKINF syntax diagram v Retrieve Data Area (RTVDTAARA) Command, RTVDTAARA syntax diagram v Retrieve Group Attributes (RTVGRPA) Command, RTVGRPA syntax diagram v Retrieve Job Attributes (RTVJOBA) Command, RTVJOBA syntax diagram v Retrieve Journal Entry (RTVJRNE) Command, RTVJRNE syntax diagram v Retrieve Library Description (RTVLIBD) Command, RTVLIBD syntax diagram v Retrieve Member Description (RTVMBRD) Command, RTVMBRD syntax diagram v Retrieve Message (RTVMSG) Command, RTVMSG syntax diagram v Retrieve Network Attributes (RTVNETA) Command, RTVNETA syntax diagram v Retrieve Object Description (RTVOBJD) Command, RTVOBJD syntax diagram v Retrieve Print Descriptor Group Profile (RTVPDGPRF) Command, RTVPDGPRF syntax diagram v Retrieve Power On/Off Schedule Entry (RTVPWRSCDE) Command, RTVPWRSCDE syntax diagram v Retrieve Query Management Form (RTVQMFORM) Command, RTVQMFORM syntax diagram v Retrieve Query Management Query (RTVQMQRY) Command, RTVQMQRY syntax diagram v Retrieve Stop Word List Source (RTVSWLSRC) Command, RTVSWLSRC syntax diagram v Retrieve System Value (RTVSYSVAL) Command, RTVSYSVAL syntax diagram v Retrieve System Information (RTVSYSINF) Command, RTVSYSINF syntax diagram
48
v v v v v v v v v
Retrieve System/36 Attributes (RTVS36A) Command, RTVS36A syntax diagram Retrieve Table Source (RTVTBSRC) Command, RTVTBSRC syntax diagram Retrieve User Profile (RTVUSRPRF) Command, RTVUSRPRF syntax diagram Retrieve User Print Information (RTVUSRPRTI) Command, RTVUSRPRTI syntax diagram Retrieve Work Station Customizing Object Source (RTVWSCST) Command, RTVWSCST syntax diagram Run Backup (RUNBCKUP) Command, RUNBCKUP syntax diagram Run LPDA-2 (RUNLPDA) Command, RUNLPDA syntax diagram Run Query (RUNQRY) Command, RUNQRY syntax diagram Run Remote Command (RUNRMTCMD) Command, RUNRMTCMD syntax diagram
v Revoke Access Code Authority (RVKACCAUT) Command, RVKACCAUT syntax diagram v Revoke Object Authority (RVKOBJAUT) Command, RVKOBJAUT syntax diagram v Revoke Public Authority (RVKPUBAUT) Command, RVKPUBAUT syntax diagram v Revoke User Permission (RVKUSRPMN) Command, RVKUSRPMN syntax diagram v Revoke Workstation Object Authority (RVKWSOAUT) Command, RVKWSOAUT syntax diagram S (Back to the top) v Save (SAV) Command, SAV syntax diagram v Save APAR Data (SAVAPARDTA) Command, SAVAPARDTA syntax diagram v Save Configuration (SAVCFG) Command, SAVCFG syntax diagram v v v v Save Save Save Save Changed Object (SAVCHGOBJ) Command, SAVCHGOBJ syntax diagram Document Library Object (SAVDLO) Command, SAVDLO syntax diagram Library (SAVLIB) Command, SAVLIB syntax diagram Licensed Program (SAVLICPGM) Command, SAVLICPGM syntax diagram
v Save Object (SAVOBJ) Command, SAVOBJ syntax diagram v Save/Restore Objects (SAVRST) Command, SAVRST syntax diagram v Save/Restore Configuration (SAVRSTCFG) Command, SAVRSTCFG syntax diagram v Save/Restore Changed Object (SAVRSTCHG) Command, SAVRSTCHG syntax diagram v Save/Restore Document Library Object (SAVRSTDLO) Command, SAVRSTDLO syntax diagram v Save/Restore Library (SAVRSTLIB) Command, SAVRSTLIB syntax diagram v v v v v v v Save/Restore Object (SAVRSTOBJ) Command, SAVRSTOBJ syntax diagram Save Save File Data (SAVSAVFDTA) Command, SAVSAVFDTA syntax diagram Save Security Data (SAVSECDTA) Command, SAVSECDTA syntax diagram Save Storage (SAVSTG) Command, SAVSTG syntax diagram Save System (SAVSYS) Command, SAVSYS syntax diagram Save System/36 File (SAVS36F) Command, SAVS36F syntax diagram Save System/36 Library Members (SAVS36LIBM) Command, SAVS36LIBM syntax diagram
49
v Save Ultimedia System Facilities Container (SAVUSFCNR) Command, SAVUSFCNR syntax diagram v Submit Database Jobs (SBMDBJOB) Command, SBMDBJOB syntax diagram v Submit Diskette Jobs (SBMDKTJOB) Command, SBMDKTJOB syntax diagram v Submit Finance Job (SBMFNCJOB) Command, SBMFNCJOB syntax diagram v Submit Job (SBMJOB) Command, SBMJOB syntax diagram v Submit Network Job (SBMNETJOB) Command, SBMNETJOB syntax diagram v Submit Network Server Command (SBMNWSCMD) Command, SBMNWSCMD syntax diagram v Submit Remote Command (SBMRMTCMD) Command, SBMRMTCMD syntax diagram v Set Attention Program (SETATNPGM) Command, SETATNPGM syntax diagram v Set Customization Data (SETCSTDTA) Command, SETCSTDTA syntax diagram v Set Keyboard Map (SETKBDMAP) Command, SETKBDMAP syntax diagram v Set Object Access (SETOBJACC) Command, SETOBJACC syntax diagram v Set Tape Category (SETTAPCGY) Command, SETTAPCGY syntax diagram v v v v v Sign Off (SIGNOFF) Command, SIGNOFF syntax diagram Select Command (SLTCMD) Command, SLTCMD syntax diagram Send Break Message (SNDBRKMSG) Command, SNDBRKMSG syntax diagram Send Distribution (SNDDST) Command, SNDDST syntax diagram Send Distribution Queue (SNDDSTQ) Command, SNDDSTQ syntax diagram
v Send DBCS 3270PC Emulation Code (SNDEMLIGC) Command, SNDEMLIGC syntax diagram v Send File (SNDF) Command, SNDF syntax diagram v Send Finance Diskette Image (SNDFNCIMG) Command, SNDFNCIMG syntax diagram v v v v v v v v v v v Send Journal Entry (SNDJRNE) Command, SNDJRNE syntax diagram Send Message (SNDMSG) Command, SNDMSG syntax diagram Send Network File (SNDNETF) Command, SNDNETF syntax diagram Send Network Message (SNDNETMSG) Command, SNDNETMSG syntax diagram Send Network Spooled File (SNDNETSPLF) Command, SNDNETSPLF syntax diagram Send Program Message (SNDPGMMSG) Command, SNDPGMMSG syntax diagram Send Program Temporary Fix Order (SNDPTFORD) Command, SNDPTFORD syntax diagram Send/Receive File (SNDRCVF) Command, SNDRCVF syntax diagram Send Reply (SNDRPY) Command, SNDRPY syntax diagram Send Service Request (SNDSRVRQS) Command, SNDSRVRQS syntax diagram Send Technical Information Exchange File (SNDTIEF) Command, SNDTIEF syntax diagram
v Send User Message (SNDUSRMSG) Command, SNDUSRMSG syntax diagram v Display Mounted File System Information (STATFS) Command, STATFS syntax diagram v Start Cleanup (STRCLNUP) Command, STRCLNUP syntax diagram
50
v Start Communications Server (STRCMNSVR) Command, STRCMNSVR syntax diagram v Start Communications Trace (STRCMNTRC) Command, STRCMNTRC syntax diagram v Start Commitment Control (STRCMTCTL) Command, STRCMTCTL syntax diagram v v v v v v v v v v v Start Copy Screen (STRCPYSCN) Command, STRCPYSCN syntax diagram Start Debug (STRDBG) Command, STRDBG syntax diagram Start Debug Server (STRDBGSVR) Command, STRDBGSVR syntax diagram Start Database Monitor (STRDBMON) Command, STRDBMON syntax diagram Start Database Reader (STRDBRDR) Command, STRDBRDR syntax diagram Start Directory Shadowing (STRDIRSHD) Command, STRDIRSHD syntax diagram Start Diskette Reader (STRDKTRDR) Command, STRDKTRDR syntax diagram Start Diskette Writer (STRDKTWTR) Command, STRDKTWTR syntax diagram Start Disk Reorganization (STRDSKRGZ) Command, STRDSKRGZ syntax diagram Start Education (STREDU) Command, STREDU syntax diagram Start Font Management Aid (STRFMA) Command, STRFMA syntax diagram
v Start Host Server (STRHOSTSVR) Command, STRHOSTSVR syntax diagram v Start Interactive Data Definition Utility (STRIDD) Command, STRIDD syntax diagram v Start InfoSeeker (STRINFSKR) Command, STRINFSKR syntax diagram v Start IP over IPX Interface (STRIPIIFC) Command, STRIPIIFC syntax diagram v Start IP over SNA interface (STRIPSIFC) Command, STRIPSIFC syntax diagram v Start IPX (STRIPX) Command, STRIPX syntax diagram v Start IPX Circuit (STRIPXCCT) Command, STRIPXCCT syntax diagram v v v v v v v v v v Start Interactive Terminal Facility (STRITF) Command, STRITF syntax diagram Start Journal Access Path (STRJRNAP) Command, STRJRNAP syntax diagram Start Journal Physical File (STRJRNPF) Command, STRJRNPF syntax diagram Start Mode (STRMOD) Command, STRMOD syntax diagram Start Mail Server Framework (STRMSF) Command, STRMSF syntax diagram Start Network File System Server (STRNFSSVR) Command, STRNFSSVR syntax diagram Start Network Server Application (STRNWSAPP) Command, STRNWSAPP syntax diagram Start Object Conversion (STROBJCVN) Command, STROBJCVN syntax diagram Start Pass-Through (STRPASTHR) Command, STRPASTHR syntax diagram Start Performance Explorer (STRPEX) Command, STRPEX syntax diagram
v Start Performance Collection (STRPFRCOL) Command, STRPFRCOL syntax diagram v Start Performance Monitor (STRPFRMON) Command, STRPFRMON syntax diagram v Start Programmer Menu (STRPGMMNU) Command, STRPGMMNU syntax diagram v Start Program Profiling (STRPGMPRF) Command, STRPGMPRF syntax diagram v Start Prestart Jobs (STRPJ) Command, STRPJ syntax diagram
51
v Start Printer Writer (STRPRTWTR) Command, STRPRTWTR syntax diagram v Start Query Management Procedure (STRQMPRC) Command, STRQMPRC syntax diagram v Start Query Management Query (STRQMQRY) Command, STRQMQRY syntax diagram v Start Query (STRQRY) Command, STRQRY syntax diagram v Start QSH (STRQSH) Command, STRQSH syntax diagram v Start Question and Answer (STRQST) Command, STRQST syntax diagram v Start REXX Procedure (STRREXPRC) Command, STRREXPRC syntax diagram v Start Remote Support (STRRMTSPT) Command, STRRMTSPT syntax diagram v Start Remote Writer (STRRMTWTR) Command, STRRMTWTR syntax diagram v Start Subsystem (STRSBS) Command, STRSBS syntax diagram v Start Search Index (STRSCHIDX) Command, STRSCHIDX syntax diagram v v v v v Start Start Start Start Start Support Network (STRSPTN) Command, STRSPTN syntax diagram Service Job (STRSRVJOB) Command, STRSRVJOB syntax diagram System Service Tools (STRSST) Command, STRSST syntax diagram System/36 (STRS36) Command, STRS36 syntax diagram System/36 Procedure (STRS36PRC) Command, STRS36PRC syntax diagram
v Start TCP/IP (STRTCP) Command, STRTCP syntax diagram v Start TCP/IP Interface (STRTCPIFC) Command, STRTCPIFC syntax diagram v Start Point-to-Point TCP/IP (STRTCPPTP) Command, STRTCPPTP syntax diagram v Start TCP/IP Server (STRTCPSVR) Command, STRTCPSVR syntax diagram v Start Technical Information Exchange Session (STRTIESSN) Command, STRTIESSN syntax diagram v Start Trap Manager (STRTRPMGR) Command, STRTRPMGR syntax diagram v Start Ultimedia System Facilities (STRUSF) Command, STRUSF syntax diagram T v v v (Back to the top) Transfer Batch Job (TFRBCHJOB) Command, TFRBCHJOB syntax diagram Transfer Control (TFRCTL) Command, TFRCTL syntax diagram Transfer to Group Job (TFRGRPJOB) Command, TFRGRPJOB syntax diagram
v Transfer Job (TFRJOB) Command, TFRJOB syntax diagram v Transfer Pass-Through (TFRPASTHR) Command, TFRPASTHR syntax diagram v Transfer Secondary Job (TFRSECJOB) Command, TFRSECJOB syntax diagram v Trace Connection (TRCCNN) Command, TRCCNN syntax diagram v v v v v Trace Trace Trace Trace Trace CPI Communications (TRCCPIC) Command, TRCCPIC syntax diagram ICF (TRCICF) Command, TRCICF syntax diagram Internal (TRCINT) Command, TRCINT syntax diagram Job (TRCJOB) Command, TRCJOB syntax diagram REXX (TRCREX) Command, TRCREX syntax diagram
U (Back to the top) v Remove Mounted File System (UNMOUNT) Command, UNMOUNT syntax diagram v Update Program (UPDPGM) Command, UPDPGM syntax diagram
52
v Update Service Program (UPDSRVPGM) Command, UPDSRVPGM syntax diagram v Update System Information (UPDSYSINF) Command, UPDSYSINF syntax diagram V (Back to the top) v Verify APPC Connection (APING ) Command, APING syntax diagram v Verify APPC Connection (VFYAPPCCNN) Command, VFYAPPCCNN syntax diagram v Verify Communications (VFYCMN) Command, VFYCMN syntax diagram v Verify IPX Connection (VFYIPXCNN) Command, VFYIPXCNN syntax diagram v Verify Link Supporting LPDA-2 (VFYLNKLPDA) Command, VFYLNKLPDA syntax diagram v Verify OptiConnect Connections (VFYOPCCNN) Command, VFYOPCCNN syntax diagram v Verify Optical (VFYOPT) Command, VFYOPT syntax diagram v Verify Printer (VFYPRT) Command, VFYPRT syntax diagram v Verify Tape (VFYTAP) Command, VFYTAP syntax diagram v Verify TCP/IP Connection (VFYTCPCNN) Command, VFYTCPCNN syntax diagram v Vary Configuration (VRYCFG) Command, VRYCFG syntax diagram W (Back to the top) v Wait (WAIT) Command, WAIT syntax diagram v Work with Active Jobs (WRKACTJOB) Command, WRKACTJOB syntax diagram v Work with Alerts (WRKALR) Command, WRKALR syntax diagram v Work with Alert Descriptions (WRKALRD) Command, WRKALRD syntax diagram v Work with Alert Tables (WRKALRTBL) Command, WRKALRTBL syntax diagram v Work with APPN Status (WRKAPPNSTS) Command, WRKAPPNSTS syntax diagram v Work with Authority (WRKAUT) Command, WRKAUT syntax diagram v Work with Authorization Lists (WRKAUTL) Command, WRKAUTL syntax diagram v Work with Binding Directories (WRKBNDDIR) Command, WRKBNDDIR syntax diagram v Work with Binding Directory Entries (WRKBNDDIRE) Command, WRKBNDDIRE syntax diagram v Work with BOOTP Table (WRKBPTBL) Command, WRKBPTBL syntax diagram v Work with Circuit Routes (WRKCCTRTE) Command, WRKCCTRTE syntax diagram v Work with Circuit Services (WRKCCTSRV) Command, WRKCCTSRV syntax diagram v Work with Configuration Lists (WRKCFGL) Command, WRKCFGL syntax diagram v Work with Chart Formats (WRKCHTFMT) Command, WRKCHTFMT syntax diagram v Work with Classes (WRKCLS) Command, WRKCLS syntax diagram
53
v Work with Commands (WRKCMD) Command, WRKCMD syntax diagram v Work with Commitment Definitions (WRKCMTDFN) Command, WRKCMTDFN syntax diagram v Work with Connection Lists (WRKCNNL) Command, WRKCNNL syntax diagram v Work with Connection List Entries (WRKCNNLE) Command, WRKCNNLE syntax diagram v Work with Contact Information (WRKCNTINF) Command, WRKCNTINF syntax diagram v Work with Class-of-Service Descriptions (WRKCOSD) Command, WRKCOSD syntax diagram v Work with Communications Side Information (WRKCSI) Command, WRKCSI syntax diagram v Work with Controller Descriptions (WRKCTLD) Command, WRKCTLD syntax diagram v Work with Database Files Using IDDU (WRKDBFIDD) Command, WRKDBFIDD syntax diagram v Work with Distributed Data Management Files (WRKDDMF) Command, WRKDDMF syntax diagram v Work with Device Descriptions (WRKDEVD) Command, WRKDEVD syntax diagram v Work with Device Tables (WRKDEVTBL) Command, WRKDEVTBL syntax diagram v Work with Directory Entries (WRKDIRE) Command, WRKDIRE syntax diagram v Work with Directory Locations (WRKDIRLOC) Command, WRKDIRLOC syntax diagram v Work with Directory Shadow Systems (WRKDIRSHD) Command, WRKDIRSHD syntax diagram v Work with Documents (WRKDOC) Command, WRKDOC syntax diagram v Work with Document Libraries (WRKDOCLIB) Command, WRKDOCLIB syntax diagram v Work with Document Print Queue (WRKDOCPRTQ) Command, WRKDOCPRTQ syntax diagram v Work with DSNX/PC Distribution Queues (WRKDPCQ) Command, WRKDPCQ syntax diagram v Work with Disk Status (WRKDSKSTS) Command, WRKDSKSTS syntax diagram v Work with Distribution Lists (WRKDSTL) Command, WRKDSTL syntax diagram v Work with Distribution Queues (WRKDSTQ) Command, WRKDSTQ syntax diagram v Work with Data Areas (WRKDTAARA) Command, WRKDTAARA syntax diagram v Work with Data Dictionaries (WRKDTADCT) Command, WRKDTADCT syntax diagram v Work with Data Definitions (WRKDTADFN) Command, WRKDTADFN syntax diagram v Work with Data Queues (WRKDTAQ) Command, WRKDTAQ syntax diagram v Work with Edit Descriptions (WRKEDTD) Command, WRKEDTD syntax diagram
54
v Work with Environment Variables (WRKENVVAR) Command, WRKENVVAR syntax diagram v Work with Files (WRKF) Command, WRKF syntax diagram v Work with Folders (WRKFLR) Command, WRKFLR syntax diagram v Work with Font Resources (WRKFNTRSC) Command, WRKFNTRSC syntax diagram v Work with Form Definitions (WRKFORMDF) Command, WRKFORMDF syntax diagram v Work with Filters (WRKFTR) Command, WRKFTR syntax diagram v Work with Filter Action Entries (WRKFTRACNE) Command, WRKFTRACNE syntax diagram v Work with Filter Selection Entries (WRKFTRSLTE) Command, WRKFTRSLTE syntax diagram v Work with Graphics Symbol Sets (WRKGSS) Command, WRKGSS syntax diagram v Work with Hardware Resources (WRKHDWRSC) Command, WRKHDWRSC syntax diagram v Work with Held Optical Files (WRKHLDOPTF) Command, WRKHLDOPTF syntax diagram v Work with IPX Circuits (WRKIPXCCT) Command, WRKIPXCCT syntax diagram v Work with IPX Descriptions (WRKIPXD) Command, WRKIPXD syntax diagram v Work with IPX Status (WRKIPXSTS) Command, WRKIPXSTS syntax diagram v Work with Job (WRKJOB) Command, WRKJOB syntax diagram v Work with Job Descriptions (WRKJOBD) Command, WRKJOBD syntax diagram v Work with Job Queues (WRKJOBQ) Command, WRKJOBQ syntax diagram v Work with Job Schedule Entries (WRKJOBSCDE) Command, WRKJOBSCDE syntax diagram v Work with Journal (WRKJRN) Command, WRKJRN syntax diagram v Work with Journal Attributes (WRKJRNA) Command, WRKJRNA syntax diagram v Work with Journal Receivers (WRKJRNRCV) Command, WRKJRNRCV syntax diagram v Work with LAN Adapters (WRKLANADPT) Command, WRKLANADPT syntax diagram v Work with Libraries (WRKLIB) Command, WRKLIB syntax diagram v Work with License Information (WRKLICINF) Command, WRKLICINF syntax diagram v Work with Object Links (WRKLNK) Command, WRKLNK syntax diagram v Work with Media Library Resource Queue (WRKMLBRSCQ) Command, WRKMLBRSCQ syntax diagram v Work with Media Library Status (WRKMLBSTS) Command, WRKMLBSTS syntax diagram v Work with Menus (WRKMNU) Command, WRKMNU syntax diagram v Work with Modules (WRKMOD) Command, WRKMOD syntax diagram v Work with Mode Descriptions (WRKMODD) Command, WRKMODD syntax diagram v Work with Messages (WRKMSG) Command, WRKMSG syntax diagram
55
v Work with Message Descriptions (WRKMSGD) Command, WRKMSGD syntax diagram v Work with Message Files (WRKMSGF) Command, WRKMSGF syntax diagram v Work with Message Queues (WRKMSGQ) Command, WRKMSGQ syntax diagram v Work with Nicknames (WRKNCK) Command, WRKNCK syntax diagram v Work with NetWare Authentication Engry (WRKNTWAUTE ) Command, WRKNTWAUTE syntax diagram v Work with Network Files (WRKNETF) Command, WRKNETF syntax diagram v Work with Network Job Entries (WRKNETJOBE) Command, WRKNETJOBE syntax diagram v Work with Network Table Entry (WRKNETTBLE) Command, WRKNETTBLE syntax diagram v Work with Node Lists (WRKNODL) Command, WRKNODL syntax diagram v Work with Node List Entries (WRKNODLE) Command, WRKNODLE syntax diagram v Work with NetBIOS Descriptions (WRKNTBD) Command, WRKNTBD syntax diagram v Work with NetWare Volumes (WRKNTWVOL) Command, WRKNTWVOL syntax diagram v Work with Network Interface Description (WRKNWID) Command, WRKNWID syntax diagram v Work with Network Server Descriptions (WRKNWSD) Command, WRKNWSD syntax diagram v Work with Network Server User Enrollment (WRKNWSENR) Command, WRKNWSENR syntax diagram v Work with Network Server Storage Spaces (WRKNWSSTG) Command, WRKNWSSTG syntax diagram v Work with Network Server Status (WRKNWSSTS) Command, WRKNWSSTS syntax diagram v Work with Objects (WRKOBJ) Command, WRKOBJ syntax diagram v Work with Object Locks (WRKOBJLCK) Command, WRKOBJLCK syntax diagram v Work with Objects by Owner (WRKOBJOWN) Command, WRKOBJOWN syntax diagram v Work with Objects by Primary Group (WRKOBJPGP) Command, WRKOBJPGP syntax diagram v Work with Optical Directories (WRKOPTDIR) Command, WRKOPTDIR syntax diagram v Work with Optical Files (WRKOPTF) Command, WRKOPTF syntax diagram v Work with Optical Volumes (WRKOPTVOL) Command, WRKOPTVOL syntax diagram v Work with OptiConnect Activity (WRKOPCACT) Command, WRKOPCACT syntax diagram v Work with Order Information (WRKORDINF) Command, WRKORDINF syntax diagram v Work with Order Requests (WRKORDRQS) Command, WRKORDRQS syntax diagram v Work with Output Queues (WRKOUTQ) Command, WRKOUTQ syntax diagram
56
v Work with Output Queue Description (WRKOUTQD) Command, WRKOUTQD syntax diagram v Work with Overlays (WRKOVL) Command, WRKOVL syntax diagram v Work with Page Definitions (WRKPAGDFN) Command, WRKPAGDFN syntax diagram v Work with Page Segments (WRKPAGSEG) Command, WRKPAGSEG syntax diagram v Work with Protocol Table Entry (WRKPCLTBLE) Command, WRKPCLTBLE syntax diagram v Work with Physical File Constraints (WRKPFCST) Command, WRKPFCST syntax diagram v Work with Physical File Datalinks (WRKPFDL) Command, WRKPFDL syntax diagram v Work with Performance Collection (WRKPFRCOL) Command, WRKPFRCOL syntax diagram v Work with Programs (WRKPGM) Command, WRKPGM syntax diagram v Work with Program Tables (WRKPGMTBL) Command, WRKPGMTBL syntax diagram v Work with Panel Groups (WRKPNLGRP) Command, WRKPNLGRP syntax diagram v Work with Problems (WRKPRB) Command, WRKPRB syntax diagram v Work with Product Information (WRKPRDINF) Command, WRKPRDINF syntax diagram v Work with Printing Status (WRKPRTSTS) Command, WRKPRTSTS syntax diagram v Work with Print Services Facility Configurations (WRKPSFCFG) Command, WRKPSFCFG syntax diagram v Work with Query Management Forms (WRKQMFORM) Command, WRKQMFORM syntax diagram v Work with Query Management Queries (WRKQMQRY) Command, WRKQMQRY syntax diagram v Work with Questions (WRKQST) Command, WRKQST syntax diagram v Work with Relational Database Directory Entries (WRKRDBDIRE) Command, WRKRDBDIRE syntax diagram v Work with Readers (WRKRDR) Command, WRKRDR syntax diagram v Work with Registration Information (WRKREGINF) Command, WRKREGINF syntax diagram v Work with Remote Definitions (WRKRMTDFN) Command, WRKRMTDFN syntax diagram v Work with System Reply List Entries (WRKRPYLE) Command, WRKRPYLE syntax diagram v Work with RouteD Configuration (WRKRTDCFG) Command, WRKRTDCFG syntax diagram v Work with Submitted Jobs (WRKSBMJOB) Command, WRKSBMJOB syntax diagram v Work with Subsystems (WRKSBS) Command, WRKSBS syntax diagram v Work with Subsystem Descriptions (WRKSBSD) Command, WRKSBSD syntax diagram
57
v Work with Subsystem Jobs (WRKSBSJOB) Command, WRKSBSJOB syntax diagram v Work with Search Indexes (WRKSCHIDX) Command, WRKSCHIDX syntax diagram v Work with Search Index Entries (WRKSCHIDXE) Command, WRKSCHIDXE syntax diagram v Work with Shared Storage Pools (WRKSHRPOOL) Command, WRKSHRPOOL syntax diagram v Work with Sphere of Control (WRKSOC) Command, WRKSOC syntax diagram v Work with Spelling Aid Dictionaries (WRKSPADCT) Command, WRKSPADCT syntax diagram v Work with Spooled Files (WRKSPLF) Command, WRKSPLF syntax diagram v Work with Spooled File Attributes (WRKSPLFA) Command, WRKSPLFA syntax diagram v Work with Service Programs (WRKSRVPGM) Command, WRKSRVPGM syntax diagram v Work with Service Providers (WRKSRVPVD) Command, WRKSRVPVD syntax diagram v Work with Service Table Entry (WRKSRVTBLE) Command, WRKSRVTBLE syntax diagram v Work with System Status (WRKSYSSTS) Command, WRKSYSSTS syntax diagram v Work with System Values (WRKSYSVAL) Command, WRKSYSVAL syntax diagram v Work with System/36 (WRKS36) Command, WRKS36 syntax diagram v Work with System/36 Program Attributes (WRKS36PGMA) Command, WRKS36PGMA syntax diagram v Work with System/36 Procedure Attributes (WRKS36PRCA) Command, WRKS36PRCA syntax diagram v Work with System/36 Source Attributes (WRKS36SRCA) Command, WRKS36SRCA syntax diagram v Work with Tape Cartridges (WRKTAPCTG) Command, WRKTAPCTG syntax diagram v Work with Tables (WRKTBL) Command, WRKTBL syntax diagram v Work with Point-to-Point TCP/IP (WRKTCPPTP) Command, WRKTCPPTP syntax diagram v Work with TCP/IP Network Status (WRKTCPSTS) Command, WRKTCPSTS syntax diagram v Work with Technical Information Exchange (WRKTIE) Command, WRKTIE syntax diagram v Work with Ultimedia System Facilities Connection Entries (WRKUSFCNNE) Command, WRKUSFCNNE syntax diagram v Work with Ultimedia System Facilities Device Entries (WRKUSFDEVE) Command, WRKUSFDEVE syntax diagram v Work with Ultimedia System Facilities Server Entries (WRKUSFSVRE) Command, WRKUSFSVRE syntax diagram v Work with User Jobs (WRKUSRJOB) Command, WRKUSRJOB syntax diagram v Work with User Profiles (WRKUSRPRF) Command, WRKUSRPRF syntax diagram
58
v Work with User Tables (WRKUSRTBL) Command, WRKUSRTBL syntax diagram v Work with Writers (WRKWTR) Command, WRKWTR syntax diagram Back to top
How commands are named

Most command names consist of a combination of the verb and the object being acted on: (command = verb + object acted on). For example, you can create, delete, or display a library; so the verb abbreviations CRT, DLT, and DSP are joined to the abbreviation for library, LIB. The result is three commands that can operate on a library: CRTLIB, DLTLIB, and DSPLIB. The conventions for naming the combination verb and object commands are as follows: v The primary convention (as just shown) is to use three letters from each word in the descriptive command name to form the abbreviated command name that is recognized by the system. v The secondary convention is to use single letters from the ending word or words in the command title for the end of the command name, such as the three single letters DLO on the DLTDLO (Delete Document Library Object) command. v An occasional convention is to use single letters in the middle of the command name (usually between commonly used three-character verbs and objects), such as the letters CL in the CRTCLPGM (Create CL Program) command. Some command names consist of the verb only, such as the MOV (Move) command, or an object only, such as the DATA (Data) command. For a complete list of all abbreviations used in command (and keyword) names, see the Object Types Used by Commands Containing the OBJTYPE Parameter table. A few commands have an OS/400 command name, and can also be called using one or more alternate names that may be familiar to users of systems other than the OS/400 system. An alternate name is known as an alias, such as the name CD is an alias for the CHGCURDIR (Change Current Directory) command. Aliases are presented in this topic with either the complete command description of the OS/400 command, or with a reference to the command name that presents the complete command description. v Alphabetical listing of commands on page 13 v Commands operating on OS/400 objects v Commands operating on multiple objects on page 60 v Files used by CL commands on page 61 v Printing command descriptions on the AS/400 on page 102
Commands operating on OS/400 objects

Each of the OS/400 object types has a set of commands that operates on that object type. Most OS/400 object types have commands that perform the following actions: v Create (CRT): Creates the object and specifies its attributes. v Delete (DLT): Deletes the object from the system. v Change (CHG): Changes the attributes and/or contents of the object.
59
v Display (DSP): Displays the contents of the object. Display commands cannot be used to operate on objects. v Work with (WRK): Works with the attributes and/or contents of the object. Unlike display commands, work commands allow users to operate on objects and modify applications. For additional information on OS/400 objects, see the following: v Alphabetical listing of commands on page 13 v How commands are named on page 59 v Commands operating on multiple objects v Files used by CL commands on page 61 v Printing command descriptions on the AS/400 on page 102
Commands operating on multiple objects

In addition to the commands that operate on single object types, there are commands that operate on several object types. These commands are more powerful because they can operate on several objects of different types at the same time. For example: v Display object description (DSPOBJD): Displays the common attributes of an object. v Move object (MOVOBJ): Moves an object from one library to another. v Rename object (RNMOBJ): Specifies the new name of an object. v Save object (SAVOBJ): Saves an object and its contents on diskette, tape, or in a save file. v Restore object (RSTOBJ): Restores a saved version of the object from diskette, tape, or from a save file. The following table shows the commands that perform an action on many of the object types. Some of the commands, such as the Move Object (MOVOBJ) command, operate on only one object at a time, but that object can be any one of several OS/400 object types. For example, the MOVOBJ command can move a file or a job description.
Table 1. Commands Operating on Multiple Object Types Item Object Identifier OBJ Actions ALC, CHK, CPR, DCP, DLC, DMP, MOV, RNM, RST, SAV, WRK, CRTDUP, SAVCHG SET CHG DSP, EDT, GRT, RVK DSP CHK WRK CHG, WRK CHG, WRK
Object Access Object Auditing Object Authority Object Description Object Integrity Object Lock Object Owner Object Primary Group
OBJACC OBJAUD OBJAUT OBJD OBJITG OBJLCK OBJOWN OBJPGP
You can also can refer to the Object Types Used by Commands Containing the OBJTYPE Parameter table in OBJTYPE parameter on page 145 to see how these multiple-object commands affect specific object types.
60
v v v v v
Alphabetical listing of commands on page 13 How commands are named on page 59 Commands operating on OS/400 objects on page 59 Printing command descriptions on the AS/400 on page 102 Files used by CL commands
Files used by CL commands

Many of the IBM-supplied CL commands use database and device files during processing. This section provides a cross-reference between the commands and the IBM-supplied files used by the commands. All of the commands and files for all AS/400 licensed programs that meet the following criteria are included: v The types of files included are: Database files: physical (PF) and logical (LF), including files with data and files used as model files (no data) Device files: diskette (DKTF), tape (TAPF), and printer (PRTF) v The files are included only if a user might have a reason to use them, such as declaring them in a program so they can be overridden with another file. Two examples: You want to change some attributes for a printer device file, such as the font to be used or the printed lines per inch (the FONT or LPI parameter). You want to override the IBM-supplied file with your own output file (when valid). The types of files not included in this section are: v AS/400-provided display (DSPF) device files, because they should not be changed or overridden. v Most of the AS/400-provided database files used by directory commands, document library object commands, and optical index database files because they cannot be overridden. As mentioned, IBM-supplied physical (PF) or logical (LF) files that are used as model files for certain commands are included in the following table. (Examples are the model files listed under the DSPFD, DSPJRN, and STRPFRMON commands.) In most cases, these model files do not contain data; instead, they contain the definitions (or record formats) of the files to be created for storing the actual output data resulting from use of these commands. For the record formats of these files, you can display the files description online or you can refer to the publication or soft-copy manual that documents that command. Additionally, some files considered to be IBM-supplied files do not actually exist on the system until some function is used that requires the file and so creates it at that time. The following notes describe how the table of commands and files are sorted and explain the meanings of the superscripts used in the table.
Notes for Table: 1. The first column of the table lists the CL commands that use the AS/400-provided files shown in the third column. The table entries are in alphabetic order by command name first. If there is more than one library for a command, they are further ordered by the file library name and then by file name within each library.
61
Files Used by CL Commands

1. A superscript 1 (1) following the description of a file indicates that the file is used only when the output from the command is directed to that form of outputby an output-related parameter on the command. v The superscript 1 is used at the end of printer file (PRTF) descriptions to show that use of the printer file is dependent on the job environment and the print-related value specified (or assumed) on the command. For commands with an OUTPUT parameter (primarily DSPxxx and WRKxxx commands), the output is printed either when OUTPUT(*) is specified in a batch job, or when OUTPUT(*PRINT) is specified in a batch or interactive job. For other commands, the output is printed if an *PRINT, *LIST, and/or *SRC value is specified on a different parameter. v The superscript 1 is used at the end of database file (PF or LF) descriptions to show that use of the database file is dependent on the print-related value specified (or assumed) on the command. For commands with an OUTPUT parameter (primarily DSPxxx and SAVxxx commands), the output is directed to the database file when OUTPUT(*OUTFILE) is specified. The same is true for other commands that specify a value similar to *OUTFILE on one of its parameters. 1. A superscript 2 (2) following a files description indicates that the file is a model file and not an output file. As a model file, it defines the record format of the file created to contain the actual output. 1. Those files showing user-lib as the file library do not exist on the system until the user creates them. When the command is used, the file is created in the users specified library with the file name shown. Table 2. Files Used by CL Commands File Command Name Library ADDCALITM QOFC ADDDOCCVN QUSRSYS
File Name QAOYADDITM QAO1CRL
File Type PF LF
QUSRSYS
QAO1CVNP
PF
QUSRSYS ADDDSTQ ADDDSTRTE QUSRSYS QUSRSYS QUSRSYS QUSRSYS QUSRSYS QUSRSYS
QAO1DCVN QASNADSQ QASNADSQ QASNADSR QASNADSA QANFNJE QAOFENRA
PRTF PF PF PF PF PF PF
ADDDSTSYSN ADDNETJOBE ADDOFCENR
ADDSOCE ADDTAPCTG
QUSRSYS QUSRSYS QUSRSYS QUSRSYS QUSRSYS QUSRSYS
QAALSOC QATAMID QLTAMID QATACGY QLTACGY QATOCHOST
PF PF LF PF LF PF
ADDTCPHTE
File Usage Add calendar item model output file.2 Document conversion logical file for input or output. Document conversion physical file for input or output. Document conversion printer file. SNADS distribution queues table. SNADS distribution queues table. SNADS routing table. SNADS secondary node ID table. Network job entry database file. Database file used for OfficeVision enrollment. Sphere of control file. Cartridge ID db file. Cartridge ID logical file. Category db file. Category logical file. TCP/IP host file.
62

Table 2. Files Used by CL Commands (continued) File Command Name Library File Name ADDTCPIFC QUSRSYS QATOCIFC ADDTCPPORT ADDTCPRSI ADDTCPRTE ADDTXTIDXE QUSRSYS QUSRSYS QUSRSYS QUSRSYS QATOCPORT QATOCRSI QATOCRTE QABBADMTB
File Type PF PF PF PF PF
ANSQST ANZACCGRP
QSYS QPFR QPFR
QPQAPRT QAPTDDS QAPTPAGD
PRTF PF PF
QPFR
QPPTPAG
PRTF
ANZDBF
QPFR
QAPTAZDR
PF
QPFR QPFR
QAPTDDS QPPTANZD
PF PRTF
ANZDBFKEY
QPFR
QAPTAZDR
PF
QPFR QPFR
QAPTDDS QPPTANKM
PF PRTF
QPFR
QPPTANZK
PRTF
File Usage TCP/IP configuration file. TCP/IP configuration file. TCP/IP configuration file. TCP/IP configuration file. OfficeVision text search services administration table. Q & A printer file. Performance data DDS source file. Performance database input file of files and programs in a process access group (PAG). Printer file of PAG data containing environment, job, file, and program summary data. Performance data collection file: analyze application database files data. Performance data DDS source file. Performance printer file showing physical-to-logical and logical-to-physical database file relationships. Performance input file of analyze application database files data showing logical file key structures. Performance data DDS source file. Performance printer file containing logical file key structure data. Performance printer file containing access path and record selection data.
63

Table 2. Files Used by CL Commands (continued) File Command Name Library File Name ANZPFRDTA QSYS QAPMxxxx
File Type PF
QPFR
QPAVPRT
PRTF
ANZPGM
QPFR
QAPTAZPD
PF
QPFR
QPPTANZP
PRTF
ASKQST CFGDSTSRV
QSYS QUSRSYS QUSRSYS QUSRSYS
QPQAPRT QASNADSA QASNADSQ QASNADSR QATOCIFC QATOCRTE QATOCTCPIP QATOCPORT QATOCRSI QATOCHOST QATOCPS QATMSMTP QATMSMTPA QAO1CRL
PRTF PF PF PF PF PF PF PF PF PF PF PF PF LF
CFGTCP
QUSRSYS QUSRSYS QUSRSYS QUSRSYS QUSRSYS QUSRSYS QUSRSYS QUSRSYS QUSRSYS QUSRSYS
CFGTCPSMTP CHGDOCCVN
CHGDTA
QIDU QIDU
QDTALOG QDTAPRT
PRTF PRTF
QSYS QSYS CHGDSTQ CHGDSTRTE QUSRSYS QUSRSYS QUSRSYS
QPDZDTALOG QPDZDTAPRT QASNADSQ QASNADSQ QASNADSR
PRTF PRTF PF PF PF
File Usage QAPMxxxx performance data collection files, where xxxx = ASYN, BSC, CIOP, CONF, DIOP, DISK, ECL, ETH, HDLC, IDLC, JOBS, LAPD, LIOP, MIOP, POOL, SYS, and X25.2 Performance printer file containing the advisor report.1 Performance data collection file: analyze application programs data. Performance printer file showing program-to-file and file-to-program relationships. Q & A printer file. SNADS secondary node ID table. SNADS destination queues table. SNADS destination systems routing table. TCP/IP interface file. TCP/IP route file. TCP/IP attributes file. TCP/IP port restrictions file. TCP/IP RSI file. TCP/IP hostname file. TCP/IP services file. TCP/IP SMTP file. TCP/IP SMTP file. Document conversion logical file for input or output. Audit control log printer file. Record and accumulator total printer file. DFU run-time audit log. DFU run-time printer data file. SNADS distribution queues table. SNADS distribution queues table. SNADS routing table.
64

Table 2. Files Used by CL Commands (continued) File Command Name Library File Name CHGFTPA QUSRSYS QATMFTP CHGHTTPA CHGLPDA CHGOFCENR QUSRSYS QUSRSYS QUSRSYS QATMHTTP QATMLPD QAOFENRA
File Type PF PF PF PF
CHGPOPA CHGPRB
QUSRSYS QUSRSYS QUSRSYS
QATMPOPA QASXNOTE QASXPROB QPQAPRT QATMSMTP QATAMID QATAMID QATOCTCPIP QATOCHOST QATOCIFC QATOCRTE QATMTELN QATMWSG QSYSTAPE QSYSDKT QPCMPIMG QAPZCMPL
PF PF PF PRTF PF PF LF PF PF PF PF PF PF TAPF DKTF PRTF PF
CHGQSTDB CHGSMTPA CHGTAPCTG
CHGTCPA CHGTCPHTE CHGTCPIFC CHGTCPRTE CHGTELNA CHGWSGA CHKTAP CLRDKT CMPJRNIMG CMPPTFLVL
QUSRSYS QUSRSYS QUSRSYS QUSRSYS QUSRSYS QUSRSYS QSYS QSYS QSYS QSYS
CPYF CPYFRMDKT CPYFRMQRYF CPYFRMTAP CPYIGCTBL
QSYS QSYS QSYS QSYS QSYS
QSYSPRT QSYSPRT QSYSPRT QSYSPRT QSYSDKT
PRTF PRTF PRTF PRTF DKTF
QSYS
QSYSTAP
TAPF
File Usage TCP/IP FTP configuration file. TCP/IP HTTP file. TCP/IP LPD configuration file. Database file used for OfficeVision enrollment. POP server configuration file. Problem log user notes file. Problem log problem file. Q & A printer file. TCP/IP SMTP configuration file. Cartridge ID database file. Cartridge ID logical database file. TCP/IP attributes file. TCP/IP host file. TCP/IP interface file. TCP/IP routes file. TCP/IP TELNET configuration file. TCP/IP Workstation Gateway file. Printer file for tape output. Diskette device file used for output. Compare journal images printer file. Model output file for Compare PTF Level command. Copy file printer file.1 Copy file printer file.1 Copy file printer file.1 Copy file printer file.1 Diskette device file used for input and output. Tape device file used for input and output.
65

Table 2. Files Used by CL Commands (continued) File Command Name Library File Name CPYPFRDTA QSYS QAPMxxxx
File Type PF
CPYPTF
QSYS
QSYSDKT
DKTF
QSYS CPYSRCF CRTAPAR QSYS QSYS QSYS CRTBESTMDL user-lib
QSYSTAP QSYSPRT QSYSDKT QSYSTAP QACYMDLS
TAPF PRTF DKTF TAPF PF
CRTBNDC CRTBNDCL
QGPL QGPL QSYS
QCSRC QCLSRC QSYSPRT QRPGLESRC QSYSPRT QCBLLESRC
PF PF PRTF PF PRTF PF
CRTBNDRPG
QGPL QSYS
CRTCBLMOD
QGPL
QSYS
QSYSPRT
PF
CRTCBLPGM
QGPL QSYS
QLBLSRC QSYSPRT QCBLLESRC
PF PRTF PF
CRTBNDCBL
QGPL
QSYS
QSYSPRT
PF
CRTCLD
QGPL
QCLDSRC
PF
QSYS
QSYSPRT
PRTF
File Usage QAPMxxxx performance data collection files, where xxxx = ASYN, BSC, BUS, CIOP, CONF, DIOP, DISK, DMPT, ECL, ETH, HDLC, IOBS, JOBS, LIOP, MIOP, POOL, RESP, RWS, SBSD, SYS, TSK, and X25.2 Diskette device file used for input and output. Tape device file used for input and output. Copy file printer file.1 Diskette device file used for output. Tape device file used for output. BEST/1** file of capacity planning models. C/400 source default input file. CL source default input file. CL source listing printer file.1 ILE RPG/400 source default input file ILE RPG/400 source listing printer file. ILE COBOL/400 source default input file. ILE COBOL/400 source listing printer file. COBOL/400 source default input file. COBOL/400 source listing printer file.1 ILE COBOL/400 source default input file. ILE COBOL/400 source listing printer file. C locale description default source input file. C locale description source listing printer file.1
66

Table 2. Files Used by CL Commands (continued) File Command Name Library File Name CRTCLMOD QGPL QCLSRC QSYS CRTCLPGM QGPL QSYS CRTCMD QGPL QSYSPRT QCLSRC QSYSPRT QCMDSRC
File Type PF PRTF PF PRTF PF
QSYS
QSYSPRT
PRTF
CRTCMOD
QGPL QSYS
QCSRC QSYSPRT QDDSSRC QPDDSSRC QDDSSRC QPDDSSRC QAOIASCI QAOIASCM QAOIASCT QAOIXLAT QDDSSRC QPDDSSRC QMNUSRC QSYSPRT QDDSSRC
PF PRTF PF PRTF PF PRTF PF PF PF PF PF PRTF PF PRTF PF
CRTDSPF
QGPL QSYS
CRTICFF
QGPL QSYS
CRTLASREP
QGPL QGPL QGPL QOSI QGPL QSYS
CRTLF
CRTMNU
QGPL QSYS
CRTMSGFMNU
QGPL
QGPL
QS36DDSSRC
PF
QSSP QSYS CRTPF QGPL QSYS
QPUTMENU QSYSPRT QDDSSRC QPDDSSRC
PRTF PRTF PF PRTF
File Usage CL source default input file. CL source listing printer file.1 CL source default input file. CL source listing printer file.1 Command definition source default input file. Command definition source listing printer file. C/400 source default input file. C/400 source listing printer file.1 DDS source default input file. DDS source listing printer file.1 DDS source default input file. DDS source listing printer file.1 Default source physical file. Default source input file. Default metatable file. Translation file. DDS source default input file. DDS source listing printer file.1 Default menu source input file. Menu source listing printer file.1 DDS source created for menu by $BMENU. DDS source created for menu by $BMENU. $BMENU source listing printer file. Pascal source listing printer file.1 DDS source default input file. DDS source listing printer file.1
67

Table 2. Files Used by CL Commands (continued) File Command Name Library File Name CRTPGM QSYS QSYSPRT CRTPNLGRP QGPL QSYS CRTPRTF QGPL QSYS CRTQSTDB QSYS QSYS CRTQSTLOD CRTRJEBSCF CRTRJECFG QSYS QRJE QRJE QPNLSRC QSYSPRT QDDSSRC QPDDSSRC QAQA00xxxx QAQA00xxxx QPQAPRT QRJESRC QRJESRC
File Type PRTF PF PRTF PF PRTF LF PF PRTF PF PF
CRTRJECMNF
QRJE
QRJESRC
PF
CRTRMCPGM
QGPL
QRMCSRC
PF
QSYS
QSYSPRT
PRTF
CRTRPGMOD
QGPL QSYS
QRPGLESRC QSYSPRT QRPGSRC QSYSPRT QRPGSRC QSYSPRT QCSRC QSYSPRT QCSRC QSYSPRT QLBLSRC QSYSPRT QCBLLESRC QSYSPRT
PF PRTF PF PRTF PF PRTF PF PRTF PF PRTF PF PRTF PF PRTF
CRTRPGPGM
QGPL QSYS
CRTRPTPGM
QGPL QSYS
CRTSQLC CRTSQLCI CRTSQLCBL
QGPL QSYS QGPL QSYS QGPL QSYS
CRTSQLCBLI
QGPL QSYS
File Usage Program source listing printer file.1 Default panel group source input file. Panel group source listing printer file.1 DDS source default input file. DDS source listing printer file.1 Q & A database model files.2 Q & A database model files.2 Q & A printer file. DDS source file used to create RJE BSC file. DDS source file used to create RJE BSC or RJE communications file. DDS source file used to create RJE communications file. RM/COBOL-85 source default input file. RM/COBOL-85 source listing printer file.1 ILE RPG/400 source default input file. ILE RPG/400 source listing printer file.1 RPG source default input file. RPG source listing printer file.1 RPG source default input file. RPG source listing printer file.1 SQL C source file. SQL C printer file.1 SQL C source file. SQL C printer file.1 SQL COBOL source file. SQL COBOL printer file.1 SQL COBOL source file. SQL COBOL printer file.1
68

Table 2. Files Used by CL Commands (continued) File Command Name Library File Name CRTSQLFTN QGPL QFTNSRC QSYS CRTSQLPLI CRTSQLRPG CRTSQLRPGI CRTSRVPGM QGPL QSYS QGPL QSYS QGPL QSYS QSYS QSYSPRT QPLISRC QSYSPRT QRPGSRC QSYSPRT QRPGLESRC QSYSPRT QSYSPRT
File Type PF PRTF PF PRTF PF PRTF PF PRTF PRTF
CRTS36CBL
#LIBRARY
QS36SRC
PF
QSYS
QSYSPRT
PRTF
CRTS36DSPF
QGPL
QDDSSRC
PF
QGPL
QS36DDSSRC
PF
QSSP CRTS36MNU QGPL
QPUTSFGR QDDSSRC
PRTF PF
QGPL
QS36DDSSRC
PF
QSSP CRTS36RPG #LIBRARY
QPUTMENU QS36SRC
PRTF PF
QSYS
QSYSPRT
PRTF
CRTS36RPGR
#LIBRARY
QS36SRC
PF
CRTS36RPT
#LIBRARY
QS36SRC
PF
QSYS
QSYSPRT
PRTF
CRTTAPCGY
QUSRSYS QUSRSYS
QATACGY QLTACGY
PF LF
File Usage SQL FORTRAN source file. SQL FORTRAN printer file.1 SQL PLI source file. SQL PLI printer file.1 SQL RPG source file. SQL RPG printer file.1 SQL RPG source file. SQL RPG printer file.1 Service program source listing printer file.1 S/36-compatible COBOL source default input file. S/36-compatible COBOL source listing printer file.1 DDS source created for display file by $SFGR. DDS source created for display file by $SFGR. $SFGR source listing printer file. DDS source created for menu by $BMENU. DDS source created for menu by $BMENU. $BMENU source listing printer file. System/36 RPG II source default input file. System/36 RPG II source listing printer file.1 System/36 RPG II source default input file. System/36 RPG II Auto Report source default input file. System/36 RPG II Auto Report source listing printer file.1 Library device database file. Library device logical database file.
69

Table 2. Files Used by CL Commands (continued) File Command Name Library File Name CRTTBL QGPL QTBLSRC CVTPFRDTA QPFR QACPxxxx
File Type PF PF
QPFR
QAITMON
PF
QSYS
QAPMyyyy
PF
QSYS
QAPMzzzz
PF
QPFR
QAPTAPGP
PF
CVTRPGSRC
user-lib user-lib QSYS user-lib
QRPGSRC QRPGLESRC QSYSPRT QRNCVTLG QAALERT QACYMDLS
PF PF PRTF PF PF PF
DLTALR DLTBESTMDL
QUSRSYS user-lib
DLTPFRDTA
QPFR
QAPGSUMD
PF
QSYS
QAPMxxxx
PF
File Usage Table source default input file. QACPxxxx performance data collection files, where xxxx = CNFG, GPHF, PROF, and RESP. Performance data collection file: job and Licensed Internal Code task data. QAPMyyyy performance data collection files, where yyyy = CIOP, CONF, DIOP, DISK, JOBS, LIOP, POOL, RESP, RWS, and SYS.2 QAPMzzzz performance data collection files, where zzzz = ASYN, BSC, BUS, DMPT, ECL, ETH, HDLC, MIOP, and X25.2 Performance data collection file for functional area data. RPG/400 source file (from file). ILE RPG/400 source file (to file). ILE RPG/400 listing printer file. ILE RPG/400 conversion log file. Alert database file. BEST/1 file of capacity planning models. Performance data collection file for graphics data. QAPMxxxx performance data collection files, where xxxx = ASYN, BSC, BUS, CIOP, CONF, DIOP, DISK, DMPT, ECL, ETH, HDLC, IOBS, JOBS, LIOP, MIOP, POOL, RESP, RWS, SBSD, SYS, TSK, and X25.2
70

Table 2. Files Used by CL Commands (continued) File Command Name Library File Name QPFR QAPTLCKD
File Type PF
QPFR
QTRxxxx
PF
File Usage Performance data collection file: lock and seizure conflict data. QTRxxxx performance data collection files, where xxxxx = IDX, JOBT, JSUM, SLWT, and TSUM.
DLTPRB Command: All 8 of the QASXxxxx files for the DLTPRB command are the same subset of files that are shown in the QUSRSYS library for the DSPPRB command. For the descriptions of these files, see the DSPPRB command. DLTPRB QUSRSYS QASXxxxx PF See the DSPPRB command. DLTQST QSYS QPQAPRT PRTF Q & A printer file. DLTQSTDB QSYS QPQAPRT PRTF Q & A printer file. DLTTAPCGY QUSRSYS QATACGY PF Library device database file. QUSRSYS QLTACGY LF Library device logical database file. DMPCLPGM QSYS QPPGMDMP PRTF CL program dump printer file. DMPJOB QSYS QPSRVDMP PRTF Service dump printer file. DMPOBJ QSYS QPSRVDMP PRTF Service dump printer file. DMPSYSOBJ QSYS QPSRVDMP PRTF Service dump printer file. DMPTAP QSYS QPTAPDMP PRTF Tape dump printer file. DMPTRC QSYS QAPMDMPT PF Performance trace file. QSYS QSYSPRT PRTF SDA source printer file. DSPACC QSYS QSYSPRT PRTF Display access codes printer file.1 DSPACCAUT QSYS QSYSPRT PRTF Display access code authority printer file.1 DSPACCGRP QPFR QAPTDDS PF Performance data DDS source file. QPFR QAPTPAGD PF Performance data collection file: data about files and programs in a process access group (PAG). QPFR QPPTPAG PRTF Display process access group printer file.1 QPFR QPPTPAGD PRTF Performance printer file containing files and programs in a process access group (PAG). DSPACTPJ QSYS QSYSPRT PRTF Display active prestart jobs printer file.1
71

Table 2. Files Used by CL Commands (continued) File Command Name Library File Name DSPAPPNINF QUSRSYS QALSxxx
File Type PF
QSYS
QSYSPRT
PRTF
DSPAUTHLR
QSYS
QADSHLR
PF
QSYS DSPAUTL QSYS
QPSYDSHL QAOBJAUT
PRTF PF
QSYS DSPAUTLDLO DSPAUTLOBJ QSYS QSYS
QPOBJAUT QSYSPRT QADALO
PRTF PRTF PF
QSYS
QPSYDALO
PRTF
DSPAUTUSR DSPBCKSTS DSPBCKUP DSPBCKUPL DSPBKP DSPBNDDIR
QSYS QSYS QSYS QSYS QSYS QSYS
QPAUTUSR QSYSPRT QSYSPRT QSYSPRT QPDBGDSP QABNDBND
PRTF PRTF PRTF PRTF PRTF PF
QSYS
QSYSPRT
PRTF
DSPCALAUT
QOFC
QAOYCALAUT
PF
File Usage Set of 4 QALSxxx model database files that contain the record formats used for storing APPN information, where xxx = DIR, END, INM, and TDB.2 Display APPN information printer file.1 Model database file that contains the record format for the authority holder object entries.2 Display authority holders printer file.1 Model database file that contains the record format for the authorization list entries.2 Authorization list entries printer file.1 Authorization list printer file.1 Model database file that contains the record format for the authorization list object entries.2 Display authorization list objects printer file.1 Authorized users printer file.1 Display backup status printer file.1 Display backup options printer file.1 Display backup list printer file.1 Breakpoint (debug mode) printer file.1 Model database file that contains the record format for the binding directory entries.2 Displays the contents of the binding directory printer file.1 Display calendar authority model output file.2
72

Table 2. Files Used by CL Commands (continued) File Command Name Library File Name QSYS QSYSPRT DSPCALD QOFC QAOYDSPCAL
File Type PRTF PF
QSYS
QSYSPRT
PRTF
DSPCALITM
QOFC QSYS
QAOYDSPITM QSYSPRT QPDCCFGL QPGDDM QPDSPCLS QPCMD QPDCCNNL QSYSPRT QPDCCOS
PF PRTF PRTF PRTF PRTF PRTF PRTF PRTF PRTF
DSPCFGL DSPCHT DSPCLS DSPCMD DSPCNNL DSPCNNSTS DSPCOSD
QSYS QSYS QSYS QSYS QSYS QSYS QSYS
DSPCSI
QSYS
QSYSPRT
PRTF
DSPCTLD DSPDBG DSPDBR
QSYS QSYS QSYS
QPDCCTL QPDBGDSP QADSPDBR
PRTF PRTF PF
QSYS
QPDSPDBR
PRTF
DSPDDMF
QSYS
QPDSPDDM
PRTF
DSPDEVD QSYS
QSYS QAOSDIRO
QPDCDEV PF
PRTF Display directory output file: OUTFILFMT(*TYPE1)
File Usage Display calendar authority printer file.1 Display calendar description model output file.2 Display calendar description printer file.1 Display calendar item model output file.2 Display calendar item printer file.1 Configuration list printer file.1 BGU-defined chart output printer file.1 Class printer file.1 Command values printer file.1 Connection list printer file.1 Connection status printer file.1 Class-of-service description printer file.1 Communications side information printer file.1 Controller description printer file.1 Debug display (debug mode) printer file.1 Model database file that defines the record format of the file created to store information about database file relationships.2 Printer file that contains information about database file relationships.1 Distributed data management (DDM) file listing printer file.1 Device description printer file.1
73

Table 2. Files Used by CL Commands (continued) File Command Name Library File Name QSYS QAOSDIRB
File Type PF
QSYS
QAOSDIRF
PF
QSYS
QAOSDIRX
PF
QSYS
QPDSPDDL
PRTF
QSYS
QPDSPDSM
PRTF
DSPDKT
QSYS
QPDSPDKT
PRTF
QSYS
QPSRODSP
PRTF
QSYS DSPDLOAUT QSYS
QSYSDKT QSYSPRT
DKTF PRTF
DSPDLONAM
QSYS
QSYSPRT
PRTF
DSPDOCCVN
QUSRSYS
QAO1CRL
LF
QUSRSYS
QAO1CVNP
PF
QUSRSYS DSPDSTL QSYS QSYS QSYS DSPDSTCLGE QSVMSS
QAO1DCVN QAOSDSTO QPDSPLDL QPDSPLSM QACQFVOF
PRTF PF PRTF PRTF PF
DSPDSTLOG DSPDSTSRV
QSYS QSYS QUSRSYS
QPDSTDLG QPDSTSRV QASNADSA
PRTF PRTF PF
File Usage Display directory output file: OUTFILFMT(*TYPE2) DETAIL(*BASIC) Display directory output file: OUTFILFMT(*TYPE2) DETAIL(*FULL) Display directory output file: OUTFILFMT(*TYPE3) DETAIL(*FULL) Printer file for full details of displayed directory entries.1 Printer file for basic details of displayed directory entries.1 Printer file for diskettes in basic data exchange format.1 Printer file for diskettes in save/restore format.1 Diskette device file for input. Display document library object authority printer file.1 Display document library object printer file.1 Document conversion logical file for input or output.1 Document conversion physical file for input or output.1 Document conversion printer file.1 Distribution list output file. Distribution list details printer file.1 Distribution list summary printer file.1 Output file model for MSS/400 Display Distribution Catalog Entries command.2 Display distribution log printer file.1 Distribution services printer file.1 SNADS secondary node ID table.
74

Table 2. Files Used by CL Commands (continued) File Command Name Library File Name QUSRSYS QASNADSQ QUSRSYS DSPDTA QIDU QSYS QSYS DSPDTAARA DSPDTADCT DSPEDTD DSPFD Command: For the DSPFD command, all of the following entries having a file type of PF are physical files (model files that are not actual output files) that define the record formats of created files used to store a specific type of information about a type (or group) of files. (See theDSPFD command for descriptions of the TYPE and FILEATR parameters. These parameters identify all the values that cause these files to be used.) Therefore, the common part of each model files description begins here and the unique part of each description continues under the File Usage column: Model database file that defines the record format of the file created to store... DSPFD QSYS QSYS QAFDACCP QAFDBASI PF PF ...access path file information.2 ...basic file information common to all files.2 ...BSC file and mixed file device attribute information.2 ...communications file and mixed file device attribute information.2 ... collating sequence information.2 ... constraint relationship information.2 ...distributed data management (DDM) file attribute information.2 ...diskette file attribute information.2 ...display file and mixed file display device attribute information.2 ...ICF file attribute information.2 ...join logical file information.2 QSYS QSYS QSYS QASNADSR QDTAPRT QPDZDTALOG QPDZDTAPRT QPDSPDTA QPDSPFFD QPDCEDSP
File Type PF PF PRTF PRTF PRTF PRTF PRTF PRTF
File Usage SNADS destination queues table. Routing table database file. DFU audit control printer file. DFU run-time audit log. DFU run-time printer data file. Data area printer file.1 Data dictionary printer file.1 Edit description printer file.1
QSYS
QAFDBSC
PF
QSYS
QAFDCMN
PF
QSYS QSYS
QAFDCSEQ QAFDCST
PF PF
QSYS
QAFDDDM
PF
QSYS QSYS
QAFDDKT QAFDDSP
PF PF
QSYS QSYS
QAFDICF QAFDJOIN
PF PF
75

Table 2. Files Used by CL Commands (continued) File Command Name Library File Name QSYS QAFDLGL QSYS QSYS QSYS QSYS QSYS QSYS QSYS QSYS QSYS QSYS QSYS QSYS DSPFFD QSYS QAFDMBR QAFDMBRL QAFDNGP QAFDPHY QAFDPRT QAFDRFMT QAFDSAV QAFDSELO QAFDSPOL QAFDTAP QAFDTRG QPDSPFD QADSPFFD
File Type PF PF PF PF PF PF PF PF PF PF PF PF PRTF PF
QSYS DSPFLR QSYS QSYS QSYS DSPFNTRSCA DSPGDF DSPGNDDIR QSYS QSYS QSYS
QPDSPFFD QADSPDOC QADSPFLR QPDSPFLR QPDSPFNT QPGDDM QABNDBND
PRTF PF PF PRTF PRTF PRTF PF
File Usage ...logical file attribute information.2 ...database member information.2 ...database member list information.2 ... node group information.2 ...physical file attribute information.2 ...printer file attribute information.2 ...record format information.2 ...save file information.2 ...select/omit information.2 ...device file spooled information.2 ...tape file attribute information.2 ... trigger information.2 File description printer file.1 Model database file that defines the record format of the file created to store file field descriptions.2 File field description printer file.1 Document list output database file. Folder list output database file. Display folder printer file.1 Font resource attributes printer file.1 BGU-defined graphics data printer file.1 System-supplied output file.1
DSPHDWRSC Command: For the DSPHDWRSC command, all of the following entries having a file type of PF are physical files (model files that are not actual output files) that define the record formats of created files used to store a specific type of hardware resource information. Therefore, the common part of each model files description begins here and the unique part of each description continues under the File Usage column: Model database file that defines the record format of the file created to store information about... DSPHDWRSC QSYS QARZDCMN PF ...communications resources.2
76

Table 2. Files Used by CL Commands (continued) File Command Name Library File Name QSYS QARZDLWS QSYS QSYS QARZDPRC QARZDTRA
File Type PF PF PF
QSYS QSYS DSPHFS QSYS
QARZDSTG QSYSPRT QSYSPRT
PF PRTF PRTF
DSPHSTGPH DSPIDXSTS
QPFR QUSRSYS
QPPGGPH QABBADMTB
PRTF PF
DSPIGCDCT DSPJOB DSPJOBD DSPJOBLOG
QPDSPDCT QPDSPJOB QPRTJOBD QPJOBLOG QPJOBLOGO
PRTF PRTF PRTF PRTF PRTF
QSYS QSYS DSPJRN Command:
QAMHJLPR QAMHJLSC
PF PF
File Usage ...local work station resources.2 ...processor resources.2 ...token-ring local area network (TRLAN) adapter resources.2 ...storage device resources.2 Hardware resources printer file.1 Display hierarchical file systems printer file.1 Display historical graph printer file.1 OfficeVision text search services administration table. DBCS printer file.1 Display job printer file.1 Job description printer file.1 Job log printer file.1 Job log printer file for jobs prior to Version 2 Release 3 of the AS/400.1 Primary job log model file.2 Secondary job log model file.2
All of the following files for the DSPJRN command having a file type of PF are physical files (model files, not actual output files) that define the record formats of files created to store a group of journal entries retrieved and converted from journal receivers. The retrieved group of entries can be a specific type of information or all types of information that was journaled. Each created file stores the retrieved journal entries after they are converted into one of four basic formats (*TYPE1, *TYPE2, *TYPE3 or *TYPE4) or into the format defined for the specific type of data being retrieved. v *TYPE1: the basic file format described in the Backup and Recovery book. v *TYPE2: all of *TYPE1 plus the user profile field. v *TYPE3: all of *TYPE2 plus the null value indicators. v *TYPE4: all of *TYPE3 plus the JID, referential integrity and trigger information. v Type-dependent format - the format associated with the specific type (as described below for the fourth and following files) of information being retrieved. For example, the model file QASYAFJE has a unique format for storing all retrieved journal entries related to authority failures (AF) on the system. For the DSPJRN PF files listed below, the common part of all the model files descriptions begins here and the unique part of each files description continues under the File Usage column: Model database file that defines the record format of the file created to contain retrieved and converted journal entries related to... DSPJRN QSYS QADSPJRN PF ...a specific type (or all types) of information; stored in the *TYPE1 format.2
77

Table 2. Files Used by CL Commands (continued) File Command Name Library File Name QSYS QADSPJR2
File Type PF
QSYS
QADSPJR3
PF
QSYS
QADSPJR4
PF
QSYS QSYS QSYS QSYS QSYS QSYS QSYS QSYS QSYS QSYS QSYS QSYS
QADXERLG QADXJRNL QAJBACG QALZALK QALZALL QALZALU QAPTACG QATOSLOG QASYADJE QASYAFJE QASYAPJE QASYCAJE
PF PF PF PF PF PF PF PF PF PF PF PF
QSYS QSYS QSYS
QASYCDJE QASYCOJE QASYCPJE
PF PF PF
QSYS QSYS QSYS
QASYCQJE QASYDOJE QASYDSJE
PF PF PF
QSYS QSYS QSYS
QASYGSJE QASYIPJE QASYJDJE
PF PF PF
QSYS
QASYJSJE
PF
File Usage ...a specific type (or all types) of information; stored in the *TYPE2 format.2 ...a specific type (or all types) of information; stored in the *TYPE3 format.2 ...a specific type (or all types) of information; stored in the *TYPE4 format.2 ...DSNX logged errors.2 ...DSNX logged data.2 ...job accounting.2 ...invalid license keys.2 ...usage limit increases.2 ...licensed users that exceed usage limits.2 ...print job accounting.2 ...SNMP log entries.2 ...changes to auditing attributes.2 ...authority failures.2 ...use of adopted authority.2 ...changes to object authority (authorization list or object).2 ...command strings.2 ...objects created on the system.2 ...create, change, and restore user profile operations.2 ...changes to *CRQD object.2 ...objects deleted from the system.2 ...resetting the DST security officer password.2 ...gives of descriptors.2 ...interprocess communications.2 ...changes to the USER parameter of job descriptions.2 ...job changes.2
78

Table 2. Files Used by CL Commands (continued) File Command Name Library File Name QSYS QASYLDJE QSYS QSYS QSYS QSYS QSYS QSYS QSYS QSYS QSYS QSYS QSYS QASYMLJE QASYNAJE QASYNDJE QASYNEJE QASYOMJE QASYORJE QASYOWJE QASYO1JE QASYO2JE QASYO3JE QASYPAJE
File Type PF PF PF PF PF PF PF PF PF PF PF PF
QSYS QSYS QSYS QSYS
QASYPGJE QASYPOJE QASYPSJE QASYPWJE
PF PF PF PF
QSYS
QASYRAJE
PF
QSYS
QASYRJJE
PF
QSYS
QASYROJE
PF
QSYS
QASYRPJE
PF
QSYS QSYS
QASYRQJE QASYRUJE
PF PF
File Usage ...link/unlink/lookup directory.2 ...mail actions.2 ...changes to network attributes.2 ...directory search violations.2 ...end point violations.2 ...object move and rename operations.2 ...object restore operations.2 ...changes to object ownership.2 ...single optical object accesses.2 ...dual optical object accesses.2 ...optical volume accesses.2 ...changes to programs (CHGPGM) that will now adopt the owners authority.2 ...changes to object primary group.2 ...printer output actions.2 ...profile swapping.2 ...attempted usage of invalid passwords or user profile names.2 ...restore of objects when authority changes.2 ...restore of job descriptions that contain user profile names.2 ...restore of objects when ownership was changed to QDFTOWN.2 ...restore of programs that adopt their owners authority.2 ...restores of *CRQD object.2 ...operations restoring authority for user profiles, using the RSTAUT command.2
79

Table 2. Files Used by CL Commands (continued) File Command Name Library File Name QSYS QASYRZJE QSYS QASYSDJE
File Type PF PF
QSYS QSYS QSYS QSYS QSYS QSYS QSYS QSYS QSYS QSYS QSYS QSYS QSYS QSYS QSYS QSYS QSYS
QASYSEJE QASYSFJE QASYSMJE QASYSOJE QASYSTJE QASYSVJE QASYVAJE QASYVCJE QASYVFJE QASYVLJE QASYVNJE QASYVPJE QASYVRJE QASYVSJE QASYVUJE QASYVVJE QASYYCJE
PF PF PF PF PF PF PF PF PF PF PF PF PF PF PF PF PF
QSYS
QASYYRJE
PF
QASYZCJE QASYZMJE QASYZRJE QAWCTPJE QAZDCFLG
PF PF PF PF PF
File Usage ...changes on primary group restores.2 ...changes to the system distribution directory.2 ...changes to subsystem routings.2 ...actions with spooled files.2 ...system management changes.2 ...server security changes.2 ...use of system service tools.2 ...changes to system values.2 ...changes to access control list.2 ...connection starts and ends.2 ...closes of server files.2 ...exceeding account limit.2 ...network logons and logoffs.2 ...network password errors.2 ...accesses to network resources.2 ...server session starts and ends.2 ...changes to network profiles.2 ...changes to service status.2 ...changes to document library objects.2 ...read operations of document library objects.2 ...changes to objects.2 ...object method access.2 ...read operations of objects.2 ...performance tuning.2 ...configuration changes to SNADS distribution queues table.2
80

Table 2. Files Used by CL Commands (continued) File Command Name Library File Name QSYS QAZDERLG QSYS QSYS QAZDJRNL QAZDRTLG
File Type PF PF PF
QSYS
QAZDSYLG
PF
QSYS
QAZMFCF
PF
QSYS
QAZMFER
PF
QSYS
QAZMFLG
PF
QSYS
QAZMFSY
PF
QSYS QX400 QX400
QPDSPJRN QAX4ELOG QAX4MLOG
PRTF PF PF
QX400
QAX4NLOG
PF
QX400 QX400 DSPJRNRCVA QSYS QSYS DSPLIB DSPLIBD DSPLIBL DSPLIND DSPLOG DSPMNUA QSYS QSYS QSYS QSYS QSYS QSYS
QAX4RLOG QAX4ULOG QPDSPRCV QSYSPRT QPDSPLIB QPRTLIBD QPRTLIBL QPDCLINE QPDSPLOG QPDSPMNU
PF PF PRTF PRTF PRTF PRTF PRTF PRTF PRTF PRTF
File Usage ...SNADS logged errors.2 ...SNADS logged data.2 ...changes to SNADS routing and secondary system name tables.2 ...SNADS miscellaneous logged system-level occurrences.2 ...Mail server framework (MSF) configuration changes logging.2 ...Mail server framework (MSF) error logging.2 ...Mail server framework (MSF) data logging.2 ...Mail server framework (MSF) system information logging.2 Display journal printer file.1 ...X.400 logged errors.2 ...changes to X.400 message transfer agent configurations.2 ...X.400 notifications of delivery or nondelivery.2 ...changes to X.400 route configurations.2 ...X.400 user or probe messages.2 Journal receiver attributes printer file.1 Local hardware resources printer file.1 Library printer file.1 Library description printer file.1 Library list printer file.1 Line description printer file.1 Log display printer file.1 Menu attributes printer file.1
81

Table 2. Files Used by CL Commands (continued) File Command Name Library File Name DSPMOD Command:
File Type
File Usage
For the DSPMOD command, all of the following entries having a file type of files used to store a specific type of information about a type (or group) of files. (See theDSPMOD command for a description of the DETAIL parameter. This parameter identifies all the values that cause these files to be used.) Therefore, the common part of each model files description begins here and the unique part of each description continues under the File Usage column: Model database file that defines the record format of the file created to store... DSPMOD QSVMSS QACQSRC PRTF ...contains sources of example security exit programs.1 ...basic information and compatibility sections.1 ...decompressed size and size limits.1 ...symbols defined in this module and exported to others.1 ...defined symbols that are external to this module.1 ...a list of procedure names and types.1 ...a list of system objects referred to by the module at the time the module is bound into a program or service program.1 ...module copyright information. ...module printer file.1 Mode description printer file.1 Mode status printer file.1 Message display printer file.1 Message description printer file.1 Model database file used to define the record format for network file entries.2 Display network attributes printer file.1 Display network job entries printer file.1 Network interface description printer file.1
QSYS
QABNDMBA
PF
QSYS QSYS
QABNDMSI QABNDMEX
PF PF
QSYS
QABNDMIM
PF
QSYS QSYS
QABNDMPR QABNDMRE
PF PF
QSYS QSYS QSYS QSYS QSYS QSYS QSYS
QABNDMCO QSYSPRT QPDCMOD QPDCMOD QPDSPMSG QPMSGD QANFDNTF
PF PRTF PRTF PRTF PRTF PRTF PF
DSPMODD DSPMODSTS DSPMSG DSPMSGD DSPNETA
QSYS QSYS DSPNWID QSYS
QPDSPNET QPNFNJE QPDCNWID
PRTF PRTF PRTF
82

Table 2. Files Used by CL Commands (continued) File Command Name Library File Name DSPOBJAUT QSYS QAOBJAUT
File Type PF
QSYS DSPOBJD QSYS
QPOBJAUT QADSPOBJ
PRTF PF
QSYS DSPOVR DSPPDGPRF QSYS QGPL
QPRTOBJD QPDSPOVR QPCJPDGPRF
PRTF PRTF PRTF
DSPPFRGPH
QPFRDATA
QAPGGPHF
PF
QPFRDATA
QAPGPKGF
PF
QPFR DSPPGM DSPPGMADP QSYS QSYS
QPPGGPH QPDPGM QADPGMAD
PRTF PRTF PF
QSYS
QPPGMADP
PRTF
DSPPGMREF
QSYS
QADSPPGM
PF
QSYS
QPDSPPGM
PRTF
DSPPGMVAR
QSYS
QPDBGDSP
PRTF
File Usage Model database file that defines the record format for the object authority entries.2 Object authority printer file.1 Model database file that defines the record format for the object description entries.2 Object description printer file.1 Display overrides printer file.1 Printer file for print descriptor group profile.1 Performance database file: graph format data. Performance database file: graph package data. Performance graphs printer file.1 Display program printer file.1 Model database file that defines the record format of the file created to store the names of programs that adopt the specified profile.2 Printer file that lists the programs that adopt the specified profile.1 Model database file that defines the record format of the file created to store program references.2 Printer file that contains program references.1 Program variable (debug mode) printer file.1
DSPPRB Command: All 8 of the QASXxxxx files shown below in the QUSRSYS library are also used by the DLTPRB and WRKPRB commands. The other files below (in QSYS) are not used by those commands.
83

Table 2. Files Used by CL Commands (continued) File Command Name Library File Name DSPPRB QSYS QASXxxxx
File Type PF
QSYS QSYS
3
QSXPRTD QSXPRTL
PRTF PRTF
File Usage Set of 5 QASXxxxx model database files that contain the layouts for problem output files, where xxxx = CAOF, FXOF, PBOF, SDOF, and TXOF.2 Problem log detail printer file.1 Problem log summary printer file.1 Problem log call override file. Problem log data identifier file. Problem log event file. Problem log possible cause file. Problem log user notes file. Problem log problem file. Problem log PTF file. Problem log symptom string file. Model database file that defines the record format of the file created to store program temporary fix (PTF) information.2 Display programming temporary fix (PTF) printer file.1 Display power schedule printer file.1 Record locks display printer file.1 Distributed relational database directory printer file.1 RJE configuration printer file.1 Printer file for save file save/restore information.1 Subsystem description printer file.1
The following 8 files are also used by the DLTPRB and WRKPRB commands. QUSRSYS QASXCALL3 PF QUSRSYS QUSRSYS QUSRSYS QUSRSYS QUSRSYS QUSRSYS QUSRSYS QASXDTA3 QASXEVT3 QASXFRU3 QASXNOTE3 QASXPROB3 QASXPTF3 QASXSYMP3 QADSPPTF PF PF PF PF PF PF PF PF
DSPPTF
QSYS
QSYS
QSYSPRT
PRTF
DSPPWRSCD DSPRCDLCK DSPRDBDIRE
QSYS QSYS QSYS
QSYSPRT QPDSPRLK QSYSPRT
PRTF PRTF PRTF
DSPRJECFG DSPSAVF
QRJE QSYS
QPRTCFGC QPSRODSP
PRTF PRTF
DSPSBSD
QSYS
QPRTSBSD
PRTF
84

Table 2. Files Used by CL Commands (continued) File Command Name Library File Name DSPSFWRSC QSYS QARZLCOF
File Type PF
QSYS DSPSOCSTS QSYS QUSRSYS DSPSRVPGM DSPSYSSTS DSPSYSVAL DSPTAP QSYS QSYS QSYS QSYS QSYS
QSYSPRT QSYSPRT QAALSOC QSYSPRT QPDSPSTS QPDSPSVL QPTAPDSP QPSRODSP
PRTF PRTF PF PRTF PRTF PRTF PRTF PRTF
QSYS DSPTAPCGY QSYS QSYS QUSRSYS QUSRSYS DSPTAPCTG QSYS QSYS
QSYSTAP QTAPCGY QATACOF QATACGY QLTACGY QPTACTG QATAVOF
TAPF PRTF PF PF LF PRTF PF
QUSRSYS QUSRSYS DSPTAPSTS QSYS QSYS QSYS QSYS
QATAMID QATAMID QPTAPSTS QATAIOF QSYSTAP QPTYSWTD
PF LF PRTF PF TAPF PRTF
DSPTRAPRF
QSYS
QSYSPRT
PRTF
File Usage Model database file of the file created to store information about IBM licensed programs and SystemView packaged applications.2 Software resources printer file.1 Sphere of control status printer file.1 Sphere of control database file. Service program printer file.1 Display system status printer file.1 System value printer file.1 Printer file for tape output.1 Printer file for tapes in save/restore format.1 Tape device file for input. Printer file for tape categories 1. Model output file for tape categories 2. Library device database file. Library device logical database file. Printer file for tape cartridge identifiers 1. Model output file for tape cartridge identifiers 2. Library device database file. Library device logical database file. Printer file for tape library Model output file for tape Tape device file or input Printer file for printing a telephony switch entry.1 Printer file containing a token-ring network adapter profile.1
85

Table 2. Files Used by CL Commands (continued) File Command Name Library File Name DSPTRC QSYS QPDBGDSP DSPTRCDTA DSPTRNSTS DSPUSRPMN DSPUSRPRF QSYS QSYS QSYS QSYS QPDBGDSP QSYSPRT QSYSPRT QADSPUPA
File Type PRTF PRTF PRTF PRTF PF
QSYS
QADSPUPB
PF
QSYS
QADSPUPO
PF
QSYS DSPWSUSR DUPTAP EDTIGCDCT EDTQST EJTEMLOUT ENDDSKCOL QSYS QSYS QSYS QSYS QSYS QPFR QPFR
QPUSRPRF QSYSPRT QSYSTAP QPDSPDCT QPQAPRT QPEMPRTF QAPTDDS QAPTDSKD
PRTF PRTF TAPF PRTF PRTF PRTF PF PF
ENDIDXMON
QUSRSYS
QABBADMTB
PF
ENDJOBTRC
QPFR QPFR
QAPTDDS QAPTTRCJ
PF PF
QPFR
QPPTTRCD
PRTF
QPFR
QPPTTRC1
PRTF
File Usage Trace (debug mode) printer file.1 Trace data (debug mode) printer file.1 Token-ring network status printer file.1 Display document authority printer file.1 Model database file that defines the record format of user profiles for TYPE(*OBJAUT).2 Model database file that defines the record format of user profiles for TYPE(*BASIC).2 Model database file that defines the record format of user profiles for TYPE(*OBJOWN).2 User profile printer file.1 Work station user printer file.1 Tape device file used for input and output. DBCS printer file. Q & A printer file. Emulation printer file. Performance data DDS source file. Performance data collection file: disk activity data. OfficeVision text search services administration table. Performance data DDS source file. Performance data collection file: job trace data. Performance printer file containing job trace analysis detail data. Performance printer file containing job trace analysis summary data of physical disk activity.
86

Table 2. Files Used by CL Commands (continued) File Command Name Library File Name QPFR QPPTTRC2
File Type PRTF
ENDPRTEML
QSYS QPFR
QPEMPRTF QAPTSAMH
PRTF PF
QPFR
QAPTSAMV
PF
FILLFORM FMTDTA
QOFC QSYS QGPL
QAOEFDTA QSYSPRT QFMTSRC QPUOPRTF
PF PRTF PF PRTF
FNDSTRPART
QPDA
FNDSTRPDM
QPDA
QPUOPRTF
PRTF
HLDDSTQ INZDKT INZTAP LODPTF
QUSRSYS QSYS QSYS QSYS QSYS
QASNADSQ QSYSDKT QSYSTAP QSYSDKT QSYSTAP QAQAxxxx00 QAQA00xxxx QAQA00xxxx QPQAPRT QPAPFPRT
PF DKTF TAPF DKTF TAPF PF LF PF PRTF PRTF
LODQSTDB
QQALIB QSYS QSYS QSYS QPDA
MRGFORMD
MRGTCPHT PRTACTRPT
QUSRSYS user-lib
QATOCHOST QAITMON
PF PF
QPFR
QAPTDDS
PF
File Usage Performance printer file containing job trace analysis I/O summary data. Emulation printer file. Performance data collection file: high-level sampled address monitor (SAM) data. Performance data collection file: low-level sampled address monitor (SAM) data. Model database file for fill-in forms. Data format printer file. Sort source default input file. PDM printer output file for users find string requests. PDM printer output file for users find string requests. SNADS distribution queues table. Diskette device file used for output. Tape device file used for output. Diskette device file used for input. Tape device file used for input. Q & A supplied model database files.2 Q & A database model files.2 Q & A database model files.2 Q & A printer file. Merge form description printer file. TCP/IP hosts file. Performance data collection file: job and Licensed Internal Code task data. Performance data DDS source file.
87

Table 2. Files Used by CL Commands (continued) File Command Name Library File Name QPFR QPITACTR
File Type PRTF
PRTAFPDTA
QSYS
QSYSPRT
PRTF
PRTCAL PRTCMDUSG PRTCMNTRC
QOFC QSYS QSYS
QPOOCAL QSYSPRT QASCCMNT
PRTF PRTF PF
QSYS
QPCSMPRT
PRTF
PRTCPTRPT
QPFR QPFR
QAPTDDS QPPTCPTR
PF PRTF
QSYS
QAPMxxxx
PF
PRTDEVADR PRTDOC
QSYS QSYS QSYS
QPDDEVA QAOPOUFL QSYSPRT QAEZDISK QAEZDISK
PRTF PF PRTF PF PF
PRTDSKINF
QSYS QUSRSYS
QSYS QSYS
QPEZDISK QSYSPRT
PRTF PRTF
PRTDSKRPT
QPFR
QAPTDDS
PF
File Usage Performance printer file containing job and Licensed Internal Code task data. Advanced Function Printing data printer file. Print calendar printer file. Command usage printer file. Model database file that defines the record format of the file created to store communications trace records.2 Communications trace printer file (concurrent service monitor).1 Performance data DDS source file. Performance printer file containing component-level activity data. QAPMxxxx performance data collection files, where xxxx = ASYN, BSC, CIOP, CONF, DIOP, DISK, ECL, ETH, HDLC, JOBS, LIOP, MIOP, POOL, RESP, RWS, and SYS.2 Print device address printer file. Document output database file.1 Print document printer file.1 Model outfile for disk space information. Database input file of disk space information. Disk space report printer file. Disk space report printer file. This file must be specified if using OVRPRTF. Performance data DDS source file.
88

Table 2. Files Used by CL Commands (continued) File Command Name Library File Name QPFR QAPTDSKD
File Type PF
QPFR PRTERRLOG QSYS
QPPTDSK QAPRTELG
PRTF PF
QSYS
QAVOLSTA
PF
QSYS
QPCSMPRT
PRTF
PRTINTDTA
QSYS
QPCSMPRT
PRTF
QSYS PRTJOBRPT QPFR QPFR
QSYSTAP QAPTDDS QPPTITVJ
TAPF PF PRTF
QSYS
QAPMxxxx
PF
PRTJOBTRC
QPFR
QAJOBTRC
PF
QPFR QPFR
QAPTDDS QAPTTRCJ
PF PF
QPFR
QPPTTRCD
PRTF
QPFR
QPPTTRC1
PRTF
QPFR
QPPTTRC2
PRTF
File Usage Performance database input file of disk activity collection data. Printer file of disk unit I/O activity data. Model database file that defines the record format of the file created to store error log records.2 Model database file that defines the record format of the file created to store volume statistics.2 Error log (for concurrent service monitor) printer file.1 Internal data (for concurrent service monitor) printer file. Tape device file used for output. Performance data DDS source file. Performance printer file containing job interval collection data. QAPMxxxx performance data collection files, where xxxx = CONF and JOBS.2 Performance data collection file: job trace data. Performance data DDS source file. Performance data collection file: job trace data. Performance printer file containing job trace analysis detail data. Performance printer file containing job trace analysis summary data of physical disk activity. Performance printer file containing job trace analysis I/O summary data.
89

Table 2. Files Used by CL Commands (continued) File Command Name Library File Name PRTLCKRPT user-lib QAPTLCKD
File Type PF
QPFR QPFR
QAPTDDS QPPTLCK
PF PRTF
QSYS
QAPMDMPT
PF
PRTPOLRPT
QPFR QPFR
QAPTDDS QPPTITVP
PF PRTF
QSYS
QAPMxxxx
PF
PRTRSCRPT
QPFR QPFR
QAPTDDS QPPTITVR
PF PRTF
QSYS
QAPMxxxx
PF
QPFR
QAPTSAMH
PF
QPFR
QAPTSAMV
PF
QPFR PRTSYSRPT QPFR
QPPTSAM QAPTDDS
PRTF PF
File Usage Performance data collection output file containing lock and seizure conflict data. Performance data DDS source file. Performance data collection printer file containing lock and seizure conflict data. Performance data collection input file containing system lock and seizure conflict trace data.2 Performance data DDS source file. Performance printer file containing subsystem and pool activity interval data. QAPMxxxx performance data collection files, where xxxx = CONF, JOBS, and POOL.2 Performance data DDS source file. Performance printer file containing disk and communications line activity interval data. QAPMxxxx performance data collection files, where xxxx = ASYN, BSC, CIOP, CONF, DIOP, DISK, ECL, ETH, HDLC, LIOP, MIOP, RESP, RWS, and SYS.2 Performance data collection file: high-level sampled address monitor (SAM) data. Performance data collection file: low-level sampled address monitor (SAM) data. Printer file of SAM performance data. Performance data DDS source file.
90

Table 2. Files Used by CL Commands (continued) File Command Name Library File Name QPFR QPPTSYSR
File Type PRTF
QSYS
QAPMxxxx
PF
PRTTNSRPT
QPFR QPFR
QAPTDDS QPSPDJS
PF PRTF
QPFR
QPSPDTD
PRTF
QPFR
QPSPDTS
PRTF
QSYS
QAPMxxxx
PF
PRTTRCRPT
user-lib
QTRTJOBT
PF
QPFR QSYS
QAPTDDS QAPMDMPT
PF PF
QRYCALITM QRYDOCLIB QRYDST
QOFC QSYS QSYS QSYS
QAOYQRYITM QAOSIQDL QAOSILIN QAOSILOT QPRCLDMP QAOSIRCV
PF PF PF PF PRTF PF
RCLSTG RCVDST
QSYS QSYS
RCVTIEF RLSDSTQ
QSYS QUSRSYS
QPTIRCV QASNADSQ
PRTF PF
File Usage Performance printer file containing system workload and resource utilization data. QAPMxxxx performance data collection files, where xxxx = ASYN, BSC, CONF, DISK, ECL, ETH, HDLC, JOBS, POOL, SYS, and X25.2 Performance data DDS source file. Performance printer file containing job summary data. Performance printer file containing job state transition data. Performance printer file containing job transaction data. QAPMxxxx performance data collection files, where xxxx = DMPT and JOBS.2 Performance data collection input file containing batch job trace data. Performance data DDS source file. Performance data collection input file containing system trace data.2 Query calendar item model output file.2 Query document library output file. Incoming distribution output file. Outgoing distribution output file. Reclaim dump output listing. Receive incoming mail distribution model database file.2 Received files summary printer file.1 SNADS distribution queues table.
91

Table 2. Files Used by CL Commands (continued) File Command Name Library File Name RMVDOCCVN QUSRSYS QAO1CRL
File Type LF
QUSRSYS
QAO1CVNP
PF
QUSRSYS RMVDSTQ QUSRSYS QUSRSYS QUSRSYS QUSRSYS QUSRSYS QUSRSYS QUSRSYS
QAO1DCVN QASNADSQ QASNADSR QASNADSQ QASNADSR QASNADSA QANFNJE QAOFENRA
PRTF PF PF PF PF PF PF PF
RMVDSTRTE
RMVDSTSYSN RMVNETJOBE RMVOFCENR
RMVSOCE RMVTAPCTG
QUSRSYS QUSRSYS QUSRSYS QUSRSYS QUSRSYS QUSRSYS QUSRSYS QUSRSYS QUSRSYS
QAALSOC QATAMID QLTAMID QATACGY QLTACGY QATOCHOST QATOCIFC QATOCPORT QATOCRSI
PF PF LF PF LF PF PF PF PF
RMVTCPHTE RMVTCPIFC RMVTCPPORT RMVTCPRSI
RMVTCPRTE RMVTXTIDXE
QUSRSYS QUSRSYS
QATOCRTE QABBADMTB
PF PF
RNMTCPHTE RSTCFG
QUSRSYS QSYS QSYS QSYS
QATOCHOST QASRRSTO QPSRLDSP QSYSTAP QAOJRSTO
PF PF PRTF TAPF PF
RSTDLO
QSYS
QSYS
QPRSTDLO
PRTF
QSYS
QSYSDKT
DKTF
File Usage Document conversion logical file for input or output. Document conversion physical file for input or output. Document conversion printer file. SNADS distribution queues table. SNADS routing table. SNADS distribution queues table. SNADS routing table. SNADS secondary node ID table. Network job entry database file. Database file used for OfficeVision enrollment. Sphere of control file. Cartridge ID database file. Cartridge ID logical database file. Category database file. Category logical file. TCP/IP host file. TCP/IP interface file. TCP/IP port restrictions file. TCP/IP resmote system information file. TCP/IP route file. OfficeVision text search services administration table. TCP/IP host file. Model output file for configuration.2 Restored objects status printer file.1 Tape device file used for input. Model output file for restored document library objects.2 Printer file for restored documents and folders.1 Diskette device file used for input.
92

Table 2. Files Used by CL Commands (continued) File Command Name Library File Name QSYS QSYSTAP RSTLIB QSYS QSYS QSYS QSYS RSTLICPGM QSYS QSYS QSYS RSTOBJ QSYS QSYS QSYS QSYS RSTUSRPRF RSTUSRPRF RTVDOC QSYS QSYS QSYS QASRRSTO QPSRLDSP QSYSDKT QSYSTAP QPSRLDSP QSYSDKT QSYSTAP QASRRSTO QPSRLDSP QSYSDKT QSYSTAP QASRRSTO QSYSTAP QAOSIRTV
File Type TAPF PF PRTF DKTF TAPF PRTF DKTF TAPF PF PRTF DKTF TAPF PF TAPF PF
RTVDSKINF
QSYS QUSRSYS
QAEZDISK QAEZDISK QPQUPRFIL QASAVOBJ QPSAVOBJ QSYSTAP QASAVOBJ QPSAVOBJ QSYSDKT QSYSTAP QAOJSAVO
PF PF PRTF PF PRTF TAPF PF PRTF DKTF TAPF PF
RUNQRY SAVCFG
QSYS QSYS QSYS QSYS
SAVCHGOBJ
QSYS QSYS QSYS QSYS
SAVDLO
QSYS
File Usage Tape device file used for input. Model output file for libraries.2 Restored objects status printer file.1 Diskette device file used for input. Tape device file used for input. Restored objects status printer file.1 Diskette device file used for input. Tape device file used for input. Model output file for restored objects.2 Restored objects status printer file.1 Diskette device file used for input. Tape device file used for input. Model output file for user profiles.2 Tape device file used for input. Retrieve document from document library output file. Model file for disk information. Database output file for disk information. Printer file used for query output.1 Model output file for saved objects.2 Printer file for saved objects.1 Tape device file used for output. Model output file for saved objects.2 Printer file for saved objects.1 Diskette device file used for output. Tape device file used for output. Model output file for saved documents and folders.2
93

Table 2. Files Used by CL Commands (continued) File Command Name Library File Name QSYS QPSAVDLO
File Type PRTF
QSYS QSYS SAVLIB QSYS QSYS QSYS QSYS SAVOBJ QSYS QSYS QSYS QSYS SAVSAVFDTA QSYS QSYS QSYS QSYS SAVSECDTA QSYS QSYS QSYS SAVSYS QSYS QSYS QSYS SBMDKTJOB QSYS
QSYSDKT QSYSTAP QASAVOBJ QPSAVOBJ QSYSDKT QSYSTAP QASAVOBJ QPSAVOBJ QSYSDKT QSYSTAP QASAVOBJ QPSAVOBJ QSYSDKT QSYSTAP QASAVOBJ QPSAVOBJ QSYSTAP QASAVOBJ QPSAVOBJ QSYSTAP QKSPLDKT
DKTF TAPF PF PRTF DKTF TAPF PF PRTF DKTF TAPF PF PRTF DKTF TAPF PF PRTF TAPF PF PRTF TAPF DKTF
SBMFNCJOB
QDFNDATA QFNDEVTBL QFNPGMTBL QFNUSRTBL QAOINIT
DSPF PF PF PF PF
SETOSIATR
QUSRSYS
File Usage Printer file for saved documents and folders.1 Diskette device file used for output. Tape device file used for output. Model output file for saved objects.2 Printer file for saved objects.1 Diskette device file used for output. Tape device file used for output. Model output file for saved objects.2 Printer file for saved objects.1 Diskette device file used for output. Tape device file used for output. Model output file for saved objects.2 Printer file for saved objects.1 Diskette device file used for output. Tape device file used for output. Model output file for saved objects.2 Printer file for saved objects.1 Tape device file used for output. Model output file for saved objects.2 Printer file for saved objects.1 Tape device file used for output. Diskette device file used for all diskette reading. Non-ICF finance display file. File containing data for device tables. File containing data for program tables. File containing data for user tables. OSI configuration file.
94

Table 2. Files Used by CL Commands (continued) File Command Name Library File Name SETTAPCGY QUSRSYS QATACGY QUSRSYS QUSRSYS QSYS QLTACGY QASNADSQ QCRFDWNL
File Type PF LF PF ICFF
SNDDSTQ SNDFNCIMG
SNDPTFORD
QGPL
Qnnnnnnn
SAVF
QSYS SNDSRVRQS QGPL
QESPRTF Qnnnnnnn
PRTF SAVF
QSYS QUSRSYS STRBEST Command:
QESPRTF QAEDCDBPF
PRTF PF
File Usage Category database file. Category logical file. SNADS distribution queues table. ICF file used for communication with 4701 controller. PTF save file, where nnnnnnn is the PTF number. Printer file for PTF cover letters. PTF save file, where nnnnnnn is the PTF number. Printer file for PTF cover letters. File containing service contact data.
For the STRBEST command, all of the following BEST/1** capacity planning files in the QPFR library are physical files that serve both as base files in QPFR and as model files when used to create similar files in another library. As base files (which cannot be changed), they contain IBM-supplied default data of each type of capacity planning information. As model files, they provide the formats of the user-created capacity planning database files created in a different library. Therefore, the common part of each base files description (those both in QPFR and user libraries) begins here and the unique part of each description continues under the File Usage column: BEST/1 capacity planning base file containing... STRBEST QPFR QACYCFGS PF ...alternative system configurations. QPFR QACYGPHS PF ...graph formats. QPFR QACYGRPS PF ...predefined work load group definitions. QPFR QACYHRWS PF ...set of hardware characteristics definitions. QPFR QACYJBCL PF ...alternative job classifications. user-lib QACYMDLS PF ...capacity planning models. QPFR QACYPRED PF ...predefined work loads. user-lib QACYRSTS PF ...results from model analysis. QPFR QACYTHRS PF ...definition of resource thresholds and guidelines. user-lib QACYWKLS PF ...user-defined and created work loads. STRCODE user-lib EVFCICFF ICFF ICF file used for communication with workstation.
95

Table 2. Files Used by CL Commands (continued) File Command Name Library File Name STRCPYSCN QSYS QASCCPY STRDFU QSYS QSYS QSYS STRDKTRDR QSYS QDFUPRT QPDZDTALOG QPDZDTAPRT QKSPLDKT
File Type PF PRTF PRTF PRTF DKTF
STRDKTWTR
QSYS
QKSPLDKT
DKTF
File Usage Pattern for copy screen output file. DFU printer file. DFU run-time audit log. DFU run-time printer data file. Diskette device file used for all diskette reading. Diskette device file used for all diskette writing.
Note E STRIDXMON Command: The STRIDXMON and STRRGZIDX commands use 9 of the 10 files in OfficeVision text search services that are also used by the STRUPDIDX command. For those 9 files (all named as QABBxxxxx), see the list under the STRUPDIDX command; the 10th and last file in that list (QABBLADN) is not used by STRIDXMON or STRRGZIDX. STRIDXMON QUSRSYS QABBxxxxx PF See Note E. STRPDM QPDA QPUOPRTF PRTF Printer file for displayed lists in PDM. STRPFRMON Command: All of the following files for the STRPFRMON command are physical files (PF) that are used as model files (not actual output files) to define the record formats of files created to store performance data collected by this command. All of these model files are in the QSYS library, and the files they create are in the QPFRDATA library (as the default). Each created file stores the specific type of performance data in the format defined for the specific type of data being collected. For the files listed below, the common part of each model files description begins here and the unique part of each description continues under the File Usage column: Model performance monitor database file that defines the record format of the data collection file created to store... STRPFRMON QSYS QAPMAPPN PF ...APPN data.2 QSYS QAPMASYN PF ...asynchronous data.2 QSYS QAPMBSC PF ...binary synchronous data.2 QSYS QAPMBUS PF ...bus counter data.2 QSYS QAPMCIOP PF ...communications controller data.2 QSYS QAPMCONF PF ...system configuration data.2 QSYS QAPMDD1 PF ...DD1 distributed interface data.2 QSYS QAPMDIOP PF ...storage device controller data.2 QSYS QAPMDISK PF ...disk storage (DASD) data.2 QSYS QAPMDMPT PF ...system trace data.2 QSYS QAPMECL PF ...ECL or token-ring LAN data.2 QSYS QAPMETH PF ...Ethernet statistics data.2 QSYS QAPMFRLY PF ...frame relay data.2
96

Table 2. Files Used by CL Commands (continued) File Command Name Library File Name QSYS QAPMHDLC QSYS QAPMIDLC
File Type PF PF
QSYS QSYS QSYS QSYS
QAPMIOBS QAPMJOBS QAPMLAPD QAPMLIOP
PF PF PF PF
QAPMMIOP QAPMPOOL QAPMRESP QAPMRWS QAPMSAP
PF PF PF PF PF
QSYS QSYS QSYS QSYS QSYS QSYS QSYS QSYS QSYS QSYS
QAPMSBSD QAPMSNA QAPMSNADS QAPMSTND QAPMSTNE QAPMSTNL QAPMSTNY QAPMSYS QAPMTSK QAPMX25
PF PF PF PF PF PF PF PF PF PF
STRPRTEML STRPRTWTR
QSYS QSYS
QPEMPRTF QPSPLPRT
PRTF PRTF
STRQMQRY STRQST
QSYS QQALIB QSYS
QPQXPRTF QAQAxxxx00 QAQA00xxxx
PRTF PF LF
File Usage ...HDLC and SDLC control data.2 ...ISDN data link control file entries data.2 ...internal system observations data.2 ...job performance data.2 ...ISDN LAPD file entries data.2 ...local work station controller (WSC) data.2 ...multifunction controller data.2 ...main storage data.2 ...local work station response data.2 ...remote work station response data.2 ...token-ring LAN, Ethernet, Distributed Data Interface, and frame relay service access point.2 ...subsystem description data.2 ...SNA data.2 ...SNADS data.2 ...DDI station data.2 ...Ethernet station data.2 ...token-ring LAN station data.2 ...frame relay station data.2 ...system performance data.2 ...system internal transaction data.2 ...X.25 communications data.2 Emulation printer file. Printer device file used for all printer writing. Printer file used by Query CPI.1 Q & A supplied model database files.2 Q & A database model files.2
97

Table 2. Files Used by CL Commands (continued) File Command Name Library File Name QSYS QAQA00xxxx QSYS Note F STRRGZIDX Command: QPQAPRT
File Type PF PRTF
File Usage Q & A database model files.2 Q & A printer file.
The STRRGZIDX and STRIDXMON commands use 9 of the 10 files in OfficeVision text search services that are also used by the STRUPDIDX command. For those 9 files (all named as QABBxxxxx), see the list under the STRUPDIDX command; the 10th and last file in that list (QABBLADN) is not used by STRRGZIDX or STRIDXMON. STRRGZIDX QUSRSYS QABBxxxxx PF See Note F. STRSDA QGPL QDDSSRC PF DDS source default input file. STRSEU QGPL QTXTSRC PF SEU source default input file. QPDA QPSUPRTF PRTF SEU source member printer file. STRSST QSYS QPCSMPRT PRTF Service tools printer file.1 QTY QATYALMF PF Telephony database model file of alarm record formats. QUSRSYS QATYSWTE PF Telephony database file of user-created switch entries. QTY QATYCDRF PF Telephony database model file of alarm record formats. QUSRSYS QATYSWTE PF Telephony database file of user-created switch entries. STRUPDIDX Command: The STRUPDIDX command uses the following 10 files associated with OfficeVision text search services. The first 9 of these files (all but QABBLADN) are also used by the STRIDXMON and STRRGZIDX commands. All of the following files have a common beginning description. Therefore, the common part of each files description begins here and the unique part of each description continues under the File Usage column: OfficeVision text search services... STRUPDIDX QUSRSYS QABBADMTB PF ...administration table. QUSRSYS QABBCAN PF ...candidates file. QUSRSYS QABBCOX PF ...context index. QUSRSYS QABBDEX PF ...external document index identifiers. QUSRSYS QABBDIC PF ...dictionary. QUSRSYS QABBDIX PF ...internal document index identifiers. QUSRSYS QABBDOX PF ...document index table. QUSRSYS QABBFIX PF ...fragment index. QUSRSYS QABBIQTB PF ...scheduling queue. QUSRSYS QABBLADN4 PF ...list of indexed LADNs (library-assigned document names). 4 This QABBLADN file is not used by the STRRGZIDX and STRIDXMON commands.
98

Table 2. Files Used by CL Commands (continued) File Command Name Library File Name TRCCPIC QSYS QACM0TRC
File Type PF
QSYS
QSYSPRT
PRTF
TRCICF
QSYS QSYS QSYS
QAIFTRCF QPIFTRCF QPCSMPRT
PF PRTF PRTF
TRCINT
QSYS QSYS TRCJOB QSYS
QSYSDKT QSYSTAP QATRCJOB
DKTF TAPF PF
QSYS UPDDTA QSYS QSYS VFYLNKLPDA WRKACTJOB WRKALR WRKCFGSTS WRKCNTINF QSYS QSYS QUSRSYS QSYS QSYS QUSRSYS
QPSRVTRC QPDZDTALOG QPDZDTAPRT QSYSPRT QPDSPAJB QAALERT QSYSPRT QSYSPRT QAEDCDBPF
PRTF PRTF PRTF PRTF PRTF PF PRTF PRTF PF
WRKDDMF
QSYS
QPWRKDDM
PRTF
WRKDEVTBL WRKDIR
QUSRSYS QSYS QSYS
QFNDEVTBL QPDSPDDL QPDSPDSM QAO1CRL
PF PRTF PRTF LF
WRKDOCCVN
QUSRSYS
QUSRSYS
QAO1CVNP
PF
File Usage Trace CPI-Communications database model output file.2 Trace CPI-Communications printer file.1 Trace ICF database output file. Trace ICF printer file.1 Internal trace (for concurrent service monitor) printer file. Diskette device file for output. Tape device file for output. Database file that defines the record format of the file created to store trace records.2 Job trace printer output file.1 DFU run-time audit log. DFU run-time printer data file. Verify link supporting LPDA-2 printer file.1 Active jobs display printer file.1 Alert database file. Alert printer file.1 Configuration status printer file.1 Database file containing contact data. Distributed data management (DDM) file attributes printer file.1 File containing data for device tables. Directory entry details printer file. Directory entry summary printer file. Document conversion logical file for input or output. Document conversion physical file for input or output.
99

Table 2. Files Used by CL Commands (continued) File Command Name Library File Name QUSRSYS QAO1DCVN WRKDPCQ QSYS QPDXWRKD
File Type PRTF PRTF
WRKDSKSTS WRKDSTL
QSYS QSYS QSYS
QPWCDSKS QPDSPLDL QPDSPLSM QPDSTSTS QASNADSQ QPDSPFCT QPUOPRTF
PRTF PRTF PRTF PRTF PF PRTF PRTF
WRKDSTQ
QSYS QUSRSYS
WRKFCT WRKGRPPDM
QRJE QPDA
WRKHDWRSC WRKHTTPCFG WRKJOB WRKJOBQ WRKJOBSCDE WRKJRNA WRKLIBPDM
QSYS QUSRSYS QSYS QSYS QSYS QSYS QPDA
QASUPTEL QATMHTTPC QPDSPJOB QPRTSPLQ QSYSPRT QPDSPJNA QPUOPRTF
PF PF PRTF PRTF PRTF PRTF PRTF
WRKMBRPDM
QPDA
QPUOPRTF
PRTF
WRKMSG
QSYS
QPDSPMSG
PRTF
WRKMSGD WRKNAMSMTP
QSYS QSYS QSYS
QPMSGD QATMSMTP QATMSMTPA QANFDNTF QPNFDNTF QANFNJE QPNFNJE
PRTF PF PF PF PRTF PF PRTF
WRKNETF
QSYS QSYS
WRKNETJOBE
QUSRSYS QSYS
File Usage Document conversion printer file. Printer file for DSNX/PC queued distribution requests.1 Disk status printer file.1 Distribution list details printer file. Distribution list summary printer file. Distribution status printer file.1 SNADS destination queues table. Forms control table printer file.1 Printer file for displayed lists in PDM.1 Hardware resources locking database file. TCP/IP HTTP file. Job display printer file.1 Job queue printer file (spooling queue).1 Job schedule entries printer file.1 Journal attributes printer file.1 Printer file for displayed lists in PDM.1 Printer file for displayed lists in PDM.1 Printer file for message queue messages.1 Message description printer file. TCP/IP SMTP personal alias table. TCP/IP SMTP system alias table. Database file for display network files.1 Printer file for display network files.1 Database file for network job entries.1 Printer file for network job entries.1
100

Table 2. Files Used by CL Commands (continued) File Command Name Library File Name WRKOBJLCK QSYS QPDSPOLK WRKOBJPDM QPDA QPUOPRTF
File Type PRTF PRTF
WRKOUTQ WRKOUTQD WRKPARTPDM
QSYS QSYS QPDA
QPRTSPLQ QPDSPSQD QPUOPRTF
PRTF PRTF PRTF
WRKPGMTBL WRKPRB Command:
QUSRSYS
QFNPGMTBL
PF
File Usage Object locks display printer file.1 Printer file for displayed lists in PDM.1 Output spooling queue printer file.1 Output queue description.1 Printer file for displayed lists in PDM. File containing data for program tables.
All 8 of the QASXxxxx files shown in the QUSRSYS library for the WRKPRB command are the same subset of files that are shown in the QUSRSYS library for the DSPPRB command. For the descriptions of these files, see the DSPPRB command. WRKPRB QSYS QSXPRTD PRTF Problem log detail printer file. QSYS QSXPRTL PRTF Problem log summary printer file. QUSRSYS QASXxxxx PF See the DSPPRB command for these 8 files in the QUSRSYS library. WRKPRJPDM QPDA QPUOPRTF PRTF Printer file for displayed lists in PDM.1 WRKQRY QSYS QPQUPRFIL PRTF Printer file used for query output. WRKQST QSYS QPQAPRT PRTF Q & A printer file. WRKRDBDIRE QSYS QSYSPRT PRTF Distributed relational database directory printer file.1 WRKRDR QSYS QPRTRDWT PRTF Reader display printer file.1 WRKRJESSN QRJE QPRJESTS PRTF Active status printer file for RJE session.1 WRKRPYLE QSYS QPRTRPYL PRTF System reply list printer file.1 WRKSBMJOB QSYS QPDSPSBJ PRTF Submitted jobs printer file.1 WRKSBS QSYS QPDSPSBS PRTF Subsystem display printer file.1 WRKSBSJOB QSYS QPDSPSBJ PRTF Subsystem jobs display printer file.1 WRKSHRPOOL QSYS QSYSPRT PRTF Shared storage pools printer file.1 WRKSOC QUSRSYS QAALSOC PF Sphere of control database file. WRKSPLF QSYS QPRTSPLF PRTF Spooled file printer file.1
101

Table 2. Files Used by CL Commands (continued) File Command Name Library File Name WRKSPLFA QSYS QPDSPSFA WRKSPTPRD WRKSRVPVD WRKSRVRQS WRKSSND WRKSYSACT QSYS QUSRSYS QUSRSYS QRJE user-lib QSYSPRT QAEDSPI QANSSRI QPRTSSND QAITMON
File Type PRTF PRTF PF PF PRTF PF
QPFR WRKSYSSTS WRKSYSVAL WRKTAPCTG QSYS QSYS QUSRSYS QUSRSYS QUSRSYS QUSRSYS QSYS WRKTCPPTP QUSRSYS QUSRSYS WRKTIE WRKTRA QSYS QSYS
QAPTDDS QPDSPSTS QSYSPRT QATAMID QATAMID QATACGY QLTACGY QSYSTAP QATOCPTP QATOCMODEM QPTIRCV QSYSPRT
PF PRTF PRTF PF LF PF LF TAPF PF PF PRTF PRTF
WRKTXTIDX
QUSRSYS
QABBADMTB
PF
WRKUSRJOB WRKUSRTBL WRKWTR
QSYS QUSRSYS QSYS
QPDSPSBJ QFNUSRTBL QPRTRDWT
PRTF PF PRTF
File Usage Spooled file attributes printer file.1 Supported products printer file.1 Service provider information file. Service requester file. Session description printer file.1 Performance data collection file: job and Licensed Internal Code task data.1 Performance data DDS source file. System status printer file.1 System values printer file.1 Cartridge ID database file. Cartridge ID logical database file. Category database file. Category logical file. Tape device file for input. TCP/IP point-to-point profile configuration. TCP/IP point-to-point modem configuration. Printer file summary of files received. Printer file containing list of token-ring network adapters.1 OfficeVision text search services administration table. User jobs display printer file.1 File containing data for user tables. Writer display printer file.1
Printing command descriptions on the AS/400

To print the parameter and value descriptions for a command on your AS/400 system, follow these instructions: v To print help for an entire command, do either of the following:
102

From any command line, type the command name (for example, CRTUSRPRF) and press F1. The display shows general help for the command and help for each command parameter. Press F14 to print the command help. On a prompt display for a given command, move the cursor to the top line and press F1. Then press F14. v To print the help for one CL command keyword parameter, do the following: From a command line, type the CL command name and press F4 to display the command prompt display. Position the cursor anywhere on the line of the keyword parameter for which you want help. Press F1 to display the help for the keyword parameter. Press F14 to print the help. v Alphabetical listing of commands on page 13 v v v v How commands are named on page 59 Commands operating on OS/400 objects on page 59 Commands operating on multiple objects on page 60 Files used by CL commands on page 61
103
104
Chapter 5. OS/400 objects

Operating System/400* (OS/400*) objects provide the means through which all data processing information is stored and processed by the AS/400 system. An OS/400 object is a named unit that exists (occupies space) in storage and on which operations are performed on it by the operating system. CL commands perform operations on the Operating System/400* (OS/400*) objects. Several types of OS/400 objects are created and used in the control language. The Predefined Values and Default Library Locations for OS/400 Object Types table lists the predefined values for all the OS/400 object types. When an object is created and a library qualifier can be specified but is not, the object is stored in the users current job library, as shown in the last column. The user profile for each user specifies the users current library. The current library will be QGPL if it is not specified otherwise. The other objects, identified by N/A in the last column, cannot be stored in user-provided libraries. OS/400 objects have the following in common: v Objects have a set of descriptive attributes that are defined when the object is created. v Objects have to be used by the system to perform a specific function must be specified in the CL command that performs that function. v Objects have a set of attributes that describe it and give the specific values assigned for those attributes. v Generally, objects are independent of all other objects. However, some objects must be created before other objects can be created; for example, a logical file cannot be created if the physical file it must be based on does not exist. v Objects must be created before other operations that use the object are performed. Descriptions of the create commands (those commands that begin with the letters CRT) give more information about the object types that they create. v Every OS/400 object that is used by the control language has a name. The object name specified in a CL command identifies which object is used by the operating system to perform the function of the command. v Objects have either a simple, qualified,or generic name.
Table 3. Predefined Values and Default Library Locations for OS/400 Object Types Value *ALRTBL *AUTL *BLKSF *BNDDIR *CFGL *CHTFMT *CLD *CLS Object Type Alert table Authorization list Block special file Binding directory Configuration list Chart format Default User Library *CURLIB N/A N/A *CURLIB N/A *CURLIB
C/400 locale description *CURLIB Class *CURLIB
105
Table 3. Predefined Values and Default Library Locations for OS/400 Object Types (continued) Value *CMD *CNNL *COSD *CRG *CRQD *CSI *CTLD *DDIR *DEVD *DIR *DOC *DSTMF *DTAARA *DTADCT *DTAQ *EDTD *EXITRG *FCT *FILE *FLR *FNTRSC *FNTTBL *FORMDF *FTR *GSS *IGCDCT Object Type Command Connection list Class-of-service description Cluster resource group Change request description Communications Side Information Controller description Distributed file directory Device description Directory Document Distributed stream file Data area Data dictionary Data queue Edit description Exit registration Forms control table File Folder Font resources Font mapping table Form definition Filter Graphics symbol set Double-byte character set (DBCS) conversion dictionary Double-byte character set (DBCS) sort table Double-byte character set (DBCS) font table Internetwork packet exchange description Job description Job queue Job schedule Journal Default User Library *CURLIB QSYS QSYS *QUS *CURLIB *CURLIB QSYS N/A QSYS N/A QDOC N/A *CURLIB N/A *CURLIB QSYS N/A *CURLIB *CURLIB QDOC *CURLIB *CURLIB *CURLIB *CURLIB *CURLIB *CURLIB
*IGCSRT *IGCTBL *IPXD *JOBD *JOBQ *JOBSCD *JRN
*CURLIB N/A QSYS *CURLIB *CURLIB *CURLIB *CURLIB
106
Table 3. Predefined Values and Default Library Locations for OS/400 Object Types (continued) Value *JRNRCV *LIB *LIND *MENU *MGTCOL *MODD *MODULE *MSGF *MSGQ *M36 *M36CFG *NODGRP *NODL *NTBD *NWID *NWSD *OUTQ *OVL *PAGDFN *PAGSEG *PDG *PGM *PNLGRP *PRDAVL *PRDDFN *PRDLOD *PSFCFG *QMFORM *QMQRY *QRYDFN *RCT *SBSD *SCHIDX *SOCKET Object Type Journal receiver Library Line description Menu description Management collection Mode description Compiler unit Message file Message queue AS/400 Advanced 36 machine AS/400 Advanced 36 machine configuration Node group Node list NetBIOS description Network interface description Network server description Output queue Overlay Page definition Page segment Print Descriptor Group Program Panel group definition Product availability Product definition Product load Print Services Facility configuration Query management form Query management query Query definition QSYS *CURLIB *CURLIB *CURLIB *CURLIB *CURLIB *CURLIB *CURLIB QSYS QSYS QSYS *CURLIB *CURLIB *CURLIB *CURLIB *CURLIB *CURLIB *CURLIB QSYS QSYS QSYS *CURLIB *CURLIB *CURLIB QGPL Default User Library *CURLIB QSYS N/A *CURLIB
Reference code translate QGPL table Subsystem description Search index Local socket *CURLIB QGPL N/A
107
Table 3. Predefined Values and Default Library Locations for OS/400 Object Types (continued) Value *SPADCT *SRVPGM *SQLPKG *SQLUDT *SSND *STMF *S36 *SVRSTG *SYMLNK *TBL *USRIDX *USRPRF *USRQ *USRSPC *VLDL *WSCST Object Type Spelling aid dictionary Service program Structured Query Language package User-defined SQL type Session description Bytestream file System/36 machine description Server storage space Symbolic link Table User index User profile User queue User space Validation list Work station customizing object QGPL N/A QGPL N/A N/A *CURLIB *CURLIB QSYS *CURLIB *CURLIB *CURLIB *CURLIB Default User Library QGPL *CURLIB *CURLIB
Library objects
| | Many objects are grouped in special objects called libraries. Table 4 provides information about various object types and their default libraries. Some objects, which use the integrated file system, are located in directories and can be found by using path names or object name patterns instead of searching libraries. You can also use these directories to locate objects. For more information about integrated file system commands, see the Integrated File Systems topic.
Table 4. Predefined Values and Default Library Locations for OS/400 Object Types Value *ALRTBL *AUTL *BLKSF *BNDDIR *CFGL *CHTFMT *CLD *CLS *CMD *CNNL *COSD Object Type Alert table Authorization list Block special file Binding directory Configuration list Chart format C/400 locale description Class Command Connection list Class-of-service description Default User Library *CURLIB N/A N/A *CURLIB N/A *CURLIB *CURLIB *CURLIB *CURLIB QSYS QSYS
108
Table 4. Predefined Values and Default Library Locations for OS/400 Object Types (continued) Value *CRG *CRQD *CSI *CTLD *DDIR *DEVD *DIR *DOC *DSTMF *DTAARA *DTADCT *DTAQ *EDTD *EXITRG *FCT *FILE *FLR *FNTRSC *FNTTBL *FORMDF *FTR *GSS *IGCDCT *IGCSRT *IGCTBL *IPXD *JOBD *JOBQ *JOBSCD *JRN *JRNRCV *LIB *LIND *MENU *MGTCOL *MODD *MODULE Object Type Cluster resource group Change request description Communications Side Information Controller description Distributed file directory Device description Directory Document Distributed stream file Data area Data dictionary Data queue Edit description Exit registration Forms control table File Folder Font resources Font mapping table Form definition Filter Graphics symbol set Double-byte character set (DBCS) conversion dictionary Double-byte character set (DBCS) sort table Double-byte character set (DBCS) font table Internetwork packet exchange description Job description Job queue Job schedule Journal Journal receiver Library Line description Menu description Management collection Mode description Compiler unit QSYS *CURLIB Default User Library *QUS *CURLIB *CURLIB QSYS N/A QSYS N/A QDOC N/A *CURLIB N/A *CURLIB QSYS N/A *CURLIB *CURLIB QDOC *CURLIB *CURLIB *CURLIB *CURLIB *CURLIB *CURLIB *CURLIB N/A QSYS *CURLIB *CURLIB *CURLIB *CURLIB *CURLIB QSYS N/A *CURLIB
109
Table 4. Predefined Values and Default Library Locations for OS/400 Object Types (continued) Value *MSGF *MSGQ *M36 *M36CFG *NODGRP *NODL *NTBD *NWID *NWSD *OUTQ *OVL *PAGDFN *PAGSEG *PDG *PGM *PNLGRP *PRDAVL *PRDDFN *PRDLOD *PSFCFG *QMFORM *QMQRY *QRYDFN *RCT *SBSD *SCHIDX *SOCKET *SPADCT *SRVPGM *SQLPKG *SQLUDT *SSND *STMF *S36 *SVRSTG *SYMLNK *TBL *USRIDX Object Type Message file Message queue AS/400 Advanced 36 machine Default User Library *CURLIB *CURLIB *CURLIB
AS/400 Advanced 36 machine configurationCURLIB * Node group Node list NetBIOS description Network interface description Network server description Output queue Overlay Page definition Page segment Print Descriptor Group Program Panel group definition Product availability Product definition Product load Print Services Facility configuration Query management form Query management query Query definition Reference code translate table Subsystem description Search index Local socket Spelling aid dictionary Service program Structured Query Language package User-defined SQL type Session description Bytestream file System/36 machine description Server storage space Symbolic link Table User index QGPL N/A QGPL N/A N/A *CURLIB *CURLIB *CURLIB *CURLIB QSYS QSYS QSYS *CURLIB *CURLIB *CURLIB *CURLIB *CURLIB *CURLIB *CURLIB QSYS QSYS QSYS *CURLIB *CURLIB *CURLIB QGPL QGPL *CURLIB QGPL N/A QGPL *CURLIB *CURLIB
110
Table 4. Predefined Values and Default Library Locations for OS/400 Object Types (continued) Value *USRPRF *USRQ *USRSPC *VLDL *WSCST Object Type User profile User queue User space Validation list Work station customizing object Default User Library QSYS *CURLIB *CURLIB *CURLIB *CURLIB
Simple and qualified object names

The name of a specific object that is located in a library can be specified as a simple name or as a qualified name. A simple object name is the name of the object only. A qualified object name is the name of the library where the object is stored followed by the name of the object. In a qualified object name, the library name is connected to the object name by a slash (/). Either the simple name or the qualified name of an object can be specified if the object exists in one of the libraries named in the jobs library list; the library qualifier is optional in this case. A qualified name must be specified if the named object is not in a library named in the library list. Note: Although a job name also has a qualified form, it is not a qualified object name because a job is not an OS/400 object. A job name is qualified by a user name and a job number, not by a library name. For more information about the JOB parameter, refer to JOB parameter on page 141. v Example: Simple and qualified object name v Chapter 5. OS/400 objects on page 105 v Generic object names
Example: Simple and qualified object name

The following table shows how simple and qualified object names are formed.
Name Type Simple object name Qualified object name Name Syntax object-name library-name/object-name Example OBJA LIB1/OBJB
v Chapter 5. OS/400 objects on page 105 v Generic object names
Generic object names

A generic object name may refer to more than one object. That is, a generic name contains one or more characters that are the first group of characters in the names of several objects; the system then searches for all the objects that have those characters at the beginning of their names and are in the libraries named in the library list. A generic name is identified by an asterisk (*) as the last character in the name. A quoted generic name consists of a generic name enclosed in quotation marks. Unlike quoted names, if there are no special characters between the quotation
111
marks, the quotation marks are not removed. The generic name ABC* would cause the system to search for objects whose name begins with ABC. A generic name can also be qualified by a library name. If the generic name is qualified, the system will search only the specified library for objects whose names begin with that generic name. Note: A generic name also can be qualified by one or more directories if it is a path name. In a path name, letters can be specified before and after the asterisk (*). For more information on path names, see the Integrated File System topic. When you specify a generic name, the system performs the required function on all objects whose names begin with the specified series of characters. You must have the authority required to perform that function on every object the generic name identifies. If you do not have the required authority for an object, the function is not performed and a diagnostic message is issued for each instance that the attempted generic function failed. A completion message is issued for each object the generic function operates on successfully. You must view the online low-level messages to see the completion messages. Once the entire generic function is completed, a completion message is issued that states that all objects were operated on successfully. If one or more objects could not be successfully operated on an escape message is issued. If an override is in effect for a specific device file, the single object name specified on the override, rather than the generic name, is used to perform the operation. You may not be able to use a generic name for delete, move, or rename commands if the library containing the objects is already locked. A search for generic object names requires a more restrictive lock on the library containing the objects than a search for full object names. The more restrictive lock is necessary to prevent another user from creating an object with the same name as the generic search string in the library while the delete, move, or rename command is running. You can circumvent this problem by using the full name of the objects instead of a generic name. Or you can end the job or subsystem that has a lock on the library. Note: Use the WRKOBJLCK (Work with Object Locks) command to determine which jobs or subsystems have a lock on the library. For some commands, a library qualifier can be specified with the generic name to limit the scope of the operation. For example, a Change Print File (CHGPRTF) command with FILE(LIB1/PRT*) performs the desired operation on printer files beginning with PRT in library LIB1 only; printer files in other libraries are not affected. The limitations associated with the various library qualifiers are as follows: v library-name: The operation is performed on generic object names only in the specified library. v *LIBL: The operation is performed on generic object names in the library list associated with the job that requested the generic operation. v *CURLIB: The operation is performed on generic object names in the current library. v *ALL: The operation is performed on generic object names in all libraries on the system for which you are authorized. v *USRLIBL: The operation is performed on generic object names in the user part of the library list for the job.
112
v *ALLUSR: The operation is performed on all nonsystem libraries (libraries that do not start with the letter Q), except for the following:
#CGULIB #COBLIB #DFULIB #DSULIB #RPGLIB #SDALIB #SEULIB
The operation is also performed on the following Qxxx libraries:

QDSNX QGPL QGPL38 QMQMDATA QMQMPROC QPFRDATA QRCL QS36F QUSER38 QUSRADSM QUSRRM QUSRINFSKR QUSRNOTES QUSRPYMSVR QUSRRDARS QUSRSYS QUSRVxRxMx
Note: A different library name, of the form QUSRVxRxMx, can be created by the user for each release that IBM supports. VxRxMx is the version, release, and modification level of the library. v Example: Simple and qualified object name on page 111 v Chapter 5. OS/400 objects on page 105 v Example: Generic object name
Example: Generic object name

Name Type Simple generic name Qualified generic name Quoted generic name Name Syntax generic-name* library-name/generic-name* generic-name* Example OBJ* LIB1/OBJ* ABC*
v Chapter 5. OS/400 objects on page 105 v Generic object names on page 111 v Simple and qualified object names on page 111
113
114
Chapter 6. Command description format

Each command description follows the same format and includes the parts discussed in the following paragraphs. It should be noted that, because a command is an AS/400 object, each command can be authorized for specific users or authorized for use by the public (all users authorized in some way to use the system). Because this is true for nearly every command, it is not stated in each command description. The Security Reference book, contains additional information about IBM-supplied user profiles and the commands first authorized for each one. Command syntax The command syntax is presented in the syntax diagram. The syntax diagram shows all the parameters and values that are valid for the command. The parameters are divided into two groups: those that must be coded (required), and those that need not be coded (optional). Default values are indicated by their position above the base line. These default values are used by the system for parameters or parts of parameters that are not coded. The Chapter 9. About syntax diagrams on page 165 topic provides an detailed, in-depth discussion of command syntax. Command description The general description of the command (under the heading Purpose) briefly explains the function of the command and any relationships it has with a program or with other commands. If there are restrictions on the use of the command, they are described under the heading Restrictions. Parameter descriptions Parameter descriptions in the text are presented in the same order as in the syntax diagram. The syntax diagram shows the order in which the parameters must be specified if the values are specified in positional form (that is, without keywords). If a parameter has more than one value, the values are described in the same order as shown in the syntax diagram. The default value, if there is one, is always first and is shown as an underlined heading at the beginning of the text that describes the value. The description of each parameter explains what the parameter means, what it specifies, and the dependent relationships it has with other parameters in the command. When the parameter has more than one value, the information that applies to the parameter as a whole is covered first, then the specific information for each of the values is described after the name of each value. Command coding examples Each command description with parameters shows at least one coded example. Where necessary, several examples are provided for commands with many parameters and several logical combinations.
115
For clarity, each example is coded in keyword form only. The same examples could be coded either in positional form or in a combination of keyword and positional forms. Additional command considerations A section called Additional Considerations follows the coded examples of some commands to present additional useful information about the command.
116
Chapter 7. Command parts

This figure illustrates the parts of a command, which includes: command label (optional), command name (mnemonic), and one or more parameters. The parameter includes a keyword and a value.
Label
Command labels identify particular commands for branching purposes in a CL program. Labels can also be used to identify statements in CL programs that are being debugged. They can identify statements used either as breakpoints or as starting and ending statements for tracing purposes. | | | | | | | | | | | | Typed just before the command name, the label can contain as many as 10 characters. The standard rules for specifying simple names (*SNAME) apply. The label, immediately followed by a colon and blanks (though not required), usually occurs between the colon and the command name. START: and TESTLOOP: are examples of command labels. Command labels are not required, but a label can be placed on any command. Labels that are placed on commands that cannot be run (for example, the Declare CL Variable (DCL) command), the program branches to that label, te next command following the label is run. If the command following the label cannot be run, the program will move to the next command that can be run. Similarly, you can specify only one label on a line; if a command is not located on that line, the program will jump to the next command that can be run. To specify multiple labels, each additional label must be on a separate line preceding the command as shown:
LABEL1: LABEL2: CMDX
No continuation character (+ or ) is allowed on the preceding label lines. | For more information about command parts, see the following: v Name on page 118 v Parameters on page 118 v Commonly used parameters: Expanded descriptions on page 128
117
Name
The command name identifies the function that will be performed by the program that is called when the command is run. The command name is an abbreviation of the command description. For example, the name MOVOBJ identifies the CL command (Move Object) that moves an object from one library to another. Like other objects, a command name can be optionally qualified by a library name. See the Simple and qualified object names topic for more information about object names.. For more information about how CL commands are named, see Chapter 11. Object naming rules on page 181. v Label on page 117 v Parameters v Commonly used parameters: Expanded descriptions on page 128
Parameters
Most CL commands have one or more parameters that specify the objects and values used to run the commands. When a command is entered, the user supplies the object names, the parameter names, and the parameter values used by the command. The number of parameters specified depends upon the command. Some commands (like the DO (Do) command and the ENDBCHJOB (End Batch Job) command) have no parameters, and others have one or more. The specification of a group of values on one parameter is described under List of values on page 127. In this topic, the word parameter usually refers to the combination of the parameter keyword and its value. For example, the Move Object (MOVOBJ) command has a parameter called OBJ that requires an object name to be specified. OBJ is the parameter keyword, and the name of the object is the value entered for the OBJ parameter. v Name v Label on page 117 v Commonly used parameters: Expanded descriptions on page 128 v Required, optional, and key parameters v Parameters in keyword and positional form on page 119 v Parameter values on page 120
Required, optional, and key parameters

A command can have parameters that must be coded (required parameters) and parameters that do not have to be coded (optional parameters). Optional parameters are usually assigned a system-defined default value if another value is not specified for the parameter when the command is entered. A command can also have key parameters which are the only parameters shown on the display when a user prompts for the command. After values are entered for the key parameters, the remaining parameters are shown with actual values instead of the default values (such as *SAME or *PRV). Note: Key parameters include all parameters preceding the key parameter limit, which is designated on the syntax diagram by the letter K.
118
v Parameters in keyword and positional form v Parameter values on page 120
Parameters in keyword and positional form

You can specify parameters in CL either keyword form, positional form, or in a combination of the two. Parameters in keyword form | | | | | | | A parameter in keyword form consists of a keyword followed immediately by a value (or a list of values separated by blank spaces) enclosed in parentheses. You cannot use blanks between the keyword and the left parenthesis preceding the parameter value. You can place blanks between the parentheses and the parameter value. For example, LIB(MYLIB) is a keyword parameter specifying that MYLIB is the name of the library that is used in some way, depending upon the command in which this LIB parameter is used. When command parameters are all specified in keyword form, they can be placed in any order. For example, the following two commands are the same:
CRTLIB CRTLIB LIB(MYLIB) TYPE(*TEST) TYPE(*TEST) LIB(MYLIB)
Parameters in positional form A parameter in positional formdoes not have its keyword coded; it contains only the value (or values, if it is a list) whose function is determined by its position in the parameter set for that command. The parameter values are separated from each other and from the command name by one or more blank spaces. Because there is only one positional sequence in which parameters can be coded, the positional form of the previous CRTLIB (Create Library) command first example is:
CRTLIB MYLIB *TEST
Most commands with more than one parameter can have their parameters coded in a specific positional order. The correct order is shown in the syntax diagram and in the presentation of the command description. However, in the few cases where dependent parameters occur in the syntax diagram and the positional order is not readily apparent, the correct order can be determined from the syntax notes or the parameter descriptions. When one parameter or another (but not both) must be used (the parameters are mutually exclusive), the parameters are presented in the same position in the syntax diagram. For a visual representation of dependent parameters, see PARMI and PARMK at 19 in the syntax diagram rules. If you do not want to enter a value for one of the parameters, the predefined value *N (null) can be entered in that parameters position. The system recognizes *N as an omitted parameter, and either assigns a default value or leaves it null. In the previous CRTLIB command second example, if you coded *N instead of *TEST for the TYPE parameter, the default value *PROD is used when the command is run, and a production library named MYLIB is created with no public authority. The description of the CRTLIB command contains the explanation for each parameter. Note: Parameters cannot be coded in positional form beyond the positional coding limit, which is designated in the syntax diagrams with the letter P. If you attempt to code parameters in positional form beyond that point, the system returns an error message. When a command has parameters, but none of its
119
parameters can be specified in positional form, the letter P appears immediately to the right of the command name in the syntax diagram. If the parameters that can be coded in positional form are the same as the key parameters, both the P and the K will be shown on the diagram as follows: (P,K). Combining keyword and positional forms A command may also have its parameters coded in a combination of keyword and positional forms. The following examples show three ways to code the Declare CL Variable (DCL) command. Keyword form:
DCL VAR(&QTY) TYPE(*DEC) LEN(5) VALUE(0)
Positional form:
DCL &QTY *DEC 5 0
Positional and keyword forms together:

DCL &QTY *DEC VALUE(0)
In the last example, because the optional LEN parameter was not coded, the VALUE parameter must be coded in keyword form. Note: Once positional coding is discontinued, it cannot be started again. v Required, optional, and key parameters on page 118 v Parameter values
Parameter values
A parameter value is user-supplied information used during the running of a command. An individual value can be specified in any one of the following: | | | v Constant value on page 121 (its actual value): The types of constants are character string (includes names, date and hexadecimal values), decimal, and logical. v Variables on page 126 name (the name of the variable containing the value): The types of variables are character string (includes names), decimal, and logical. Decimal and logical values must match the type of value expected for the parameter. Character variables can specify any type of value. For example, if a decimal value is expected, it can be specified by a character variable as well as by a decimal variable. v Expressions on page 127 (the value used is the result of evaluating an expression): The types of expressions are arithmetic, character string, relational, and logical. Expressions can be used as a value for parameters in commands in CL programs only. A parameter can specify one or a group of such values, depending on the parameters definition in a command. If a group of values is specified, the parameter is called a list parameter because it can contain a list of values. On commands with key and positional parameters, values can be specified in keyword form, positional form, or a combination of both forms. Parameter values must be enclosed in parentheses if any of the following conditions are true:
120
v A keyword precedes the value. v The value is an expression. v A list of values is specified. Note: If only one value is specified for a list, no parentheses are required. v Required, optional, and key parameters on page 118 v Parameters in keyword and positional form on page 119
Constant value
A constant value is an actual numeric value or a specific character string whose value does not change. Three types of constants can be used by the control language: character string (quoted or unquoted), decimal,and logical. v Variables on page 126 v Expressions on page 127 | | | | | Character string: A character string is a string of any EBCDIC characters (alphanumeric and special) that are used as a value, includeing date and hexidecimal values. A character string can have two forms: quoted string or unquoted string. Either form of character string can contain as many as 5000 characters. A quoted character string is a string of alphanumeric and special characters that are enclosed in apostrophes. For example, Credit limit has been exceeded is a quoted character string. The quoted string is used for character data that is not valid in an unquoted character string. For example, user-specified text can be entered in several commands to describe the functions of the commands. Those descriptions must be enclosed in apostrophes if they contain more than one word because blanks are not allowed in an unquoted string. An unquoted character string is a string consisting of only alphanumeric characters and the special characters that are shown in the Unquoted String column in the Table 5. The table summarizes the main EBCDIC characters that are valid in unquoted and quoted character string values. An X in the last column indicates that the character on the left is valid; refer to the specific notes following the figure that indicate why the character is valid as described. The special characters allow the following to be unquoted character string values: v Predefined values (* at the beginning) v Qualified object names (/) v Generic names (* at the end) v Decimal constants (+, , ., and ,) Any of these unquoted strings can be specified for parameters defined to accept character strings. In addition, some parameters are defined to accept predefined values, names, or decimal values either singly or in combinations.
Table 5. Quoted and Unquoted Character Strings Name of Character Ampersand Apostrophe Asterisk (*) Character & * Unquoted String See Note 5 See Note 7 See Notes 5, 6 Quoted String X X
121
Table 5. Quoted and Unquoted Character Strings (continued) Name of Character At sign Blank Colon Comma Digits Dollar sign Equal Greater than Left parenthesis Less than Letters (lowercase) Letters (uppercase) Minus Not Number sign Percent Period Plus Question mark Quotation marks Right parenthesis Semicolon Slash Underscore Vertical bar : , 0-9 $ = > ( < a-z A-Z # % . + ? ) ; / _ See Notes 3, 5 See Note 9 See Notes 5, 8 See Note 10 See Note 4 See Notes 1, 11 See Notes 1, 5 See Note 1 See Note 1 X See Notes 5, 8 See Notes 5, 8 See Note 4 See Notes 5, 8 See Note 2 X See Notes 1, 5 See Notes 5, 8 X Character @ Unquoted String X Quoted String X X X X X X X X X X X X X X X X X X X X X X X X X
Notes: 1. An unquoted string of all numeric characters, an optional single decimal point (. or ,), and an optional leading sign (+ or ) are valid unquoted strings. Depending on the parameter attributes in the command definition, this unquoted string is treated as either a numeric or character value. On the CALL command or in an expression, this unquoted string is treated as a numeric value; a quoted string is required if character representation is desired. Numeric characters used in any combination with alphanumeric characters are also valid in an unquoted string. 2. In an unquoted string, lowercase letters are translated into uppercase letters unless the string is specified for a parameter that has the attribute CASE(*MIXED). 3. A slash can be used as a connector in qualified names and path names. 4. In an unquoted string, parentheses are valid when used to delimit keyword values and lists, or in expressions to indicate the order of evaluation. 5. In an unquoted string, the characters +, , *, /, &, , , <, >, and = are valid by themselves. If they are specified on a parameter that is defined in the
122
6.
7.
8.
9. 10. 11.
command definition with the EXPR(*NO) attribute, they are treated as character values. If they are specified on a parameter that is defined in the command definition with the EXPR(*YES) attribute, they are treated as expression operators. In an unquoted string, the asterisk is valid when followed immediately by a name (such as in a predefined value) and when preceded immediately by a name (such as in a generic name). For further information on unquoted strings in expressions, see Expressions on page 127. Because an apostrophe within a quoted string is paired with the opening apostrophe (delimiter) and is interpreted as the ending delimiter, an adjacent pair of apostrophes () must be used inside a quoted string to represent an apostrophe that is not a delimiter. When characters are counted in a quoted string, a pair of adjacent apostrophes is counted as a single character. In an unquoted string, the characters <, >, =, , and are valid in some combinations with another character in the same set. Valid combinations are: <=, >=, =, >, <, , <, and >. If the combination is specified on a parameter that is defined in the command definition with the EXPR(*NO) attribute, it is treated as a character value. If it is specified on a parameter that is defined in the command definition with the EXPR(*YES) attribute, it is treated as an expression operator. In an unquoted string, the underscore is not valid as the first character or when used by itself. Quotation marks are used to delimit a quoted name. A period is valid in a basic name, except as the first character.
The following are examples of quoted string constants: Constant 1,2, DONT 24 12 20 Value 1,2, DONT 24 12 20
The following are examples of unquoted strings: Constant CHICAGO FILE1 *LIBL LIBX/PGMA 1.2 Meaning CHICAGO FILE1 Library list Program PGMA in library LIBX 1.2
More information and examples can be found in the Character string expressions on page 194 page in this topic. v Date values v Hexadecimal values on page 124 v Decimal values on page 124 v Logical values on page 125 v Floating-point constants on page 125 Date values: A date value is a character string that represents a date. Its format is specified by the system value QDATFMT. The length of the date value varies with
123
the format used and whether a separator character is used. For example, if no separator character is used, the length of a date in a Julian format is five characters, and the length of a date in a non-Julian format is six characters. If a separator character is used, the length will be greater. More information on system value QDATFMT is in the OS/400 Work Management book. The system value QDATSEP specifies the optional separator character that can be used when the date is entered. If a separator character is used, the date must be enclosed in apostrophes. For additional information on system value QDATSEP, see the OS/400 Work Management book. A date value can be specified for the parameters of type *DATE. A year value equal to or greater than 40 indicates a year from 1940 through 1999. A year value less than 40 indicates a year from 2000 through 2039. For additional information on parameter value *DATE, see the PARM statement description. v Character string on page 121 v Hexadecimal values v Decimal values v Logical values on page 125 v Floating-point constants on page 125 Hexadecimal values: A hexadecimal value is a constant made up of a combination of the hexadecimal digits A through F and 0 through 9. All character strings except names, dates, and times can be specified in hexadecimal form. To specify a hexadecimal value, the digits must be specified in multiples of two, be enclosed in apostrophes, and be preceded by an X. Examples are: XF6 and XA3FE. Note: Care should be used when entering hexadecimal values in the range of 00 through 3F, or the value FF. If these characters are shown or printed, they may be treated as device control characters producing unpredictable results. v Character string on page 121 v Date values on page 123 v Decimal values v Logical values on page 125 v Floating-point constants on page 125 Decimal values: A decimal value is a numeric string of one or more digits, optionally preceded by a plus (+) or minus () sign. A decimal value can contain a maximum of 15 digits, of which no more than nine can follow the decimal point (which can be either a comma or a period). Therefore, a decimal value can have no more than 17 character positions including the plus or minus sign and decimal point (if any). The following are examples of decimal values.
v Character string on page 121
124
v v v v
Date values on page 123 Hexadecimal values on page 124 Logical values Floating-point constants
Floating-point constants: A floating-point constant is a representation of a number that consists of: v A significand sign: The significand sign may be + or . The significand sign is optional; it is assumed to be + if no sign is specified. v A significand: The significand must contain a decimal point. The maximum number of digits that can be specified for the significand is 253; however, only the first 17 significant digits are used. v An exponent character: The exponent character must be E. v An exponent sign: The exponent sign must be + or . The significand sign is optional; it is assumed to be + if no sign is specified. v An exponent: The exponent must be an integer; numbers 0 through 9 are valid. The maximum number of digits that can be specified is three. All floating-point constants are stored as double-precision values. No blanks are allowed between any of the parts of a floating-point constant, and the parts must be in the order listed above. Three commands have parameters for which floating-point constants can be specified: v Call Program (CALL) command: You can use the PARM parameter to pass a floating-point constant to a called program. Any program you call must receive a floating-point constant as a double precision value. v Change Program Variable (CHGPGMVAR) command: You can use the VALUE parameter to change a floating-point variable in a program. v Copy File (CPYF) command: You can use floating-point construction in the FROMKEY, TOKEY, and INCREL parameters to select which records are copied from a database file. For more information about floating-point constants see the DDS Reference information in the Database and Filesystems topic from the left navigation bar. v Character string on page 121 v Date values on page 123 v Hexadecimal values on page 124 v Decimal values on page 124 v Logical values Logical values: A logical value is a single character (1 or 0) enclosed in apostrophes. It is often used as a switch to represent a condition such as on or off, yes or no, and true or false. When used in expressions, it can be optionally preceded by *NOT or . The following are examples of logical values:
Constant 0 1 Value 0 1 Meaning Off, no, or false On, yes, or true
v Character string on page 121

125
v v v v
Date values on page 123 Decimal values on page 124 Hexadecimal values on page 124 Floating-point constants on page 125
Variables
A variable contains a data value that can be changed when a program is run. The variable is used in a command to pass the value that it contains at the time the command is run. The change in value can result if one of the following conditions occur: the value is received from a data area, a display device file field, or a message; the value is passed as a parameter; a Change Variable (CHGVAR) command is run in the program; or another program that is called changes the value before returning it. The variable name identifies a value to be used; the name points to where the actual data value is. Because CL variables are valid only in CL programs, they are often called CL program variables or, simply, CL variables. CL variable names must begin with an ampersand (&). CL variables can be used to specify values for almost all parameters of CL commands. When a CL variable is specified as a parameter value and the command containing it is run, the current value of the variable is used as the parameter value. That is, the variable value is passed as if the user had specified the value as a constant. Because it is generally true that CL variables can be used for most parameters of commands in CL programs, the command descriptions usually do not mention CL variables. For parameters that are restricted to constants only (such as in the DCL command), to CL variables only (such as all of the parameters of the Retrieve Job Attributes (RTVJOBA) command), or to specific types of variables (such as on the RTVJOBA or Retrieve Message (RTVMSG) command), the individual parameter descriptions specify those limitations. Otherwise, if the command is allowed in a CL program, CL variables can be used in place of a value, even with parameters that accept only predefined values. For example, a SAVE parameter having only predefined values of *YES and *NO can have a CL variable specified instead; its value can then be changed to *YES or *NO, depending on its value when the command is run. A CL variable must contain only one value; it may not contain a list of values separated by blanks. The value of any CL program variable can be defined as one of the following types: v Character: A character string that can contain a maximum of 9999 characters. The character string can be coded in quoted or unquoted form, but only the characters in the string itself are stored in the variable. v Decimal: A packed decimal value that can contain a maximum of 15 digits, of which no more than nine can be decimal positions. v Logical: A logical value of 1 or 0 that represents on/off, true/false, or yes/no.
126
If value is: Name Date or time Character string Numeric Logical
CL variable can be declared as: Character Character Character Decimal or character Logical or character
v Constant value on page 121 v Expressions v List of values
Expressions
An expression is a group of constants or variables, separated by operators, that produces a single value. The operators specify how the values are combined to produce the single value or result. The operators can be arithmetic, character string, relational, or logical. The constants or variables can be character, decimal, or logical. For example, the expression (&A + 1) specifies that the result of adding 1 to the value in the variable &A is used in place of the expression. Character string expressions can be used in certain command parameters defined with EXPR(*YES) in CL programs. An expression can contain the built-in functions %SUBSTRING (or %SST) and %SWITCH, which are covered in detail in Chapter 14. Expressions in CL commands on page 193. The types of expressions and examples of each are described there. v Constant value on page 121 v Variables on page 126 v List of values
List of values
A list of values is one or more values that can be specified for a parameter. Not all parameters can accept a list of values. A list parameter can be defined to accept a specific set of multiple values that can be of one or more types. Values in the list must be separated by one or more blanks. Each list of values is enclosed by parentheses, indicating that the list is treated as a single parameter. Parentheses are used even when a parameter is specified in positional form. To determine whether a list can be specified for a parameter, and what kind of list it can be, refer to the parameter description under the appropriate command description. A list parameter can be defined to accept a list of multiple like values (a simple list) or a list of multiple unlike values (a mixed list). Each value in either kind of list is called a list element. List elements can be constants, variables, or other lists; expressions are not allowed. v A simple list parameter accepts one or more values of the type allowed by a parameter. For example, (RSMITH BJONES TBROWN) is a simple list of three user names. v A mixed list parameter accepts a fixed set of separately defined values that are in a specific order. Each value can be defined with specific characteristics such as type and range. For example, LEN(5 2) is a mixed list in which the first element (5) gives the length of a field and the second element (2) gives the number of decimal positions in that field. v For many parameters defined to accept lists, predefined single values can be specified in place of a list of values. One of these single values can be the
127
default value, which can be either specified or assumed if no list is specified for a simple or mixed list. To determine what defaults are accepted for a given list parameter, refer to the description of the parameter in the description of the command for which the parameter is defined and used. Note: *N cannot be specified in a simple list, but it can be specified in a mixed list. Also, individual parameters passed on the CALL command cannot be lists. v The maximum level of nesting of lists inside lists is three, including the first. These are indicated by three nested levels of parentheses. The following are examples of lists:
The last two examples contain two lists nested inside a list: the first list contains values of A and B, and the second list contains values of 1 and 2. The space between the two nested lists is not required. Blanks are the separators between the values inside each nested list, and the sets of parentheses group the nested values into larger lists. v Constant value on page 121 v Variables on page 126 v Expressions on page 127
Commonly used parameters: Expanded descriptions

This section contains the expanded descriptions of some of the parameters commonly used in the CL commands. The parameters included here meet one or both of these criteria: v There is extensive information about how they are used. v They are used in many of the CL commands (such as the AUT parameter), and the parameter description in the individual command description gives only the essential information.
128
Expanded Parameter Descriptions

The expanded descriptions of the applicable command parameters have been placed here for several reasons: v to reduce the amount of material needed in the individual commands. Normally programmers familiar with a parameters main function do not need the details. v to provide the supplemental information that is useful to programmers in some instances. The format for this information is designed for easy reference and includes a general description of each parameter that explains its function, states the rules for its use, and provides other helpful information. The values that can be specified for each parameter are also listed. Each value is followed by an explanation of what it means and (possibly) in which commands it is used. Not all of the values appear in every command. Refer to the individual command descriptions for the specific use of the value in that command parameter.
AUT parameter CLS parameter on page 130 COUNTRY parameter on page 131 EXCHTYPE parameter on page 137 Double-byte character text in CL commands on page 140 FILETYPE parameter on page 138 FRCRATIO parameter on page 138 IGCFEAT parameter on page 140 JOB parameter on page 141 LABEL parameter on page 142 MAXACT parameter on page 144 OBJ parameter on page 145 OBJTYPE parameter on page 145 OUTPUT parameter on page 149 PRTTXT parameter on page 149 REPLACE parameter on page 151 Scheduling priority parameters (JOBPTY, OUTPTY, PTYLMT) on page 152 SEV parameter on page 153 SPLNBR parameter on page 155 TEXT parameter on page 155 VOL parameter on page 156 WAITFILE parameter on page 157
AUT parameter
You use the authority (AUT) parameter in create, grant, and revoke commands. It specifies the authority granted to all users of an object. It also specifies an authorization list that is used to secure the object. Four object types allow the AUT parameter to contain an authorization list: LIB, PGM, DTADCT, and FILE. Public authority is an OS/400 object attribute that controls the base set of rights to that object for all users having access to the system. These rights can be extended or reduced for specific users. If you specify an authorization list, the public authority in the authorization list is the public authority for the object. The owner of an object has all authority to the object at its creation. If the object is created as a private object or with the limited authority given to all users, the owner can grant more or less authority to specific users by specifically naming them and stating their authority in the Grant Object Authority (GRTOBJAUT) command. The owner also can withdraw specific authority from specific users, or from all users (publicly authorized and/or specifically authorized) by using the Revoke Object Authority (RVKOBJAUT) command or the Edit Object Authority (EDTOBJAUT) command. The Security Reference book has a complete description of security provisions and applicable rights of use by object type.
129

Values allowed *LIBCRTAUT: The public authority for the object is taken from the value on the CRTAUT parameter of the target library (the library that is to contain the object). The public authority is determined when the object is created. If the CRTAUT value for the library changes after the object is created, the new value does not affect any existing objects. *USE: You can perform basic operations on the object, such as running a program or reading a file. The user cannot change the object. *USE authority provides object operational authority, read authority, and execute authority. *CHANGE: You can perform all operations on the object except those limited to the owner or controlled by object existence authority and object management authority. You can change and perform basic functions on the object. Change authority provides object operational authority and all data authority. *ALL:You can perform all operations except those limited to the owner or controlled by authorization list management authority. Your can control the objects existence, specify the security for the object, change the object, and perform basic functions on the object. You also can change ownership of the object. *EXCLUDE: You cannot access the object. *EXECUTE: You can run a program or procedure or search a library or directory. authorization-list-name: Specify the name of the authorization list whose authority is used.
CLS parameter
The class (CLS) parameter identifies the attributes that define the run time environment of a job. The following attributes are defined in each class: v Run priority: A number that specifies the priority level assigned to all jobs running that use the class. The priority level is used to determine which job, of all the jobs competing for system resources, is run next. The value can be 1 through 99, where 1 is the highest priority (all jobs having a 1 priority are run first). v Time slice: The maximum amount of processor time that the system allows the job to run when it is allowed to begin. The time slice indicates the amount of time needed for the job to accomplish a meaningful amount of work (the time used by the system for reading auxiliary storage is not charged against the time slice). When the time slice ends, the job waits while other queued jobs of the same or higher priority are allowed to run (up to the time specified in their time slices); then the job is given another time slice. v Purge value: Indicates whether the job step is eligible to be moved from main storage to auxiliary storage while the job is waiting for some resource before it can continue, or when its time slice is used up and equal or higher priority jobs are waiting. v Default wait time: The default amount of time that the system waits for the completion of an instruction that performs a wait. This wait time applies to times when an instruction is waiting for a system action, not to the time an instruction is waiting for a response from a user. Normally, this would be the amount of time you are willing to wait for the system before ending the request.
130

If the wait time is exceeded, an error message is passed to the job. This default wait time applies only when a wait time is not specified in the CL command that causes the wait. The wait time used for allocating file resources is specified in the file description and can be overridden by an override command. It specifies that the wait time specified in the class object is used. If file resources are not available when the file is opened, the system waits for them until the wait time ends. Note: The class attributes apply to each routing step of a job. Most jobs have only one routing step, but if the job is rerouted (because of something like the Remote Job or Transfer Job command) the class attributes will be reset. v Maximum CPU time: The maximum amount of processor time (the sum of the time slices if they differ, or time slice period multiplied by number of time slices if they are equal) allowed for a jobs routing step to complete processing. If the jobs routing step is not completed in this amount of time, it is ended, and a message is written to the job log. v Maximum temporary storage: The maximum amount of temporary storage that can be used by a jobs routing step. This temporary storage is used for the programs that run in the job, for the system objects used to support the job, and for temporary objects created by the job. The system is shipped with a set of classes that define the attributes for several job processing environments. Other classes can be created by the Create Class (CRTCLS) command; any class can be displayed or deleted by the respective Display Class (DSPCLS) and Delete Class (DLTCLS) commands. Values allowed qualified-class-name: Specify the name of the class, optionally qualified by the name of the library in which the class is stored. If the class name is not qualified and the CLS parameter is in the CRTCLS command, the class object is stored in *CURLIB; otherwise, the library list (*LIBL) is used to find the class name. The following classes (by name) are supplied with the system: QGPL/QBATCH For use by batch jobs QSYS/QCTL For use by the controlling subsystem QGPL/QINTER For use by interactive jobs QGPL/QPGMR For use by the programming subsystem QGPL/QSPL For use by the spooling subsystem printer writer QGPL/QSPL2 For general spooling use in the base system pool
COUNTRY parameter
The Country parameter specifies the country code part of the X.400 O/R name. An ISO 3166 Alpha-2 code or an ITU-T country code can be specified. (The ITU-T country code is the data country or geographical area code published in the
131

International Numbering Plan for Public Data Networks, Recommendation X.121 (09/92), by the ITU-T (formerly CCITT). Table 4 is a list of the possible country codes that can be specified. Values allowed *NONE: No country code is specified. country-code: Specify an ISO 3166 Alpha-2 code or a CCITT (also known as ITU-2) country code from the following table.
Table 6. ISO X.400 Country Codes Country ISO 3166 Alpha-2 Code Afghanistan Albania Algeria American Samoa Andorra Angola Anguilla Antarctica Antigua and Barbuda Argentina Armenia Aruba Australia Austria Azerbaijan Bahamas Bahrain Bangladesh Barbados Belarus Belgium Belize Benin Bermuda Bhutan Bolivia Bosnia and Herzegovina Botswana Bouvet Island Brazil British Indian Ocean Terr. Brunei Darussalam Bulgaria Burkina Faso Burundi Cambodia Cameroon Canada Cape Verde Cayman Islands Central African Republic Chad AF AL DZ AS AD AO AI AQ AG AR AM AW AU AT AZ BS BH BD BB BY BE BZ BJ BM BT BO BA BW BV BR IO BN BG BF BI KH CM CA CV KY CF TD ITU-T1 Country Code 412 276 603 544 631
344 722 283 362 505 232 400 364 426 470 342 257 206 702 616 350 736 652 724 528 284 613 642 456 624 302, 303 625 346 623 622
132

Table 6. ISO X.400 Country Codes (continued) Country ISO 3166 Alpha-2 Code Chile China Christmas Island Cocos (Keeling) Islands Colombia Comoros Congo Cook Islands Costa Rica Cote dIvoire Croatia Cuba Cyprus Czech Republic Denmark Djibouti Dominica Dominican Republic East Timor Ecuador Egypt El Salvador Equatorial Guinea Eritrea Estonia Ethiopia Falkland Islands (Malvinas) Faroe Islands Fiji Finland France France, Metropolitan French Antilles French Guiana French Polynesia French Southern Terr. Gabon Gambia Georgia Germany Ghana Gibralter Greece Greenland Grenada Guadeloupe Guam Guatemala Guinea Guinea-Bissau Guyana Haiti CL CN CX CC CO KM CG CK CR CI HR CU CY CZ DK DJ DM DO TP EC EG SV GQ ER EE ET FK FO FJ FI FR FX GF PF TF GA GM GE DE GH GI GR GL GD GP GU GT GN GW GY HT ITU-T1 Country Code 730 460
732 654 629 548 712 612 368 280 230 238 638 366 370 740 602 706 627 248 636 288 542 244 208, 209 340 742 547 628 607 282 262 - 265 620 266 202 290 352 535 704 611 632 738 372
133

Table 6. ISO X.400 Country Codes (continued) Country ISO 3166 Alpha-2 Code Heard and Mc Donald Islands Honduras Hong Kong Hungary Iceland India Indonesia Iran Iraq Ireland Israel Italy Jamaica Japan Jordan Kazakhstan Kenya Kiribati Korea, Democratic Peoples Republic Korea, Republic of Kuwait Kyrgyzstan Lao Peoples Democratic Rep. Latvia Lebanon Lesotho Liberia Libyan Arab Jamahiriya Liechtenstein Lithuania Luxembourg Macau (Macao) Macedonia 2 Madagascar Malawi Malaysia Maldives Mali Malta Marshall Islands Martinique Mauritania Mauritius Mayotte Mexico Micronesia Moldova, Republic of Monaco Mongolia Montenegro 2 Montserrat HM HN HK HU IS IN ID IR IQ IE IL IT JM JP JO KZ KE KI KP KR KW KG LA LV LB LS LR LY LI LT LU MO MK 2 MG MW MY MV ML MT MH MQ MR MU YT MX FM MD MC MN ME 2 MS 708 453, 454 216 274 404 510 432 418 272 425 222 338 440 - 443 416 401 639 545 467 450, 480, 481 419 437 457 247 415 651 618 606 246 270 455 646 650 502 472 610 278 ITU-T1 Country Code
609 617 334 550 259 212 428 354
134

Table 6. ISO X.400 Country Codes (continued) Country ISO 3166 Alpha-2 Code Morocco Mozambique Myanmar Namibia Nauru Nepal Netherlands Netherlands Antilles New Caledonia New Zealand Nicaragua Niger Nigeria Niue Norfolk Island Northern Mariana Islands Norway Oman Pakistan Palau Panama Papua New Guinea Paraguay Peru Philippines Pitcairn Poland Portugal Puerto Rico Qatar Reunion Romania Russian Federation Rwanda St. Helena St. Kitts and Nevis St. Lucia St. Pierre and Miquelon St. Vincent and the Grenadines Samoa, Western San Marino Sao Tome and Principe Saudi Arabia Senegal Serbia 2 Seychelles Sierra Leone Singapore Slovakia Slovenia Solomon Islands Somalia MA MZ MM NA NR NP NL AN NC NZ NI NE NG NU NF MP NO OM PK PW PA PG PY PE PH PN PL PT PR QA RE RO RU RW SH KN LC PM VC WS SM ST SA SN SP 2 SC SL SG SK SI SB SO ITU-T1 Country Code 604 643 414 649 536 429 204, 205 362 546 530 710 614 621
534 242 422 410 714 537 744 716 515 260 268 330 427 647 226 250, 251 635 356 358 308 360 549 292 626 420 608 633 619 525
540 637
135

Table 6. ISO X.400 Country Codes (continued) Country ISO 3166 Alpha-2 Code South Africa South Georgia and the S.S.I Spain Sri Lanka Sudan Suriname Svalbard and Jan Mayen Is. Swaziland Sweden Switzerland Syrian Arab Republic Taiwan, Province of China Tajikistan Tanzania, United Republic of Thailand Togo Tokelau Tonga Trinidad and Tobago Tunisia Turkey Turkmenistan Turks and Caicos Islands Tuvalu Uganda Ukraine United Arab Emirates United Kingdom United States United States Minor Outlying Is. Uruguay Uzbekistan Vanuatu Vatican City State (Holy See) Venezuela Viet Nam Virgin Is. (Brit.) Virgin Is. (U.S.) Wallis and Futuna Is. Western Sahara Yemen Yugoslavia, territories of the former Zaire Zambia Zimbabwe ZA GS ES LK SD SR SJ SZ SE CH SY TW TJ TZ TH TG TK TO TT TN TR TM TC TV UG UA AE GB US UM UY UZ VU VA VE VN VG VI WF EH YE YU ZR ZM ZW ITU-T1 Country Code 655 214 413 634 746 653 240 228 417 466 436 640 520 615 539 374 605 286 438 376 641 255 424, 430, 431 234, 235, 236, 237 310 - 316
748 434 541 225 734 452 348 332 543 421, 423 220 630 645 648
136

Table 6. ISO X.400 Country Codes (continued) Country ISO 3166 Alpha-2 Code Note:
1
ITU-T1 Country Code
This International Telecommunication Union (ITU) committee was formerly known as CCITT. At the time of publication, the ISO 3166 Alpha-2 Code for this country could not be confirmed. Before using this code, be sure to confirm with the latest ISO 3166 standard.
EXCHTYPE parameter
| | | | You use the Exchange Type (EXCHTYPE) parameter to specify which one of the three diskette exchange types (basic, H, or I) the system will use when writing diskette files. The exchange type will be stored in the volume label area on the diskette. There is one label for each data file on the diskette. You can specify the exchange type to be used in one of the diskette device file commands (Create Diskette File (CRTDKTF), Change Diskette File (CHGDKTF), or Override Diskette File (OVRDKTF)). It can also be passed as a parameter when the device file is opened by the high-level language program (if supported). | | | | | The system will not use the exchange type specified in the diskette device file or high-level language program when processing a diskette input file. Instead, the system will use the exchange type from the file label on the diskette. It is possible for one diskette to contain both basic and I exchange format files or H and I format files. One diskette cannot contain both basic and H format files. Values allowed | | | | | | | | You can specify one of the following values for the EXCHTYPE parameter, depending on the diskette type (1, 2, or 2D) and the diskette sector size (128, 256, 512, or 1024 bytes): *STD: The system determines the exchange type based on the diskette type and sector size. A basic exchange type is used if the diskette type is 1 or 2, and the diskette sector size is 128 bytes. An H exchange type is used if the diskette type is 2D and the diskette sector size is 256 bytes. The *STD value is not valid for any other combination of type and sector size. *BASIC: The basic exchange type is used. The diskette type must be 1 or 2, and the diskette sector size must be 128 bytes. *H: The H exchange type is used. The diskette type must be 2D, and the diskette sector size must be 256 bytes. *I: The I exchange type is used. The diskette type and sector size may be any of the following: Diskette type Sector size (bytes) 1 2 128, 256, or 512 128, 256, or 512
137

2D 256, 512, or 1024
FILETYPE parameter
The FILETYPE parameter specifies whether the database file description describes data records or source records. Further, it specifies whether each member of a database file being created is to contain data records or source records (statements). For example, the file could contain RPG source statements for an RPG program or data description source (DDS) statements for another device or database file. Note: If you are creating a source type physical database file and are not providing field-level descriptions of the file (through data description specifications (DDS)), you can use either the Create Physical File (CRTPF) command or the Create Source Physical File (CRTSRCPF) command. However, the CRTSRCPF command is usually more convenient and efficient, because it is designed to be used to create source physical files. If DDS is provided when you are creating a source type database file, you should use the CRTPF command or the Create Logical File (CRTLF) command, which both have the SRCFILE and SRCMBR parameters for specifying source input. Records in a source file must have at least three fields: the first two are the source sequence number field and the date field; the third field contains the source statement. These three fields are automatically provided by the OS/400 when a source file is created for which no DDS is provided; additional source fields can be defined in DDS. The length of the sequence number field must be six zoned digits with two decimal places. The length of the date field must be six zoned digits with no decimal places. The source sequence number and date fields are added to the source record when: v Records are read into the system. v Records are created by the Source Entry Utility (which is part of the licensed Application Development* Tools program). The fields are added when an inline data file (specified as the standard source file format) is read from the diskette device. The spooling reader places a sequence number in the source sequence number field and sets up a zeroed date field. If those fields already exist in records read from the diskette device, they are not changed. If the records in a database file are in source format and are being read as an inline data file in data format, the source sequence number and date fields are removed. For more information about data and source files, see DB2 for AS/400 Database Programming book. Values allowed *DATA: The file created contains or describes data records. *SRC: The file created contains or describes source records. If the file is keyed, the 6-digit source sequence number field must be used as the key field.
FRCRATIO parameter
The force write ratio (FRCRATIO) parameter specifies the maximum number of records that can be inserted, updated, or deleted before they are forced into
138

auxiliary (permanent) storage. The force write ratio ensures that all inserted, updated, or deleted records are written into auxiliary storage at least as often as this parameter specifies. In the event of system failure, the only records likely to be lost would be those that were inserted, updated, or deleted since the last force write operation. The force write ratio is applied to all records inserted, updated, or deleted in the file through the open data path (ODP) to which the force write ratio applies. If two programs are sharing the file, SHARE(*YES), the force write ratio is not applied separately to the set of records inserted, updated, or deleted by each program. It is applied to any combination of records (from both programs) that equals the specified force write ratio parameter value. For example, if a force write ratio of 5 was specified for the file, any combination of five records from the two programs (such as four from one program and one from the other) forces the records to be written to auxiliary storage. If two or more programs are using the file through separate ODPs, the insertions, updates, and deletions from each program are accumulated individually for each ODP. Each database file can have a force write ratio assigned to it. Logical files, which can access data from more than one physical file, can specify a more restrictive force write ratio (a smaller number of records) than that specified for the based-on physical files. However, a logical file cannot specify a less restrictive force write ratio. If a logical file specifies a less restrictive force write ratio than that specified for any of the physical files, the most restrictive force write ratio from the physical files is used for the logical file. For example, if the force write ratios of three physical files are 2, 6, and 8, the force write ratio of a logical file based on these physical files cannot be greater than 2. If no force write ratio is specified for the logical file, 2 is assumed. Thus, each time a program inserts, updates, or deletes two records in the logical file (regardless of which physical files are affected), those records are forced into auxiliary storage. The FRCRATIO number overrides the SEQONLY number specified. For example, if you specify:
OVRDBF ... SEQONLY(*YES 20) FRCRATIO(5)
The value of 20 is overridden and a buffer of five records is used. When FRCRATIO(1) is used, a buffer still exists, but it contains only a single record. Access paths associated with the inserted, updated, and deleted records are written to auxiliary storage only when all the records covered by the access path have been written to auxiliary storage. If only one ODP exists for the file, the access path is forced to auxiliary storage whenever a forced write occurs. If two or more ODPs to the file exist, the access path is written to auxiliary storage whenever all the inserted, updated, and deleted records for all the ODPs have been forced. Notes: 1. These rules apply only when a force write ratio of 2 or higher is specified. When a force write ratio of 1 is specified, the access path is not written to auxiliary storage until all the ODPs have been closed. 2. If the file is being recorded in a journal. FRCRATIO(*NONE) should be specified. More information is in the OS/400 Backup and Recovery book. Values allowed *NONE: There is no specified ratio; the system determines when the records are written to auxiliary storage.
139

number-of-records-before-force: Specify the number of updated, inserted, or deleted records that are processed before they are explicitly forced to auxiliary storage.
IGCFEAT parameter
The IGCFEAT parameter specifies which double-byte character set (DBCS) table is used, according to device and language. The following table indicates the corresponding IGCFEAT parameter and DBCS font table for the double-byte character set device being configured.
Table 7. DBCS Features Configurable on the IGCFEAT Parameter Language/Device Japanese Display Stations Type of Physical DBCS Work Station 5295-001 Display 5295-002 Display InfoWindow 3477-J Display PS/55 with 5250PC PS/55* with graphics 5250PC PS/55* with graphics 5250PC PS/55 with 5250PC/2 3270-type Display PS/55 with Client Access/400 by OS/400 Japanese 24x24 Printers Attached to 5295-001 Display Attached to 5295-002 Display Attached to PS/55 5227-001 Printer 5327-001 Printer 5337-001 Printer 5383-200 Printer 5250-Type Display 3270-Type Display Attached to 5295 Display Attached to PS/55 5227-002 Printer 5250-Type Display 3270-Type Display Attached to 5295 Display Attached to PS/55 5227-003 Printer Configure as Type-Model 5555-B01 5555-B01 5555-B01, C01 5555-B01 5555-G01 5555-G02 5555-E01 3279-0 5555-B01 5553-B01 5553-B01 5553-B01 5553-B01 5553-B01 5553-B01 5583-200 5555-B01 3279-0 5553-B01 5553-B01 5553-B01 5555-B01 3279-0 5553-B01 5553-B01 5553-B01 5555-B01 3279-0 5553-B01 5553-B01 Configure with DBCS Feature ((2424J4 55FE)) ((2424J4 68FE)) ((2424J4 68FE)) ((2424J4 ((2424J4 ((2424J4 ((2424J0 ((2424J0 ((2424J0 ((2424J1 ((2424J1 ((2424J1 ((2424J2 ((2424J2 68FE)) 68FE)) 68FE)) (1))) (1))) (1))) 55FE)) 68FE)) 68FE)) 55FE)) 68FE))
Japanese 32x32 Printers Korean Display Stations Korean 24x24 Printers Traditional Chinese Display Stations Traditional Chinese 24x24 Printers
((3232J0 (1))) ((3232J0 (1))) ((2424K0 (1))) ((2424K0 (1))) ((2424K0 (1))) ((2424K0 (1))) ((2424K2 52FE)) ((2424C0)) ((2424C0)) ((2424C0)) ((2424C0)) ((2424C2 5CFE)) ((2424S0)) ((2424S0)) ((2424S0)) ((2424S2 6FFE))
Simplified Chinese 5250-Type Display Display Stations 3270-Type Display Simplified Chinese Attached to PS/55 24x24 Printers 5227-005 Printer
Double-byte character text in CL commands

You can use double-byte character data anywhere in a CL command that descriptive text can be used. Enter double-byte character text as follows: 1. Begin the double-byte character text with an apostrophe (). 2. Enter a shift-out character.
140

3. Enter the double-byte character text. 4. Enter a shift-in character. 5. End the double-byte character text with an apostrophe (). For example, to enter the double-byte character literal ABC, enter the following, where 0E represents the shift-out character and 0F represents the shift-in character: 0EABC0F Limit the length of a double-byte character text description of an object to 14 double-byte characters, plus the shift control characters, to make sure that the description is properly displayed and printed.
JOB parameter
The JOB parameter specifies the name of the job to which the command is applied. The job name identifies all types of jobs on the system. Each job is identified by a qualified job name, which has the following format: job-number/user-name/job-name Note: Although the syntax is similar, job names are qualified differently than OS/400 object names. The following list describes the pieces of the qualified job name: v Job number: The job number is a unique 6-digit number that is assigned to each job by the system. The job number provides a unique qualifier if the job name is not otherwise unique. The job number can be determined by means of the Display Job (DSPJOB) command. If specified, the job number must have exactly six digits. v User name: The user name identifies the user profile under which the job is to run. The user name is the same as the name of the user profile and contains a maximum of 10 alphanumeric characters. The name can come from one of several sources, again, depending on the type of job: Batch job: The user name is specified on the SBMJOB command, or it is specified in the job description referenced by the BCHJOB or SBMJOB commands. Interactive job: The user name is specified at sign-on, or the user name is provided from the default in the job description referred to by the work stations job entry. Autostart job: The user name is specified in the job description referred to by the job entry for the autostart job. v Job name: The job name can contain a maximum of 10 alphanumeric characters, of which the first character must be alphabetic. The name can come from one of three sources, depending on the type of job: Batch job: The job name is specified on the Batch Job (BCHJOB) or Submit Job (SBMJOB) commands or, if not specified there, the unqualified name of the job description is used. Interactive job: The job name is the same as the name of the device (work station) from which the sign-on was performed. Autostart job: The job name is provided in the autostart job entry in the subsystem description under which the job runs. The job name was specified in the Add Autostart Job Entry (ADDAJE) command.
141

Commands only require that the simple name be used to identify the job. However, additional qualification must be used if the simple job name is not unique. Duplicate job names | | | | | If a duplicate job name is specified in a command in an interactive job, the system displays all of the duplicates of the specified job name to the user in qualified form. The job names are displayed in qualified form along with the user name and job number so that you can further identify the job that is to be specified in a command. You can then enter he correct qualified job name. If a duplicate job name is used in a command in a batch job, the command is not processed. Instead, an error message is written to the job log. Values allowed The JOB parameter can have one or more of the following values, depending upon the command: *: The job is the one in which the command is entered; that is, the command with JOB(*) specified on it. *JOBD: The simple job name is the unqualified name of the job description. *NONE: No job name is specified as in the Display Log (DSPLOG) command. job-name: A simple job name is specified. | | | | qualified-job-name: You must specify a qualified job name. If no job qualifier (user name and job number) is given, all of the jobs currently in the system are searched for the job name. If duplicates of the specified name are found, a qualified job name must be specified.
LABEL parameter
| | | | | | | | The LABEL parameter specifies the data file identifier of the data file (on diskette or tape) used in input and/or output operations. The data file can be in either the exchange format or the save/restore format. Note: The device file commands are used for diskettes and tapes that are in the exchange format only, not for those in the save/restore format; user-defined device files are not used in save/restore operations. Each data file that is on a diskette or tape has its data file identifier stored in its own file label. On diskette, all of the data file labels are in one place, in the volume label area of that diskette. In addition to the data file identifier, each label contains other information about the file, such as where the file is stored on the diskette (track and sector) and whether the file continues on another diskette (in the case of a multivolume data file). On tape, the data file label (or header label) of each data file is stored on the tape just before the data in the file. That is, each file on the tape has its own header label and its own data records together as a unit, and one file follows another. In
142

addition to the data file identifier, each label also contains other information about the file, such as the file sequence number, record and block attributes, and whether it is a multivolume data file. | | | | | | | | | | | Generally, the data file identifier is an alphanumeric character string that contains no more than 8 characters. However, the maximum length actually depends on several things: what data format is used for the files, whether the files are on diskette or on tape, and CL commands in which the identifiers are specified. The unused portion of the file identifier field should be left blank. The first character of the data file identifier must be alphabetic (A through Z, $, #, or @) and the rest of the characters should be alphanumeric (A through Z, 0 through 9, $, #, _, ., and @). You can use special characters if the identifier is enclosed in apostrophes. However, if the diskette or tape is used on a system other than an AS/400 system, the requirements for specifying identifiers on that system must be considered. Diskette and tape data file identifiers For diskettes in the exchange format, the data file identifier cannot exceed 8 characters (the same limit as for RPG file names). This limitation applies to the following commands: Create Diskette File (CRTDKTF), Change Diskette File (CHGDKTF), Change Spooled File Attributes (CHGSPLFA), Override Diskette File (OVRDKTF), Delete Diskette Label (DLTDKTLBL), Display Diskette (DSPDKT), and Start Diskette Reader (STRDKTRDR). For tapes, the identifier can have as many as 17 characters. However, if a tape is used on a system other than an AS/400 system, a maximum of 8 characters, or a qualified identifier of no more than 17 characters, should be used. If more than 8 characters are used, the identifier should be qualified and enclosed in apostrophes so that no more than 8 characters occur in either part, and the parts are separated by a period; for example, LABEL(TAXES.JAN1980). This limitation applies to the following commands: Create Tape File (CRTTAPF), Change Tape File (CHGTAPF), Override Tape File (OVRTAPF), and Display Tape (DSPTAP). Duplicate data file identifiers are not allowed in the same volume, on either diskette or tape. However, the identifier can be the same as the name of the database file written to diskette or tape if the file name contains no more than 8 characters. The diskette and tape data files contain only data, not file descriptions like those of database files. On diskette, the identifiers ERRORSET and SYSAREA cannot be used; they are reserved for special use. The data file identifier is put on the volume when the data file is put on the volume. For input/output operations, the identifier can be specified in one of the diskette or tape device file commands, or it can be passed as a parameter when the device file is opened by the high-level language program that uses the file. Save/Restore format For diskettes in the save/restore format, the data file identifier can have a maximum of 17 characters. If a library name is used to generate the label, the file identifier can have a maximum of 15 characters. The identifier consists of a library name of up to 10 characters followed by a period, a Q, and a 3-digit sequence number; for example, LABEL(PAYLIB.Q014). The 15-character limit applies to identifiers of save/restore data files displayed by the DSPDKT command.
143

For tapes in the save/restore format, the identifier can have a maximum of 17 characters. If a library name is used to generate the label, the identifier cannot exceed 10 characters. You may specify a label other than a library name. Values allowed One of the following values can be specified for the LABEL parameter, depending upon the command. *ALL: Labels for all the data file identifiers in the specified diskette or tape volumes are shown on the display. *NONE: The data file identifier is not specified. It must be supplied before the device file (and/or database file) is opened to be used in the diskette or tape operation. *SAME: The data file identifier already present in the diskette or tape device file does not change. data-file-identifier: Specify the identifier of the data file (on diskette or tape) used or displayed with the device file description. *LIB: The file label is created by the system and the name of the library specified on the LIB parameter is used as the qualifier for the file name. *SAVLIB: The file label is created by the system, and the name of the library specified on the SAVLIB parameter is used as the qualifier for the file name.
MAXACT parameter
The maximum activity level (MAXACT) parameter specifies the maximum number of jobs that can be concurrently started and that remain active through a job queue entry, communications entry, routing entry, or work station entry. A job is considered active from the time it starts running until it is completed. This includes time when: v The job is actually being processed. v The job is waiting for a response from a work station user. v The job is started and available for processing but is not actually using the processor. For example, it might have used up its time slice and is waiting for another time slice. v The job is started but is not available for processing. For example, it could be waiting for a message to arrive on its message queue. Values allowed *NOMAX: There is no maximum number of jobs that can be active at the same time. maximum-active-jobs: Specify a value that indicates the maximum number of jobs that can be concurrently active through this entry. See the OS/400 Work Management book for a description of activity level controls.
144
OBJ parameter
The object (OBJ) parameter specifies the names of one or more objects affected by the command in which this parameter is used. All of the objects must be in the library specified in the LIB parameter, the SAVLIB parameter, or the library qualifier in the OBJ parameter, depending upon which command is used. On some commands, the generic name of a group of objects can be specified. To form a generic name, add an asterisk (*) after the last character in the common group of characters; for example, ABC*. If an * is not included with the name, the system assumes that the name is a complete object name. Values allowed Depending on the command, the following types of values can be specified on the OBJ parameter: *ALL Simple object name Qualified object name Generic object name Qualified generic object name
OBJTYPE parameter
The object type (OBJTYPE) parameter specifies the types of OS/400 objects that can be operated on by the command in which they are specified. The object types that can be specified in the OBJTYPE parameter vary from command to command. The primary purpose of Table 8 is to provide you with a list of the object types that can be operated on by commands containing the OBJTYPE parameter. The Xs indicate that the object type (in the same row as the X) can be specified as a value for the OBJTYPE parameter of the command (in the same column as the X). The table also provides you with an index to the object-related commands that operate on most objects. The object-related commands allow you to perform general functions on most objects without knowing the special commands related to the specific object type. For example, you could use the CRTDUPOBJ command to create a copy of a file or library instead of the specific commands CPYF (Copy File) or CPYLIB (Copy Library). The table can help you determine whether you can use the general object-related commands to perform a function on a specific object. The following commands also contain the OBJTYPE parameter but are not included in the table because they operate on only a few object types. v CHKDLO operates on *DOC and *FLR. v CPROBJ and DCPOBJ operate on *FILE, *MENU, *MODULE, *PGM, *PNLGRP, and *SRVPGM. v CRTSQLPKG operates on *PGM and *SRVPGM. v DSPPGMADP operates on *PGM, *SQLPKG, and *SRVPGM. v DSPPGMREF operates on *PGM and *SQLPKG.
145

v RSTCFG operates on *CFGL, *CNNL, *COSD, *CTLD, *DEVD, *LIND, *MODD, and *NWID. v SAVLICPGM operates on *LNG and *PGM. v SETOBJACC operates on *FILE and *PGM. The DSPLNK and WRKLNK commands operate on all object types. The ALCOBJ and DLCOBJ commands also require that an object type value is specified. However, for these commands, the object type value is specified as one of four values (in a list of values) on the required parameter OBJ. The following object types can be specified for the OBJ parameter on the ALCOBJ and DLCOBJ commands: *AUTL, *BNDDIR, *CLD, *CRQD, *CSI, *DEVD, *DTAARA, *DTADCT, *DTAQ, *FCT, *FILE, *FNTRSC, *FORMDF, *IPXD, *LIB, *MENU, *MODULE, *MSGQ, *NODL, *NTBD, *NWSD, *OVL, *PAGDFN, *PAGSEG, *PDG, *PGM, *PNLGRP, *PSFCFG, *QMFORM, *QMQRY, *QRYDFN, *SBSD, *SCHIDX, *SQLPKG, *SRVPGM, *SSND, *S36, *USRIDX, *USRQ, *USRSPC, and *WSCST. Note: RTVOBJD and DSPOBJD support the same object types. To see which object types are supported by RTVOBJD, refer to the column labeled DSPOBJD in the following table.
Table 8. Object Types Used by Commands Containing the OBJTYPE Parameter Basic Object-Related Commands Object C H G O B J A U D x x x x x x x x x x x x x x Object Authority D S P O B J A U T x x x x x x x x x x x x x x E D T O B J A U T x x x x x x x x x x x x x x G R T O B J A U T x R V K O B J A U T x General C H G O B J O W N x x x x x x x x x x x x x x C R T D U P O B J x x x x x x x W R K O B J L C K x x x x x x x x x x x x x C H G O B J P G P x x x x x x x x x x x x x x Other Object-Related Commands D M P S Y S O B J x x x x x x x x x x x x x x x P R T D S K I N F x x x x x x x x x x x x x x S A V C H G O B J x
C H K O B Value J x *ALRTBL *AUTL x *BLKSF x *BNDDIR *CFGL x x *CHTFMT *CLD x *CLS x *CMD x *CNNL x *COSD x x *CSI *CRG *CRQD x *CTLD x *DEVD x
D M P O B J x x x x x x x x x x x x x x
M O V O B J x
R N M O B J x x x x x x x x
W R K O B J x x x x x x x x x x x x x x
C H G O B J D x x x x x x x x x x
D S P O B J D x x x x x x x x x x
R S T O B J x x x x x x x
S A V O B J x
x x x x x
x x x x x x x x x x x x
x x x x x
x x x x x
x x x x x
x x
x x
x x
x x
x x x
x x x
146

Table 8. Object Types Used by Commands Containing the OBJTYPE Parameter (continued) Basic Object-Related Commands Object C H G O B J A U D x Object Authority D S P O B J A U T x x x x x x x x x x x x x x x x E D T O B J A U T G R T O B J A U T R V K O B J A U T General C H G O B J O W N C R T D U P O B J W R K O B J L C K x x x x x x x x x x x C H G O B J P G P Other Object-Related Commands D M P S Y S O B J x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x P R T D S K I N F x x x x x x x x x x x x x x x x x x x x x x x x x S A V C H G O B J
C H K O B Value J *DDIR x *DIR *DOC x *DSTMF x *DTAARA x *DTADCT *DTAQ *EDTD x x *EXITRG *FCT x *FILE x *FLR x x *FNTRSC x *FNTTBL x *FORMDF *FTR x *GSS x x *IGCDCT x *IGCSRT x *IGCTBL *IPXD x *JOBD x *JOBQ x x *JOBSCD *JRN x x *JRNRCV x *LIB *LIND x *MEDDFN *MENUx *MTGCOL *MODDx x *MODULE *MSGF x *MSGQ x x *NODGRP *NODL x *NTBD x *NWID x *NWSD x
D M P O B J x x
M O V O B J
R N M O B J
W R K O B J x
C H G O B J D
D S P O B J D x x x x
R S T O B J
S A V O B J
x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x
x x
x x x
x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x
x x
x x x
x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x
x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x
x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x
x x x x x x x x x x x x x x x x x x x x x x x x x x x x x
x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x
x x x x x x x x x x x x x x x x x x x x x x x x x x x x
x x
x x x x
x x x x x x x x x x x x x x x x x
x x x x x x x
x x x x x x x
x x x x x x x x x x
x x x x
x x
x x x x x x x x x x x x x x x
x x x x x x x x x x x x x x
x x x x x x x x x x x x x x
x x x x x
x x x x x x x
x x x x
x x x x x
x x x x x
x x x x x
147

Table 8. Object Types Used by Commands Containing the OBJTYPE Parameter (continued) Basic Object-Related Commands Object C H G O B J A U D x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x Object Authority D S P O B J A U T x x x x x x x x x x x x x x x x x x x x x x x x x x x x E D T O B J A U T x x x x x x x x x x x x x x x x x x x x x x x x x x x x G R T O B J A U T x x x x x x x x x x x x x x x x x x x x x x x x x x x x R V K O B J A U T x x x x x x x x x x x x x x x x x x x x x x x x x x x x General C H G O B J O W N x x x x x x x x x x x x x x x x x x x x x x x x x x C R T D U P O B J x x x x x x x x x x x x x x x x W R K O B J L C K x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x C H G O B J P G P x x x x x x x x x x x x x x x x x Other Object-Related Commands D M P S Y S O B J x x x x x x x x x x x x x x x x x P R T D S K I N F x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x S A V C H G O B J x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x
C H K O B Value J *OUTQ x *OVL x x *PAGDFN x *PAGSEG *PDG x *PGM x x *PNLGRP *PRDAVL x *PRDDFN *PRDLOD x *PSFCFG
D M P O B J x x x x x x x x x x x
M O V O B J x x x x x x x x x x x x x x x x
R N M O B J x x x x x x x x x x x x x x x x x
W R K O B J x x x x x x x x x x x x x x x x
C H G O B J D x x x x x x x x x x x x x x x x x
D S P O B J D x x x x x x x x x x x x x x x x
R S T O B J x x x x x x x x x x x x x x x x x x x x x x x x x x x x x
S A V O B J x x x x x x x x
*QMFORM x x *QMQRY x x *QRYDFN x x *RCT x *SBSD x x *SCHIDX *SOCKET x *SPADCT x *SQLPKG *SQLUDT x *SRVPGM *SSND x *STMF *SVRSTG *SYMLNK x *S36 *TBL x x *USRIDX x *USRPRF *USRQ x x *USRSPC *VLDL x x *WSCST x x x
x x x
Values allowed *ALL: All the object types that are allowed in the command, specified by name, and are in the specified library are operated on by the command in which they are specified. *ALL refers only to the object types that apply to that command; refer to the individual command descriptions of the OBJTYPE parameter to see which of the OS/400 object types can be specified.
148

object-type: Specify the predefined values for the types of objects that are to be operated on by the command.
OUTPUT parameter
| | | | | | You use the OUTPUT parameter to specify whether the output from the display command will be shown on the display, printed, or written to an output file. Basically, the same information is provided in either form; only the format is changed as necessary to present the information in the best format for the device. For example, because there are more lines on a printed page than on a display, column headings are not repeated as often in printed output. If the output is to be shown on the display, it will be sent to the work station that issued the display command. It will be shown in the format specified in the display device file used by that display command. A different device file is used for the output of each display command, and the file is different for displayed, printed, or written file output. In most cases, the name of the command is part of the file names of either type of device file. If the output will be printed, it is spooled and an entry is placed on the jobs output queue. The output can be printed depending on which device is specified in the Start Printer Writer (STRPRTWTR) command. Note: Although the IBM-supplied printer files are shipped with SPOOL(*YES) specified, they can be changed to SPOOL(*NO) by the Override with Printer File (OVRPRTF) and Change Printer File (CHGPRTF) commands. If the OUTPUT parameter is not specified in the display command, the default value * is assumed. The output resulting from this value depends on the type of job that entered the command. The following table shows how the output is produced for interactive and batch jobs.
Output * *PRINT Interactive Job Displayed Printed Batch Job Printed Printed
Values allowed *: Output requested by an interactive job is shown on the display. Output requested by a batch job is printed with the jobs spooled output. *PRINT: The output is printed with the jobs spooled output. *OUTFILE: The only output is to be written to a specified database file.
PRTTXT parameter
The print text (PRTTXT) parameter specifies the text that appears at the bottom of listings and on separator pages. Print text is copied from the job attribute when the job enters the system. Print files that originate on another system do not use the print text on the target system. Print text exists as a job attribute (PRTTXT) for defining the print text of a specific job, and as a system value (QPRTTXT) for the default of jobs with *SYSVAL specified. QPRTTXT is the system-wide default for all jobs.
149

The print text can be up to 30 characters in length. The text should be centered in the forms width and printed in the overflow area. You should center the desired text within the 30 character field. If the print text is not blank, the system prints 30 characters of text on the bottom of each page. This text normally follows the overflow line and is preceded by a blank line (if the forms length permits). If the user prints past the overflow line, the print text follows the last line of the user text, again preceded by a blank line when possible. If the overflow line is the last line of the form, the print text also prints on the last line of the form, which may result in the typing over of user text. The print text for job and file separators is put on the first line of the separator page. A job separator contains print text of the job that created the separator at the time the file was printed. A file separator contains the same print text as the spooled file it precedes. The print text can be specified for all job types. System and subsystem monitor jobs use the system value. Reader and writer jobs use the system value unless print text is changed in the QSPLxxxx job description associated with the reader or writer. The print text is determined from several places by using the following hierarchical order. If print text is not specified in one place, the next place in the order is used. The hierarchical order, beginning with the highest priority, is as follows: v Override print file value v v v v Print file value Job attribute changed by the Change Job (CHGJOB) command Job attribute set by the Submit Job (SBMJOB) or Batch Job (BCHJOB) command Job description
v System value Values allowed For the system value QPRTTXT, any character string can be specified, with the exception of *SYSVAL. If *BLANK is specified, there will be no print text. For PRTTXT, some of the following values can be selected, depending on the command: *SAME: The print text does not change. *CURRENT: The print text is taken from the submitting job. *JOBD: The print text is taken from the job description under which the job is run. *SYSVAL: The print text is taken from the system value QPRTTXT. *BLANK: There is no text or blanks printed. print-text: Specify 30 characters of text. If there are blanks in the text, then apostrophes must be used around the entry. The text should be centered within the field for the text to be centered on the page.
150
REPLACE parameter
The replace (REPLACE) parameter is used on create commands. It specifies that the existing object, if one exists, is replaced by the object of the same name, library, and object type that is being created. The user of the new object is granted the same authority as for the object being replaced. If the object being replaced is secured by an authorization list, then the new object is secured by the same authorization list. The public authority of the new object is the same as the public authority of the replaced object. The AUT parameter from the create command is ignored. All private authorities from the replaced object are copied to the new object. The owner of the new object is not copied from the replaced object. The owner of the new object is the creator of the new object or the creators group profile. Some objects such as panel groups, display files, and menus cannot be replaced if they are in use by the current job or another job. If the object being created is a program or service program, then the user profile (USRPRF parameter) value from the replaced program is used. The user profile (USRPRF parameter) value from the Create Program or Create Service Program command is ignored. If the value of the user profile (USRPRF parameter) of the program or service program being replaced is *OWNER, then only the current owner of the program or service program being replaced can create the new program or service program that replaces the existing program or service program. If the owner of the existing object and the object being created do not match, the object is not created and message CPF2146 is sent. If the object being created is a program or service program, then the use adopted authority (USEADPAUT) value from the replaced program or service program is used as long as the user creating the object can create programs/service programs with the USEADPAUT(*YES) attribute. The QUSEADPAUT system value determines whether or not users can create programs or service programs to use adopted authority. For example, if the existing object being replaced has USEADPAUT(*YES) and you do not have authority to create a program or service program that uses adopted authority, the program or service program created will have USEADPAUT(*NO). In this case, the USEADPAUT value was not copied. If you have authority to create programs or service programs that use adopted authority, the created program or service program will have the same USEADPAUT value as the program or service program being replaced. An informational message is sent which indicates whether the USEADPAUT value was copied to the object being replaced. If the object being created is a file, and the default, or *YES, is specified on the REPLACE parameter, an existing device file other than save file and a DDM file with the same qualified name will be replaced by the new file. For example, an existing display file can be replaced by a new printer file, or tape file, etc. Object management (*OBJMGT), object existence (*OBJEXIST), and read (*READ) authorities are required for the existing object to allow replacement of the existing object with a new object. The existing object is renamed and moved to library QRPLOBJ when the creation of the new object is successful. The replaced object is renamed with a Q appended to a time stamp and moved to library QRPLOBJ. The text of the replaced object is changed to the original name of the object that was replaced, for example, LIBRARY/OBJNAME.
151

Restriction: Programs can be replaced while they are being run; however, if the replaced program refers to the program message queue after the renaming of the replaced program to the Qtimestamp name, the program fails and an error message is sent stating that the program message queue is not found. A database file, physical or logical, and a save file cannot be replaced by any file. Library QRPLOBJ is cleared when an initial program load (IPL) of the system is done. Values allowed *YES: The system replaces the existing object with the new object being created that has the same name, library, and object type. *NO: The system does not replace the existing object that has the same name, library, and object type with the object being created.
Scheduling priority parameters (JOBPTY, OUTPTY, PTYLMT)

The scheduling priority parameters specify the priority values used by the system to determine the order in which the jobs and spooled files are selected for processing. Each job is given a scheduling priority that is used for both job selection and spooled file output. The job scheduling priority is specified by the JOBPTY parameter in commands like the Batch Job (BCHJOB), Submit Job (SBMJOB), Create Job Description (CRTJOBD), and Change Job Description (CHGJOBD) commands. The priority for producing the spooled output from a job is specified by the OUTPTY parameter in the same commands. In addition, because every job is processed under a specific user profile, the priority for jobs can be limited by the PTYLMT parameter specified on the Create User Profile (CRTUSRPRF) and Change User Profile (CHGUSRPRF) commands. This parameter value controls the maximum job scheduling priority and output priority that any job running under a user profile can have; that is, the priority specified in the JOBPTY and OUTPTY parameters of any job command cannot exceed the priority specified in the PTYLMT parameter for that user profile. The scheduling priority is used to determine the order in which jobs are selected for processing and is not related to the process priority specified in the class object. The three scheduling priority parameters specify the following: v The PTYLMT parameter specifies the highest scheduling priority for any job that you submit. In the commands that affect the user profile, the PTYLMT parameter specifies the highest priority that can be specified in another JOBPTY parameter on commands relating to each specific job. You can specify a lower priority for a job on the command used to submit the job. If you specify a higher priority for JOBPTY in the BCHJOB or SBMJOB command than is specified for PTYLMT in the associated user profile, an error message is shown on the display and the maximum priority specified in PTYLMT is assumed. If a higher job priority is specified in the CHGJOB or CHGJOBD command, an error message is shown and the attributes are not changed. v The JOBPTY parameter specifies the priority value to be used for a specific job being submitted. In the commands relating to a specific job being submitted, the JOBPTY parameter specifies the actual scheduling priority for the job. v The OUTPTY parameter specifies the priority for producing the output from all spooled output files from the job. The priority value specified in the OUTPTY
| | | | | | | | | |
152

parameter determines the order in which spooled files are handled for output. The same value is applied to all the spooled files produced by the job. The scheduling priority can have a value ranging from 0 through 9, where 1 is the highest priority and 9 is the lowest priority. Any job with a priority of 0 is scheduled for processing before all other jobs that are waiting and that have priorities of 1 through 9. The priority parameters can be specified on the following commands.
JOBPTY BCHJOB CHGJOB CRTJOBD SBMJOB OUTPTY BCHJOB CHGDKTF CHGJOB CHGJOBD CHGPJ CHGPRTF CHGSPLFA CRTDKTF CRTJOBD CRTPRTF OVRDKTF OVRPRTF SBMJOB PTYLMT CHGUSRPR CRTUSRPR RTVUSRPR
Values allowed Depending upon the command, one or more of the following values apply to the parameter. 5: If a value is not specified in the CRTUSRPRF command, five is the default value that is assumed for the priority limit for the user profile. That would be the highest priority that the user could specify for any job he submits for processing. If not specified in the CRTJOBD command, five is the default value for both the job scheduling priority and the output priority. *SAME: The priority assigned, or the highest priority that can be assigned, does not change. *JOBD: The scheduling priority for the job is obtained from the job description under which the job runs. scheduling-priority Specify a priority value ranging from 0 through 9, where 0 is the highest priority and 9 is the lowest priority. Priority 0 is allowed only on CHGJOB.
SEV parameter
The severity (SEV) parameter specifies the severity code that: v Describes the level of severity associated with an error message. v Indicates the minimum severity level that causes a message to be returned to a user or program. v Causes a batch job to end. v Causes processing of a command to end if a syntax error of sufficient severity occurs. Note: The LOG parameter on some commands also uses these severity codes for logging purposes (to control which job activity messages and error messages are logged in the job log).
153

The severity code is a 2-digit number that can range from 00 through 99. The higher the value, the more severe or important the condition. The severity code of a message that is sent to a user indicates the severity of the condition described by the message. More than one message can have the same severity code. If a severity code is not specified for a predefined message, it is assumed to be 00 (information only). Your can specify a severity code for any message when it is defined by the Add Message Description (ADDMSGD) command. To change the severity code of a message, use the Change Message Description (CHGMSGD) command. IBM-defined severity codes are used in all of the IBM-supplied messages that are shipped with the system. 00 Information: A message of this severity is for information purposes only; no error was detected and no reply is needed. The message could indicate that a function is in progress or that it has reached a successful completion. 10 Warning: A message of this severity indicates a potential error condition. The program may have taken a default, such as supplying missing input. The results of the operation are assumed to be what was intended. 20 Error: An error has been detected, but it is one for which automatic recovery procedures probably were applied, and processing has continued. A default may have been taken to replace input that was in error. The results of the operation may not be valid. The function may be only partially complete; for example, some items in a list may be processed correctly while others may fail. 30 Severe Error: The error detected is too severe for automatic recovery, and no defaults are possible. If the error was in source data, the entire input record was skipped. If the error occurred during program processing, it leads to an abnormal end of the program (severity 40). The results of the operation are not valid. 40 Abnormal End of Program or Function: The operation has ended, possibly because it was unable to handle invalid data, or possibly because the user ended it. 50 Abnormal End of Job: The job was ended or was not started. A routing step may have ended abnormally or failed to start, a job-level function may not have been performed as required, or the job may have been ended. 60 System Status: A message of this severity is issued only to the system operator. It gives either the status of or a warning about a device, a subsystem, or the whole system. 70 Device Integrity: A message of this severity is issued only to the system operator. It indicates that a device is malfunctioning or in some way is no longer operational. You may be able to restore system operation, or the assistance of a service representative may be required. 80 System Alert: A message of this severity is issued only to the system operator. It warns of a condition that, although not severe enough to stop the system now, could become more severe unless preventive measures are taken. 90 System Integrity: A message of this severity is issued only to the system operator. It describes a condition that renders either a subsystem or the whole system inoperative.
154

99 Action: A message of this severity indicates that some manual action is required, such as specifying a reply, changing printer forms, or replacing diskettes.
SPLNBR parameter
The spooled file number (SPLNBR) parameter is used when more than one spooled file is created by a job and the files all have the same name. The files are numbered, starting with 1, in the order that they are opened by the job. The job log is always the last file for a job. A file number is generated for each file when it is opened within a job (when output records are produced) and it is used by the system as long as the job and/or the files are on the system. If the files are not uniquely named because they were opened more than once, this file number is used to specify which file (or group of records, if the complete file has not yet been produced) is acted upon by a CL command.
TEXT parameter
The TEXT parameter specifies the user-defined description that briefly describes the object being created or changed. The description can include up to 50 characters; if it is a quoted string (that is, enclosed in apostrophes), any of the 256 EBCDIC characters can be used. The apostrophes are not required if the string does not contain any blanks or other special characters. Any of the 50 character positions not filled by the specified description are padded with blanks. The description is used to describe any of the OS/400 objects when the named object is shown on the display by the Display Object Description (DSPOBJD) command. Only objects for which object operational authority has been obtained can be displayed by a user. See the OBJTYPE parameter on page 145 description for a list of the OS/400 object types. For commands that use a database source file to create some type of object, you can (by default) use the text from the source file member as the text for the newly-created object. For example, if you use the Create Control Language Program (CRTCLPGM) command to create a CL program, but you do not specify a description in the TEXT parameter, the text specified for the source file member (SRCMBR parameter) of the source file (SRCFILE parameter) is assumed as the descriptive text for the CL program. Values allowed Depending upon the command, one or more of the following values apply to the TEXT parameter. *SRCMBRTXT: For commands that create objects based on database source files only, the text is taken from the source member. If a device or an inline file is used for source input or if source is not used, the text is left blank. *BLANK: The user description of the object being created or changed is left blank. *SAME: The user-defined description does not change. description: Specify the description of the object being created or changed. Up to 50 characters enclosed in apostrophes (required for blanks and other special
155

characters) can be specified to describe the object. If an apostrophe is one of the 50 characters, two apostrophes () must be used instead of one to represent the apostrophe character.
VOL parameter
The volume (VOL) parameter specifies the volume identifiers of the volumes used in a diskette, tape, or optical operation. A diskette volume consists of a single diskette. A tape volume consists of a reel of tape. An optical volume consists of a single side of an optical cartridge or a single CD-ROM. Optical cartridges are dual sided and each side is a separate volume. The volume identifier is the identifier stored on each diskette, tape, or optical disk (in the volume label area) that it identifies. The diskettes (volumes) must be on the diskette drive in the same order as the identifiers are specified in the VOL parameter. An inquiry message is sent to the system operator if a volume identifier is missing or out of order. Tape volumes must be on the tape units in the same order as their identifiers are specified in the VOL parameter and as the device names are specified in the DEV parameter of the tape device file commands. However, if the tapes are read backward (a function supported in COBOL), the volumes must be in reverse order to that specified in the VOL parameter. Nevertheless, the device names are still specified in forward order in the DEV parameter. In general, the rule for specifying diskette and tape volume identifiers is that as many as 6 characters, containing any combination of letters and digits, can be used. Special characters can be used if the identifier is enclosed in apostrophes. However, if the diskette or tape is used on a system other than an AS/400 system, the requirements for specifying identifiers on that system must be considered. Optical volume identifiers can be up to 32 characters long and can contain any combination of digits and upper case letters. Each optical volume identifier must be unique. No two optical volumes with the same identifier can be present on the system at the same time. A complete list of the rules for optical volume identifiers can be found in the AS/400 Advanced Series Optical Support book. For diskettes in the data exchange format and for labeled tapes, the following rules apply: v Characters: A maximum of 6 characters, or fewer, can be specified for each volume identifier. Alphabetic and numeric characters can be used in any order. v Uniqueness: More than one volume can have the same identifier. You may have a file using the same identifier for several volumes; in this case, the system keeps track of the order internally with a sequence number written on the volumes. However, volume identifiers should be unique whenever possible. v Order: When multiple volumes (with different identifiers) are used in a single operation, they must be in the same order as the volume identifiers specified in the VOL parameter. Multivolume files For a multivolume file on diskettes (that is, a data file on several diskettes, all having the same name), a message is sent to the system operator for each diskette volume after the first, until all volumes have been processed. If (for S/R only) more than 100 diskettes are used for the same file, duplicate diskette sequence numbers occur for each additional diskette used after the first hundred (01 through
156

99, and 00). For each 100 diskettes written for the file, a message is sent to the system operator indicating the total number written. When the diskettes are read, the operator must determine the order in which the diskette volumes are inserted. If multiple volumes (tapes or diskettes) are used in an operation and all have the same volume identifier, that identifier must be specified in the VOL parameter once for each volume used. For example, if three tapes named QGPL are used in a save operation, VOL(QGPL QGPL QGPL) must be specified. When a multivolume file on tape is processed and multiple tape units are used, the tape volumes must be placed in the tape devices in the same order as they are specified in the VOL parameter. For example, if five volumes and three tape units are used, they are mounted as follows: VOL1 on unit 1, VOL2 on unit 2, VOL3 on unit 3, VOL4 on unit 1, and VOL5 on unit 2. Values allowed *MOUNTED: The volume currently placed in the device is used. *NONE: No volume identifier is specified. *SAME: Previously specified volume identification does not change. *SAVVOL: The system, using the save/restore history information, determines which tape or diskette volumes contain the most recently saved version. If the device specified in the DEV parameter of the restore command does not match the device of the most recently saved version of the object, an error message is returned to the user, and the function is ended. If the wrong volume is mounted in the unit specified by the command, a message is returned to the system operator that identifies the first volume that must be placed in the device before the restore operation can begin. volume-identifier: Specify the identifiers of one or more volumes in the order in which they are put on the device and used. Each tape or diskette volume identifier contains a maximum of 6 alphanumeric characters. Each optical volume identifier contains a maximum of 32 characters. A blank is used as a separator character when listing multiple identifiers.
WAITFILE parameter
You use the WAITFILE parameter to specify the following: v For the maximum number of seconds that a program waits for file resources to be allocated when the file is opened v For session resources when the evoke function is issued for an APPC device v For the device to be allocated when an acquire operation is performed to read the file If the program must wait, it will be placed in a wait state until the resources are available or until the wait time expires. If two or more file resources are needed and are not available because they are being used by different system users, the acquisition of each resource might require a wait. This maximum is applied to each wait.
157

The length of the wait can be specified in this parameter, or the default wait time of the class that applies to the object can be used. If the file resources cannot be allocated in the specified number of seconds, an error message is returned to the program. The file resources that must be allocated depend on the type of file being opened. File resources consist of the following. v For device files that are not spooled (SPOOL(*NO)), the file resources include the file description and device description. Because the device description must be allocated, the device itself must also be available. v For device files that are spooled (SPOOL(*YES)), the file resources include the file description, the specified output queue, and storage in the system for the spooled data. Because the data is spooled, the device description (and thus the device itself) need not be available. v For database files, the file resources consist of the file and member data. The files associated member paths are not accessed, and therefore, the system does not wait for them. A file open exception error can occur before the WAITFILE time has expired when an access path is not available (for example, when the access path is being rebuilt). The Allocate Object (ALCOBJ) command can be used to allocate specific file resources before the file is opened. The session resources that were allocated for an APPC device conversation can be lost between the time the application issues a detach function or receives a detach indication and the time another evoke function is issued. If the session resource is lost, this parameter is used to determine the length of time that the system waits for another session resource. Values allowed *IMMED: The program does not wait; when the file is opened, an immediate allocation of the file resources is required. *CLS: The default wait time specified in the class description is used as the wait time for the file resources to be allocated. number-of-seconds: Specify the maximum number of seconds that the program waits for the file resources to be allocated. Valid values range from 1 through 32767 seconds.
158
Chapter 8. Command syntax

Commands have the following general syntax. The brackets indicate that the item within them is optional; however, the parameter set may or may not be optional, depending upon the requirements of the command.
[//] [?] [label-name:][library-name/]command-name [parameter-set]
Note: The // is valid only for a few batch job control commands, such as the DATA command. The // identifies those types of commands sent to the spooling reader that reads the batch job input stream. The remaining parts of the command are described in the sections that follow. v Delimiters v Command continuation on page 161 v Entering comments on page 162 v Summary of general coding rules on page 162
Delimiters
Command delimiters are special characters or spaces that identify the beginning or end of a group of characters in a command. Delimiters are used to separate a character string into the individual parts that form a command: command label, command name, parameter keywords, and parameter values. Parameter values can be constants, variable names, lists, or expressions. The following diagram shows various delimiters for a command:
The following delimiters are used in the OS/400 control language: v The colon (:) ends the command label, and it can be used to separate the command label from the command name. v Blank spaces separate the command name from its parameters and separate parameters from each other. They also separate values in a list. Multiple blanks are treated as a single blank except in a quoted character string or comment enclosed in apostrophes. A blank cannot separate a keyword and the left parenthesis for the value. v Parentheses ( ) are used to separate parameter values from their keywords, to group lists of values, and to group lists within lists. v Slashes (/) connect the parts of a qualified name or the parts of a path name. For a qualified object name, the two parts are the library qualifier and the object name (LIBX/OBJA). Qualified object names are described in Simple and qualified object names on page 111.
159
v v
For a path name, the parts are the directory or directories searched and the object name (/Dir1/Dir2/Dir3/ObjA). Either a period or a comma can be used as a decimal point in a decimal value (3.14 or 3,14). Only one decimal point is allowed in a value. Apostrophes specify the beginning and ending of a quoted character string, which is a combination of any of the 256 extended binary-coded decimal interchange code (EBCDIC) characters that can be used as a constant. For example, YOU CAN USE $99@123.45 ()*></ and lowercase letters is a valid quoted string that is a constant. Because an apostrophe inside a quoted string is paired with the opening apostrophe (delimiter) and is interpreted as the ending delimiter, an apostrophe inside a quoted string must be specified as two apostrophes. A pair of adjacent apostrophes used this way is counted as a single character. A special character is used to separate a date into three parts: month, day, and year (two parts for Julian dates: year and day). The special characters that may be used as date separators are the slash (/), the hyphen (-), the period (.), and the comma (,). The special character used to code as separators in a command date must be the same as the special character specified as the date separator for the job. The OS/400 Work Management book contains more information on specifying job and system values. The characters /* and */ can indicate the beginning and ending of a comment, or can be used in a character string. To begin a comment, the characters /* must begin in the first position of the command, be preceded by a blank, or be followed by either a blank or an asterisk. If the characters /* or */ occur in a later position of a command, they will usually be enclosed in apostrophes and can represent, for example, all objects in the current directory for a path name. For more information on path names, see the Integrated File Systems topic. A question mark (?) preceding the command name indicates that the command is prompted. If the command is specified with a label, the question mark may either precede the label, or it may follow the label and precede the command name. Within a CL program, when a question mark precedes a command name, a prompt display is presented. You can enter parameter values not specified on the command in the program. Prompting characters may be put into a command in two forms. A single question mark (?) may be coded before the command name (either before or after the command label in a CL program) to cause the entire command to be prompted. Selective prompt characters (?? or ?*) may be coded before any parameter keyword to cause that parameter to be prompted when the command is run. If a question mark is entered before the command name on the command entry display, the effect is the same as pressing the F4 (Prompt) key after the command is entered. Within a CL program, when a question mark precedes the command name, a prompt display is presented. This display is of the same format as that presented when pressing the F4 key from the command entry display. Parameters of the command for which the program has coded values are shown for informational purposes, but the user cannot change the values supplied by the program. Parameters for which no value was coded are shown as input fields so you can enter values to be used in processing the command. Selective prompting allows you to identify specific command parameters to be prompted. To call selective prompting, the characters ??, ?*, or ?- are coded immediately preceding the keyword name of the parameter(s) to be prompted. More information on prompting is available in the CL Programming book.
160
Note: Selective prompting is not allowed with command string (*CMDSTR) parameters. Note: Parameters of the command that are preceded by the characters ?* are shown, but you cannot change the values that are supplied by the program. Parameters preceded by the characters ?? are shown as input fields containing the values coded in the program or command defaults so you can enter or change the values used in processing the command. Parameters preceded by the characters ?- are omitted from the display. All selectively prompted parameters must be coded in keyword or keyword-with-value form. Several parameters may be selectively prompted within one command. When selective prompting is called, only keywords that are immediately preceded by the selective prompt characters are prompted. All other parameters are processed using the values as coded on the command or, if not coded, using command defaults. Either form of prompting, but not both, is allowed on a single command in a CL program. If the character ? precedes the command name and selective prompt characters (except ?-) precede any keyword, an error message is returned and the program is not created. v Command continuation v Entering comments on page 162 v Summary of general coding rules on page 162
Command continuation
Commands can be entered in free format. This means that a command does not have to begin in a specific location on a coding sheet or on the display. A command can be contained entirely in one record, or it can be continued on several lines or in several records. Whether continued or not, the total command length cannot exceed 20,000 characters. Either of two special characters, the plus sign (+) or the minus sign (), is entered as the last nonblank character on the line to indicate that a command is continued. Blanks immediately preceding a + or sign are always included; blanks immediately following a + or in the same record are ignored. Blanks in the next record that precede the first nonblank character in the record are ignored when + is specified but are included when is specified. The + is generally useful between parameters or values. At least one blank must precede the sign when it is used between separate parameters or values. The difference between the plus and minus sign usage is particularly important when continuation occurs inside a quoted character string. The following example shows the difference:
CRTLIB LIB(XYZ) TEXT('This is CONT+ INUED') CRTLIB LIB(XYZ) TEXT('This is CONTINUED') For + : CRTLIB LIB(XYZ) TEXT('This is CONTINUED') For - : CRTLIB LIB(XYZ) TEXT('This is CONT INUED')
Notes: 1. The minus sign causes the leading blanks on the next line to be entered.
161
2. Use continuation characters + and - in CL programs only. An error occurs if + or - is used on a command entry display. 3. The characters + and - are used for multiple-command examples, but not for single-command examples. v Delimiters on page 159 v Entering comments v Summary of general coding rules
Entering comments
Comments can be inserted either inside or outside a commands character string wherever a blank is permitted. However, because a continuation character must be the last nonblank character of a line (or record), comments may not follow a continuation character on the same line. For readability, it is recommended that each comment be specified on a separate line preceding or following the command it describes, as shown here:
MOVOBJ OBJA TOLIB(LIBY) /* Object OBJA is moved to library LIBY. */ DLTLIB LIBX /* Library LIBX is deleted. */
Comments can include any of the 256 EBCDIC characters. However, the character combination */ should not appear within a comment because these characters end the comment. To begin a comment, the characters /* must be placed in the first position of the command, be preceded by a blank, or be followed by either a blank or an asterisk. v Delimiters on page 159 v Command continuation on page 161 v Summary of general coding rules
Summary of general coding rules

This section contains a summary of general information needed to properly code CL commands. Delimiters v Blanks are the basic separators between the parts of a command: Between command label and command name (not required, because the colon [:] is the delimiter). Between command name and first parameter, and between parameters. Between values in a list of values (not required between ending and beginning parentheses that enclose nested lists inside a list). Between the slashes and the name or label of some job control commands, like // DATA (not required). v Blanks cannot separate a parameters keyword from the left parenthesis preceding its values. When a keyword is used, parentheses must be used to enclose the values; blanks can occur between the parentheses and the values. For example, KWD( A ) is valid. v Multiple blanks are treated as a single blank, unless they occur in a quoted string or a comment.
162
v A colon must immediately follow a command label. Only one label can be used on any command (LABEL1: DCLF). v Apostrophes must be used to specify the beginning and end of a quoted character string. If a character string contains special characters, such as blanks, apostrophes are required. If an apostrophe must be used in the quoted string, two apostrophes must be entered consecutively to indicate that it is an apostrophe and not the end of the quoted string. v Parentheses must be used: On parameters that are specified (coded) in keyword form To group multiple values in a single list, in a positional parameter, or around expressions To indicate a list (of none, one, or several elements) nested inside another list v Sets of parentheses inside parentheses can be entered as long as they are paired, up to the maximum of five nested levels in logical expressions or three nested levels in lists of values. v Comments can appear wherever blanks are permitted, except after a continuation character on the same line or record. v A plus or minus sign at the end of a line indicates that the command is continued on the following line. Blanks following a + or sign in the same record are ignored; blanks in the next record that precede the first nonblank character are ignored when + is specified and included when is specified. One blank must precede the + sign when it is used between separate parameters or values. Parameters v All required parameters must be coded. v If an optional parameter is not coded, the system uses its default value if the parameter has one. In the syntax diagram of each command, default values are indicated by an arrow that points to them. If no default value is indicated, the default varies (depending on other parameter values) and is described in the text, or the action taken does not require that parameter. v Words or abbreviations specified in capital letters in the command and parameter descriptions must be coded as shown. This is true of all command names, the keywords of parameters (if used), and many parameter values. Lowercase letters not coded in quoted strings or in comments are translated to uppercase letters. Lowercase letters specified for values on parameters defined as CASE(*MIXED) are not translated to uppercase letters. v If there are key parameters, the values for the key parameters must be entered on the prompt before the remaining parameters will be shown. Parameters preceding the letter K on the syntax diagram are key parameters. v Parameters cannot be coded in positional form past the letter P found in the syntax diagrams (if applicable). The order of positional coding is the order in which the parameters are presented in the syntax diagram and in the command description. Values: v The first character in all names must be an alphabetic character (A through Z, $, #, @, or a double quotation mark ()). Names must not exceed 10 characters (CL variable names and built-in function names can have 11 characters maximum, including the preceding & or % characters). In some commands, the names of objects can be specified in qualified form (library-name/object-name) or in path name form (directory-name/object name).
163
v Predefined values that begin with an asterisk can be used only for the purposes intended, unless they are included in comments or quoted strings. These include predefined parameter values (*ALL, for example), symbolic operators (*EQ, for example), and the null value (*N). v In a CL program, a variable can be specified for all parameters, except where that is explicitly restricted. The user-specified value of the variable is passed as if it had been specified on the command. v In a CL program, a character string expression can be specified for any parameter defined with EXPR(*YES). The resulting value of the expression is passed as if the value had been specified on the command. v Null (omitted) values are specified with the characters *N, which mean that no value was specified and the default value, if one exists, should be used. *N is needed only when another value following the omitted value is being specified as a positional parameter or an element in a list. v Either a comma or a period can be used to indicate a decimal point in a numeric value. The decimal point is the only special character allowed between digits in the numeric string; there is no delimiter for indicating thousands. v When repetition is indicated for a parameter: A predefined value is not coded more than once in a series of values. As many user-defined values (like names or numeric limits) can be entered as there are different values or names, up to the maximum number of repetitions allowed. For example, if a syntax footnote states A maximum of 20 repetitions, you can specify a maximum of 20 values. Note: When you are using parameters that have the same name in different commands, the meaning of (and the values for) that parameter in each command may be somewhat different. Refer to the correct command description for the explanation of the parameter you are using. For some parameters, you can also refer to Commonly used parameters: Expanded descriptions on page 128 for both general information about a parameter and an expanded description of its values coded in commands. v Delimiters on page 159 v Command continuation on page 161 v Entering comments on page 162
164

Syntax diagrams for each command show how you enter the command and its parameters and values in programs, in batch, or interactively on the command line. How to read syntax diagrams briefly describes the basic rules you need to read syntax diagrams. How syntax diagrams show command structure on page 166 describes in more detail how syntax diagrams reflect CL command structure. The Syntax diagram rules on page 166 topic provides both the rules, along with a graphic depiction, for syntax diagrams. To view the syntax diagram for a specific command, see the alphabetical command list in the Chapter 4. OS/400 commands on page 13 topic in the navigation bar.
How to read syntax diagrams

| | | | | | | | | | | | | Syntax diagrams show the parameters and values used by each CL command. Each syntax diagram specifies, for one command, the parameters that can be coded in the command and the choice of values that are valid for each parameter. Refer to How syntax diagrams show command structure on page 166 for a more detailed description of syntax diagrams and how they reflect command structure. The following list describes the individual pieces of a syntax diagram and how to read them: v Start here and end here . This line with the starting and ending arrows is considered the syntax base line. v When a parameter keyword is entered, its predefined value (values beginning with * or Q), or user-defined value must be entered with parentheses as shown below:
KEYWORD( *VALUE1 *VALUE2 user-defined-value )
| | | | | | | | v Required parameters must be specified. They are presented with the parameter keyword on the base line. Optional parameters do not have to be entered. They are represented with the parameter keyword below the base line. In this sample, you must enter KEYWORD1 with a value, but you do not have to enter KEYWORD2.
KEYWORD1( *VALUE1 *VALUE2 ) KEYWORD2( *VALUE1 any-value )
| | | | v Default values do not have to be entered. They are used when you do not specify a parameter. In this sample, you can enter *VALUE1, *VALUE2, or nothing. If you enter nothing, *VALUE1 is assumed.
165
|
KEYWORD( *VALUE1 *VALUE2 )
| | | | | | |
KEYWORD( ( *VAL1 *VAL2 *VAL3 ) value (1) )
v Repeated values can be specified for some parameters. In this sample, the arrow moving from the right of the values, over the top of the values, and down the left of the values to the arrowhead, indicates that the values inside the path of the arrow can be repeated. The accompanying footnote indicates the maximum number of times that values can be specified (10 times).
| | | | | | | | | Fragment:
*VALUE1 *VALUE2 VALUE3 VALUE4 other-values
Notes: 1 A maximum of 10 repetitions can be specified. v Fragments allow you to label entire blocks of parameters or values and describe them in another section of the syntax diagram.
KEYWORD( Fragment )
| | v How syntax diagrams show command structure
How syntax diagrams show command structure

In addition to showing simple command structures such as parameter keywords and values, syntax diagrams also show more complicated command structures such as mutually exclusive parameters. The Syntax diagram rules section describes in more detail how the syntax diagrams show these command structures, and it shows the parameter syntax of a fictitious command named Sample Syntax Diagram (SMPSYNDGM). v How to read syntax diagrams on page 165 v List of syntax diagram rules
Syntax diagram rules

This sample syntax diagram shows several parameter structures and how those structures are represented on the syntax diagram. In addition, the sample syntax diagram contains additional information about the command, its parameters, and its values (such as where the command can be used, or whether it is threadsafe, see 1 ). The rules on how to interpret this diagram follow this syntax diagram
166
The syntax diagrams for the CL commands are interpreted according to the following rules. 1 Entry Codes (Batch and Interactive)
The box insert in the upper right corner of each syntax diagram contains the entry codes that specify the environment in which the command can be entered. The codes indicate whether the command can be: v Used in a job (outside a compiled program; Job:B and/or I). When used in this manner, the command is considered a separate entity inside the job, and is run by itself as a separate function in what is called the interpretive mode. That is, commands in batch mode and/or interactive jobs that are not in compiled programs are interpreted and run one at a time, one after the other. The function of one interpreted command in the job is completed before the next command is interpreted. v Used in a compiled program (Pgm:B and/or I). In this case, the command is part of the program; the command is in compiled form with the rest of the program, and running the command depends upon when the program is called and upon the programs logic preceding the command. That is, a compiled command cannot be run unless the program it is in is run. v Used in a CL ILE module only (Mod:B and/or I). v Used in a REXX procedure (REXX:B and/or I). In this case, the command is part of the REXX procedure. Running the command depends upon when the REXX procedure is started with the Start REXX Procedure (STRREXPRC) command. That is, the command cannot be run unless the procedure containing it is started. The explanations of the combinations of entry codes are shown in the following table:
167
Table 9. Entry Codes (Batch and Interactive) Code Representing Job:B Job:I Job:B,I Batch job Interactive job Batch and interactive jobs
Meaning Valid in batch input stream, external to compiled CL programs. Valid for interactive entry, external to compiled CL programs. Valid for batch and interactive entry, external to compiled CL programs. Valid in a compiled CL program that is called from batch entry. Valid in a compiled CL program that is called from interactive entry. Valid in a compiled CL program that is called from batch or interactive entry. Valid in a batch CL ILE module only. Valid in an interactive CL ILE module only. Valid in a CL ILE module that is called from batch or interactive entry. Valid in a REXX procedure that is called from batch entry. Valid in a REXX procedure that is called from interactive entry. Valid in a REXX procedure that is called from batch or interactive entry. Valid as a parameter on the CALL command; can be passed as a character string to the system programs QCAPCMD and QCMDEXC.
Pgm:B Pgm:I Pgm:B,I
Program, batch Program, interactive Program, batch and interactive
Mod:B Mod:I Mod:B,I
Module, batch Module, interactive Module, batch and interactive
REXX:B REXX:I REXX:B,I
REXX, batch REXX, interactive REXX, batch and interactive
Exec
QCAPCMD and QCMDEXC processing
Threadsafe (Yes, Conditional, No) The box insert in the upper right corner of each syntax also indicates whether a command is threadsafe. Each command in this book has a threadsafe classification. The three types of threadsafe classifications are as follows: v Threadsafe: Yes This classification indicates that you can safely call the command simultaneously in multiple threads without restrictions. This classification also indicates that all functions called by this command are threadsafe. v Threadsafe: Conditional This classification indicates that not all functions provided by the command are threadsafe. The Restrictions section of the command provides information relating to thread safety limitations. Many commands are classified conditionally threadsafe because either some underlying system support is not threadsafe or the command can cause an exit point to be called. Some conditionally threadsafe commands may deny access under some circumstances. The command restriction section describes the conditions that cause the command to deny access. v Threadsafe: No
168
This classification indicates that the command is not threadsafe and should not be used in a multithreaded program. While some thread unsafe commands may deny access, most thread unsafe commands do not. A diagnostic message, CPD000D, may be sent to the job log to indicate that a non-threadsafe command has been called. Whether or not the diagnostic message CPD000D is sent to the job log depends on the multithreaded job action attribute of the command; that attribute can be determined by using the Display Command (DSPCMD) command. The possible values and actions are: *SYSVAL - Action is based on system value QMLTTHDACN *RUN - Command runs. No messages are sent. *MSG - Diagnostic message CPD000D is sent to the job log. The command runs. *NORUN - Diagnostic message CPD000D is sent to the job log, and escape message CPF0001 is sent. The command does not run. If the command is run, the results are unpredictable. 2 Command Name
The command name appears first in the diagram. In the sample syntax diagram, the name of the fictitious command is SMPSYNDGM. 3 Command Labels
The labels that may precede all coded commands are optional. Therefore, labels are not shown in the syntax diagrams. If used, a label must be followed by a colon (:) immediately after the last character in the label name. 4 Parameter Order
All parameters of the command are shown in the correct positional sequence up to the positional coding limit (see rule 12). The order goes left to right on each line and continues on the following line. To show the positional order of the parameters in the sample diagram, the representative parameter keyword names are named in alphabetic order, such as PARMA and PARMB. They are named in the same order in which they would have to be coded in positional form if this command actually existed. Note: In the few cases where dependent parameter relationships are shown (see rule 19 ), the positional parameter order may not be readily apparent. The parameter order may be specified in a note in the diagram, or it can be easily determined from the text where all parameters in the command are described in positional order. When coding parameters in positional form, you must enter them in the order shown in the diagram. If you choose not to code a parameter and another positional parameter is coded after it, then you must enter *N to represent the uncoded parameter in the positional sequence. Parentheses must be coded in each parameter that either has the keyword coded with its value (see rule 5 ) or has multiple values in one parameter (see rule 17 ). 5 Parameter Keywords
169
For each parameter, the keyword is always shown first, followed by the parameter values. Parameter keywords use uppercase letters; if you code them in lowercase, they will be changed to uppercase. When a parameter is coded in keyword form, its associated values must be enclosed in parentheses as shown below:
PARMA( length )
This parameter is coded as follows:

PARMA(15)
User-Defined Values
User-defined values are shown with lowercase characters that describe the kind of value coded by the user. If more than one word is used to describe a single value, the words are connected by hyphens:
PARMB( message-identifier )
Choice of Values
For a parameter having a choice of values, only one of which can be specified (typed after the parameter keyword and enclosed in parentheses), the choices of values are shown on different branch lines that follow the parameter keyword (which is on the base line), as follows:
PARMC( *CHAR *DEC *LGL )
Predefined Values
Predefined values are shown exactly as they must be coded. Predefined values usually begin with an * followed by all uppercase letters. *CHAR and *DEC are examples of predefined values. Predefined values can also begin with the letter Q. For example, an option for the SRCFILE parameter on the CRTCLPGM command is QCLSRC. 9 Optional Values
Optional values are shown by a blank line as shown below:

*LIBL/ PARMD( *CURLIB/ library-name/ program )
170
The blank line indicates that a value from the first group (which includes *LIBL, *CURLIB, and library-name) does not have to be entered as shown below:
PARMD(CLPGM)
If the blank line were missing, you would have to code the parameter as shown below:
PARMD(*LIBL/CLPGM) or PARMD(*CURLIB/CLPGM) or PARMD(MYLIB/CLPGM)
10
Default Values
If a parameter has a default value, it is indicated by its position above the base line. The value *LIBL (see 9 ), is a default library qualifier on the PARMD parameter, and 00 is the default value on the PARMF parameter as shown below:
00 severity-code
PARMF(
If 00 were not a default value, it would be shown as follows:

PARMF( 00 severity-code )
11
Qualified Object Names
Qualified object names include the optional library qualifier followed by the object name. If the qualifier is not specified, the default (*LIBL in this case) is used. Usually, *LIBL is the default value for a qualified object name; it means the system is to search the library list associated with the job to find the object. For PARMD, the syntax diagram shows that a name can be specified in qualified or unqualified form. See 9 for coded examples. 12 Positional Coding Limit and Key Parameter Limit
The point to which the commands parameters can be coded in positional form is indicated by a P on the base line. All parameters preceding the P can be coded without keywords (that is, in positional form); all parameters after the P must be coded with their keywords. If you attempt to code a parameter in positional form beyond this point, a syntax error will occur. When no parameters can be coded in positional form, a P either is not shown on the syntax diagram or it is shown directly following the command name. A command can also have key parameters, which are the only significant parameters needed by the system to determine the actual values for other parameters on the command. Key parameters are the only parameters shown on the display when a
171
user prompts for the command. After values are entered for the key parameters, the remaining parameters are shown with actual values instead of the default values (such as *SAME or *PRV). Key parameters include all parameters preceding the key parameter limit, which is designated on the syntax diagram by a K. If no K is shown, or if it is shown directly following the command name, there are no key parameters on the command. 13 Optional Parameters and Required Parameters
Optional parameters do not have to be coded. Optional parameters are shown below the base line as follows:
PARME( *BLANK 'message-text' )
If this parameter were required, it would appear on the base line as follows:
PARME( *BLANK 'message-text' )
In most cases, required parameters precede optional parameters on the syntax diagram. 14 Quoted Values
User-defined variables that must be enclosed in apostrophes are shown enclosed with apostrophes in the diagram. Apostrophes are shown where one or more special characters are normally expected to occur among alphanumeric characters. The value specified for PARME requires apostrophes if more than one word is entered or if special characters are used. Blanks, such as between words, are not allowed in an unquoted character string. PARMJ requires apostrophes if a character other than an alphanumeric character is specified.
PARME('This is a quoted string') PARME('10-24-78') PARME(102478)
The first and second values require apostrophes because they have either blanks (spaces) or special characters (-). The third value is a date with no separator characters; therefore, apostrophes are not required. 15 Ordered List of Values
Ordered lists of values (that is, values that must be specified in a particular order) will be shown as follows:
PARMG( lower-value upper-value )
172
Note: An ordered list of values can contain predefined values, see 17 . Both PARMG and PARMI show a list of two values that must be coded in the order shown when the parameter is coded. Parentheses are required around the list of values even if no keyword is used. PARMG and PARMI could be coded as:
PARMG(0 16) PARMI(1 9999)
16
Unordered List of Values (with repetition)
A parameter that can have several values specified in no particular order (an unordered list of like values) is shown as follows:
*NONE (1) PARMH( *VALUE1 *VALUE2 *VALUE3 user-value )
Notes: 1 A maximum of 3 repetitions.
The PARML parameter can be specified as one, two, or three of the values shown. As the syntax note shows, any combination of three values selected and a user-defined value can be specified in any order. The user-defined value could be any value allowed for that parameter. Any of the following could be coded:
PARML(*VALUE1 *VALUE3) PARML(*VALUE3 *VALUE2 16) PARML(16 3 12)
If PARML is not specified, the single value *NONE is the default used by the system. Note that if *NONE is specified, none of the other values can be specified. 17 Ordered List of Values (with repetition)
A parameter that can have more than one ordered list of values (a series of ordered lists) of values is shown below.
*NONE *NO (1) ( *YES *VAL1 *VAL2 *VAL3 user-val )
PARML(
173
PARML can be specified as a single value (*NONE or *NO) or as a list of values, but not as both. When PARML is coded as a list of values, the values must be specified in the order shown, and both elements in the list must be specified (in other words, *YES must always precede either a predefined or user-defined value). For example, PARML can be coded as follows (notice that two sets of parentheses are required for the elements):
PARML((*YES *VAL1)) PARML(*NONE) PARML((*YES 50))
However, PARML cannot be coded as follows:

PARML((*NONE *VAL1)) PARML((*VAL1 *YES)) PARML(*VAL1) PARML(*YES)
If repetition is used to specify more than one list of values for PARML, each list must be enclosed in parentheses. For example, three repetitions (the maximum for PARML) of lists of values could be coded as follows:
PARML((*YES *VAL2) (*YES *VAL1) (*YES 43))
Notice that a particular order is required for the elements in each list, but a particular order is not required for repeated lists. The value *YES must always precede the other values within the list, but (*YES *VAL1) does not have to be the first list specified for PARML. For some commands, the second element is not required as shown below:
*NONE (1) PARMQ( ( *YES *NO ) *VAL1 *VAL2 *VAL3 user-value )
Notice that in this example, that *NONE can be specified by itself, and the second element does not have to be specified. However, if the first element is coded by itself, the extra set of parentheses are required as shown below:
PARMQ((*NO) (*YES *VAL3) (*YES))
18
Ordered Lists of Values as Fragments
In this manual, fragments are used to show and reference long lists of values, as shown on 18 in the sample syntax diagram. If there are fewer than five elements, the structure shown for PARMN is used (see PARMN details on the sample syntax diagram). The structure of PARMN correctly shows that the elements must be coded in positional form. You cannot code *BLANK without coding the first three values or including the place holder, *N. The following could be entered:
174
PARMN(A) PARMN(A B) PARMN(A B GENVAL*) PARMN(A *N GENVAL* *BLANK)
Note: You can use *N as a place holder. However, the following would yield incorrect results because the elements are not coded in positional form.
PARMN(GENVAL* *BLANK) PARMN(*BLANK) PARMN(B 'User Object')
If a parameter contains five or more elements, the structure shown for PARMM is used (see PARMM details in the sample syntax diagram) because using the structure shown for PARMN for large numbers of elements makes the syntax diagram too complex. These elements are all shown as optional. However, they, like the elements in PARMN, must be coded in positional form. Fragments can contain fragments as shown in PARMM details on the sample syntax diagram. PARMM details contains all of the PARMN details all of which must be specified in positional form. 19 Dependent Parameter Relationships
Some parameters or values have dependent relationships with other parameters or values. Parameters that depend on values are indicated by a footnote. Parameters that are mutually exclusive are shown in the example below:
*VALUE1 *VALUE2 *VALUE3 *NONE any-value (1) ) ) PARMJ( (2) value )
PARMI( PARMK(
Notes: 1 2 PARMJ is required only when PARMI(*VALUE2) is specified.
PARMI and PARMK are mutually exclusive parameters; PARMI and PARMK cannot be coded on the same command. As the note shows, PARMJ is a dependent parameter which is valid only when *VALUE2 is specified for the PARMI parameter. Note that PARMJ cannot be specified if PARMK is specified. Also note that all of these parameters are optional because they appear below the base line.. v How to read syntax diagrams on page 165 v How syntax diagrams show command structure on page 166
175
176
Chapter 10. CL character sets and values

This topic explains the usage of the EBCDIC character sets, special characters, and IBM-defined fixed values called predefined values. v Character sets v Special character usage on page 178 v Predefined values on page 180
Character sets
The control language uses the extended binary-coded decimal interchange code (EBCDIC) character set. For convenience in describing the relationship between characters used in the control language and those in the EBCDIC character set, the following control language categories contain the EBCDIC characters shown:
Category Alphabetic Numeric Alphanumeric
1,2 1
Characters Included 26 letters (A through Z), $, #, and @ 10 digits (0-9) A through Z, 0 through 9, $, #, @, period (.), and underscore (__) All other EBCDIC characters (for those having special uses in CL, see Special character usage on page 178)
Special Characters Note:

1
Lowercase letters (a through z) are accepted, but they are translated into the corresponding uppercase letters by the system except when they are included within a quoted character string or a comment, or they are specified for a value on a parameter that has the character (*CHAR) or the path name (*PNAME) attribute for its TYPE parameter and the mixed case (*MIXED) attribute for its CASE parameter in the command definition. The underscore (__) is an alphanumeric connector that can be used in AS/400 CL to connect words or alphanumeric characters to form a name (for example, PAYLIB__01). This use of the underscore might not be valid in other high-level languages.
The first three categories contain the characters that are allowed in quoted and unquoted character strings, in comments, and in CL names, such as in names of commands, labels, keywords, variables, and OS/400 objects. Special characters in the last category can only be used in quoted character strings and comments; they cannot be used in unquoted strings. However, some have special syntactical uses when coded in the proper place in CL commands. These uses are given in the Special character usage on page 178 chart. For related information, also see: v Special character usage on page 178 v Predefined values on page 180
177
Special character usage

| | | | | | | | | The following special EBCDIC characters are used by the CL in various ways. They are most frequently used as delimiters (which are covered in Delimiters on page 159 under Chapter 8. Command syntax on page 159 ) and as Symbolic operators on page 179 in expressions. For more information about symbolic operators, see the discussion about the types of expressions in the Operators in expressions on page 198 topic. Special characters can only be used in these special ways or inside quoted character strings or comments. The special characters, as shown in the following table, have assigned meanings when coded in control language commands: Delimiters
Name Apostrophe Begin and end comment Blank Symbol /*
1
Meanings Single apostrophe delimiters indicate the beginning and end of a quoted character string (a constant).
*/
Indicates the beginning and end of a comment. Basic delimiter for separating parts of a command (label, command name, and its parameters), and for separating values inside lists. Ending delimiter for command labels. Separates parts of time values.3 In many countries, used as decimal point in numeric values. Separates parts of date values.2 Grouping delimiter for lists and parameter values, and for evaluating the order of expressions. Decimal point. Used to separate the name and extension of a document and folder name and to separate the parts of date values.2
Colon Comma Left and right parentheses Period
: , ( ) .
Quote Slash Slashes
/ //
Start of a quoted object name. Connects parts of qualified names or path names. Identifying characters used in positions 1 and 2 of BCHJOB, ENDBCHJOB, and DATA commands in the job stream. Also, used as a default delimiter on inline data files.
Note:
1
Because this character does not resolve in the online version of this book, is used to represent a blank space only when the character cannot be clearly explained in another manner. Valid only when the job date separator value specifies the same character. Valid only when the job time separator value specifies the same character.
2 3
v Character sets on page 177 v Predefined values on page 180
178
Symbolic operators
| The following characters are used as symbolic operators in CL commands.
Name And Asterisk Symbol & * Meanings Symbolic logical operator for AND. Multiplication operator. Indicates a generic name when it is the last character in the name. Indicates OS/400 reserved values (predefined parameter values and expression operators) when it is the first character in a string. Character string operator (indicates both values are to be joined). See Expressions on page 127 for more information on the differences between these concatenation operators. Symbolic equal relational operator. Symbolic greater than relational operator. Symbolic less than relational operator. Subtraction operator, command continuation operator, and negative signed value indicator. Separates parts of date values.1 Symbolic NOT relational operator. Symbolic logical operator for OR. Addition operator, command continuation character, and positive signed value indicator. Division operator. Separates parts of date values.1 Used as the separator between parts of a qualified name.
Concatenation
|>, |<, and ||3
Equal Greater than Less than Minus (hyphen)
= > <
Not Or Plus Slash Note:

1 2
2 |
3
+ /
Valid only when the job date separator value specifies the same character. In some character sets, including the multinational character set, the character ^ replaces the character. Either ^ or *NOT can be used as the logical NOT operator in those character sets. In some character sets, including the multinational character set, the character ! replaces the | character. Either ! or *OR can be used as the logical OR operator, and either !! or *CAT can be used as the concatenation operator in those character sets.
Note: The symbolic operators can also be used in combinations as listed in the chart under Operators in expressions on page 198 in Expressions on page 127. Symbolic operators: Other uses | Symbolic operators can also be used in the following ways:
Name Ampersand Percent Symbol & % Meanings Identifies a CL variable name when it is the first character in the string. Identifies a built-in system function when it is the first character in the string.
Chapter 10. CL character sets and values
179
Name Question mark
Symbol ?
Meanings Specifies a prompt request when it precedes a command name or keyword name.
Predefined values
Predefined values are IBM-defined fixed values that have predefined uses in the CL and are considered to be reserved in the OS/400 system. Predefined values have an asterisk (*) as the first character in the value followed by a word or abbreviation, such as *ALL or *PGM. The purpose of the * in predefined values is to prevent possible conflicts with user-specified values, such as object names. Each predefined value has a specific use in one or more command parameters, and each is described in detail in the command description. Some predefined values are used as operators in expressions, such as *EQ and *AND. The predefined value *N is used to specify a null value and can be used to represent any optional parameter. A null value (*N) indicates a parameter position for which no value is being specified; it allows other parameters that follow it to be entered in positional form. To specify the characters *N as a character value (not as a null), the string must be enclosed in apostrophes (*N) to be passed. Also, when the value *N appears in a CL program variable at the time it is run, it is always treated as a null value. v Character sets on page 177 v Special character usage on page 178
180
Chapter 11. Object naming rules

The following rules, in addition to the standard rules for all names, are used to name all OS/400 objects used in control language commands. The syntax diagram for each CL command shows whether a simple object name, a qualified name, or a generic name can be specified. v Naming a Single Object: In the name of a single object, each part (the simple name and the library qualifier name) can have a maximum of 10 characters. For more information on specifying objects, see Generic object names on page 111. v Naming a User-Created Object: To distinguish a user-created object from an IBM-supplied object, you should not begin user-created object names with Q because the names of all IBM-supplied objects (except commands) begin with Q. Although you can use as many as 10 characters in CL object names, you may need to use fewer characters to be consistent with the naming rules of the particular high-level language that you are also using. Also, the high-level language might not allow underscores in the naming rules. For example, RPG limits file names to eight characters and does not allow underscores. v Naming a Generic Object: In a generic name, a maximum of nine alphanumeric characters can be used, not including the asterisk (*) that must immediately follow the last character. For more information on using generic names see Generic object names on page 111. INV and INV* are valid values where a generic name is accepted. When the name INV is specified, only the object INV is referenced. When the quoted generic name INV* is specified, objects that begin with INV are referred to, such as INV, INVOICE, INVENTORY, and INVENPGM1. When the quoted generic name INV* is specified, objects that begin with INV are referred to, such as INV%1 and INV>. v Object Library Qualifier Limitations: No library qualifier can be specified with the object name if the object being created is a library, user profile, line description, controller description, device description, mode description, class-of-service description, or configuration list. A library name can never be qualified because a library cannot be placed in a library. The other object types (*USRPRF, *LIND, *CTLD, *DEVD, *MODD, *COSD, and *CFGL) appear to be types that exist only in the QSYS library. When only the name of an object of these object types is accepted, a library qualifier cannot be specified with the object name. On the Display Object Description (DSPOBJD) command, where any object name is accepted, QSYS can be specified. v Library List Qualifiers: The predefined value *LIBL (and others, such as *CURLIB and *ALLUSR) can be used in place of a library name in most commands. *LIBL indicates that the libraries named in the jobs library list are used to find the object named in the second part of the qualified name. v Duplicate Object Names: Duplicate names are not allowed for objects of the same type in the same library. Two objects with the same name cannot be stored in the same library unless their object types are different. Two objects named OBJA can be stored in the library LIBx only if, for example, one of the objects is a program and the other is a file. The following combinations of names and object types could all exist on the system at the same time.
181
If more than one library contains an object with the same name (and both libraries are in the same library list) and a library qualifier is not specified with the object name, the first object found by that name is used. Therefore, when you have multiple objects with the same name, you should specify the library name with the object name or ensure that the appropriate library occurs first in the library list. For example, if you are testing and debugging and choose not to qualify the names, ensure that your test library precedes your production library in the library list. Default libraries In a qualified object name, the library name is always optional. If a library name is not specified, the default given in the commands description is used (usually either *CURLIB or *LIBL). If the named object is being created, the current library is the default; when the object is created, it is placed either in the current library or in the QGPL (the general purpose library ) if no current library is defined. For objects that already exist, *LIBL is the default for most commands, and the jobs library list is used to find the named object. The system searches all of the libraries currently in the library list until it finds the object name specified. For additional information, see the following: v Path names (*PNAME) v Generic names (*GENERIC) on page 184 v Additional rules for unique names on page 184 v Chapter 12. Naming within commands on page 187 v Chapter 13. Folder and document names on page 191
Path names (*PNAME)

A path name is a character string that can be used to locate objects in the integrated file system. The string can consist of one or more elements, each separated by a slash (/) or back slash (\). Each element is typically a directory or equivalent, except for the last element, which can be a directory, another object such as a file, or a generic presentation of an object or objects to be located.
182
The / and \ characters and nulls cannot be used in the individual components of the path name because the / and \ characters are used as separators. The name may or may not be changed to uppercase, depending on whether the file system containing the object is case-sensitive and whether the object is being created or searched for. If the parameter is defined as CASE(*MONO) (the default), any values that are not enclosed in single quotes will be changed to uppercase by the command analyzer. A / or \ character at the beginning of a path name means that the path begins at the top most directory, the root (/) directory. If the path name does not begin with a / or \ character, the path is assumed to begin at the current directory of the user entering the command. The path name must be represented in the CCSID currently in effect for the job. If the CCSID of the job is 65535, the path name must be represented in the default CCSID of the job. Hard-coded path names in programs are encoded in CCSID 37. Therefore, the path name should be converted to the job CCSID before being passed to the command. The maximum length of the path name character string on the CL commands is 5000 characters. When operating on objects in the QSYS.LIB file system, the component names must be of the form name.object-type; for example:
'/QSYS.LIB/PAY.LIB/TAX.FILE'
Path names must be enclosed in apostrophe () marks when entered on a command line if they contain special characters. These marks are optional when path names are entered on displays. If the path name includes any quoted strings or special characters; however, the enclosing marks must be included. The following are rules for using special characters: v A tilde () character followed by a slash or backslash at the beginning of a path name means that the path begins at the home directory of the user entering the command. v A tilde () character followed by a user name and then a slash or backslash at the beginning of a path name means that the path begins at the home directory of the user identified by the user name. v In some commands, an asterisk (*) or a question mark (?) can be used in the last component of a path name to search for patterns of names. The * tells the system to search for names that have any number of characters in the position of the * character. The ? tells the system to search for names that have a single character in the position of the ? character. v To avoid confusion with AS/400 special values, path names cannot start with a single asterisk (*) character. To perform a pattern match at the beginning of a path name, use two asterisks (**). Note: This only applies to relative path names where there are no other characters before the asterisk. v The path name must be enclosed in apostrophes () or quotation marks () if any of the following characters are used in a component name: Asterisk (*) Question mark (?) Apostrophe () Quotation mark () Tilde (), if used as the first character in the first component name of the path name (if used in any other position, the tilde is interpreted as just another character)
183
This practice is not recommended because the meaning of the character in a command string could be confused and it is more likely that the command string will be entered incorrectly. v Do not use a colon (:) in path names. It has a special meaning within the system. v The processing support for commands and associated user displays does not recognize code points below hexadecimal 40 as characters that can be used in command strings or on displays. If these code points are used, they must be entered as a hexadecimal representation, such as the following:
crtdir dir(X'02')
Therefore, use of code points below hexadecimal 40 in path names is not recommended. This restriction applies only to commands and associated displays, not to APIs. Related information: v Chapter 12. Naming within commands on page 187 v Chapter 13. Folder and document names on page 191 v Generic names (*GENERIC) v Additional rules for unique names For more information on path names, see the Integrated File System topic.
Generic names (*GENERIC)

A generic name is one that contains at least one initial character that is common to a group of objects, followed by an asterisk. (The asterisk identifies the series of common characters as a generic name; otherwise, the system interprets the series of characters as the name of a specific object). For more information on *GENERIC names, see the Generic object names on page 111 section in this topic. Related information: v v v v Path names (*PNAME) on page 182 Additional rules for unique names Chapter 12. Naming within commands on page 187 Chapter 13. Folder and document names on page 191
Additional rules for unique names

Additional rules involving special characters (as an extra character) that apply to the following types of names are: v A command label must be immediately followed by a colon (:). Blanks can follow the colon, but none can precede it. A command label name cannot be a quoted name. v A CL variable name must be preceded by an ampersand (&) to indicate that it is a CL variable used in a CL program. v A built-in function name must be preceded by a percent sign (%) to indicate that it is an IBM-supplied built-in function that can be used in an expression. A built-in function name cannot be a quoted name. These special characters are not part of the name; each is an additional character attached to a name (making a maximum of 11 characters) indicating to the system what the name identifies.
184
The names of OS/400 objects, CL program variables, system values, and built-in functions can be specified in the parameters of individual commands as indicated in the syntax diagram for each command. Instead of specifying a constant value, a CL variable name can be used on most parameters in CL programs to specify a value that may change during the running of programs. It is the contents of the variable that identify the objects and variables that are used when the command is run. For more information, see the following: v Path names (*PNAME) on page 182 v Generic names (*GENERIC) on page 184 v Chapter 12. Naming within commands on page 187 v Chapter 13. Folder and document names on page 191
185
186
Chapter 12. Naming within commands

The type of name you specify in the OS/400 control language determines the characters you can use to specify a name. For certain types of names, there are restrictions on the use of certain characters to represent the name. Those types of names are *NAME, *SNAME, and *CNAME. The *PNAME and *GENERIC list element or parameter types are only discussed briefly in this section. Note: For a description of how to specify these names when you use command definitions to create commands, see the PARM (parameter) and ELEM (element) statements in Chapter 15. Command definition statements on page 205. The characters allowed for the *NAME, *SNAME, and *CNAME names and the rules you use to specify them are shown in the table and descriptions that follow.
Table 10. Allowable Characters for *NAME, *SNAME, and *CNAME Type of Name *NAME
1
First Character A-Z, $, #, @ A-Z, $, #, @ A-Z, $, #, @ "3
Other Characters A-Z, 0-9, $, #, @, _, . A-Z, 0-9, $, #, @, _ A-Z, 0-9, $, #, @ Any except blank, *, ?, , , X00-X3F, and XFF
Min. Length 1
Max. Length 256
*SNAME1
256
*CNAME1
Quoted name2
256
Notes:
1 2 3
The system converts lowercase letters to uppercase letters. Double quotes can only be used for basic names (*NAME). Both the first and last characters must be a double quote ().
*NAME (Basic Name): Every basic name can begin with the characters A-Z, $, #, or @ and can be followed by up to nine characters. The remaining characters can include the same characters as the first but can also include numbers 0-9, underscores (_), and periods (.). Lowercase letters are changed to uppercase letters by the system. Basic names used in IBM-supplied commands can be no longer than 10 characters. However, in your own commands, you can define parameters of type *NAME (specified on the TYPE parameter of the PARM or ELEM statements) with up to 256 characters. Examples of basic names are shown below:
187
A987@.442#
ONE_NAME
LIBRARY_0690
$LIBX
Names can be entered in quoted or unquoted form. If you use the quoted form, the following rules and considerations also apply: *NAME (Basic Name in Quoted Form): Every quoted name must begin and end with a quotation mark (). The middle characters of a quoted name can contain any character except , *, ?, , , hex 00 through 3F, or hex FF, and is delimited by a slash. Quoted names allow you to use graphic characters in the name. The quoted form of basic names used in IBM-supplied commands can be no longer than 8 characters (not including the double quotes). In your own commands, you can define parameters of type *NAME in quoted form with up to 254 characters (not including the double quotes). Note: Only basic names can be used in quoted form. Examples of quoted names are shown below:
"A" "AA%abc" "ABC%%abc"
When you use quoted names, you should be aware of certain restrictions: v Code points in a name might not be addressable from all keyboards. v Characters in a quoted name might not be valid in a high-level language. v The System/38 environment supports only simple (*SNAME) names. If other characters are used, the objects cannot be accessed as System/38 environment objects. v Names that are longer than eight characters cannot be accessed by the System/36 environment unless control language overrides are used. v A Structured Query Language (SQL) name that contains a period must be specified in an SQL statement in quotation marks. If a name enclosed in quotation marks is a valid unquoted basic name, the quotation marks are removed. Thus, ABC is equivalent to ABC. Because the quotation marks are removed, they are not included in the length of the name. ABCDEFGHIJ is, therefore, a valid name on IBM* commands even though it is longer than 10 characters. *SNAME (Simple Name): Simple names are the same as unquoted basic names but with one exception: periods (.) cannot be used. Simple names are used for CL variables, labels, and keywords to simplify the syntax of the control language. Some examples of simple names are as follows:
NEWCMD LIB_2
*CNAME (Communications Name): Communications names are the same as unquoted basic names with the following exceptions: 1. Periods (.) and underscores (_) cannot be used. 2. For IBM commands, *CNAME is limited to 8 characters. An example of a communications name is shown below:
APPN3@@
Note: Because restricted character sets are sometimes used by other IBM systems, use caution when choosing names that use the special characters #, $, and @.
188
These special characters might not be on the remote systems keyboard. The names that may be exchanged with the remote systems include the following: v Network IDS v Location names v Mode names v Class-of-service names v Control point names Additional information: v Chapter 11. Object naming rules on page 181 v Chapter 13. Folder and document names on page 191
Chapter 12. Naming within commands
189
190
Chapter 13. Folder and document names

Folder names should describe the contents of a folder. The names must be unique and should be easy to type, as well as descriptive to a user. To find a particular folder on the system and change a document stored in it, you must either supply the folder name or select it from a list of names. Document names should describe the contents of the document. You should give careful consideration to the names you use to help you find the document later. The names must be unique in the folder and should be easy to type, as well as descriptive. The name you use for a folder or a document must follow these rules: v The name must be unique within a folder. v A document or folder name can be 1 to 12 characters long, including an optional extension. If no extension is included, a document or folder name can have a maximum of eight characters. If an extension is included, the extension must start with a period and can have up to three additional characters. An extension in the document name allows you to identify the document by using specific information that can help you do a selective listing of documents on your system.
v A document or folder name can include any single-byte EBCDIC character except for the following special characters that the system uses for other purposes:
Character Asterisk (*) Special uses Multiplication operator, indicates generic names, and indicates OS/400 reserved values Division operator, delimiter within system values, and separates parts of qualified object names Initiates requests for system help
Slash (/)
Question Mark (?)
v When a folder is stored in another folder, both folder names are used, separated by a slash (/). That combination of names is called a folder path. For example, if a folder named FOLDR2 is stored in FOLDR1, the path for FOLDR2 is
191
FOLDR1/FOLDR2. FOLDR1 is the first-level folder. FOLDR2 is the next-level folder. The name of a single folder can be 1 to 12 characters long, including an optional extension. A folder path can contain a maximum of 63 characters. Folder names should not begin with Q because the system-supplied folder names begin with Q. The following are examples of permitted folder names and folder paths:
@LETTERS FOLDER.PAY PAYROLL/FOLDER.PAY #TAX1/FOLD8.TAX/$1988/PAYROLL/FOLDER.PAY
Notes: 1. In CL commands, folder path names must be enclosed in apostrophes to prevent the system from processing them as qualified (library/object) names. If an apostrophe is to be part of the name, it must be specified as two consecutive apostrophes. 2. A number of CL commands act on either documents or folders, and some act on both. The abbreviation DLO (document library object) is used when referring to either a document or folder. 3. In CL commands, folder and document names must be enclosed in apostrophes if they contain characters that are CL delimiters. 4. The system does not recognize graphic characters; it recognizes only code points and uses the following assumptions: v All folder and document names are encoded using single-byte EBCDIC code pages. Since code points hex 41 through FE represent graphic characters in those code pages, they are the only code points that can be used in folder and document names. v Code points hex 5C, 61, and 6F represent the asterisk (*), slash (/), and question mark (?) respectively, and cannot be used in folder and document names. v The code points for lowercase letters in English (hex 81 through 89, 91 through 99, and A2 through A9) are converted to the code points for uppercase letters (C1 through C9, D1 through D9, and E2 through E9, respectively). More information on code pages that are supported on the AS/400 system is in Chapter 5 of the Local Device Configuration book and in the description of the CRTDEVDSP (Create Device Description (Display)) command. In addition to the folder and document names previously described, folders and documents are internally classified in the system by their system object names. These are 10-character names derived from date/time stamps, and, while they are generally not known to the user, they may be specified on some CL commands by specifying *SYSOBJNAM for the folder or document name and by specifying the system object name in a separate parameter. For more information, see Chapter 12. Naming within commands on page 187
192
Chapter 14. Expressions in CL commands

A character string expression can be used for any parameter, element, or qualifier defined with EXPR(*YES) in the command definition object. Any expression can be used as a single parameter in the Change Variable (CHGVAR) and If (IF) commands. An expression in its simple form is a single constant, a variable, or a built-in function. An expression usually contains two operands and an operator that indicates how the expression is to be evaluated. Two or more expressions can be combined to make a complex expression. The following types of expressions are supported in CL programs: v Arithmetic(&VAR + 15) v Character string(SIX || TEEN) v Relational (&VAR > 15) v Logical(&VAR & &TEST) A complex expression contains multiple operands, operators that indicate what operation is performed on the operands, and parentheses to group them. Only one operator is allowed between operands, except for the + and - signs when they immediately precede a decimal value (as a signed value), and the *NOT operator when it is used in a logical expression. No complex expression can have more than five nested levels of parentheses, including the outermost (required) level. Arithmetic and character string expressions can be used together in a complex expression if they are used with relational and logical operators; for example: (A=B&(1+2)=3). A pair of arithmetic expressions or a pair of character string expressions can be compared within a relational expression. Also, relational expressions can be used within a logical expression Related information can be found in the following topics: v Operators in expressions on page 198 v Priority of operators when evaluating expressions on page 199 v Built-in functions for CL on page 200
Arithmetic expressions
The operands in an arithmetic expression must be decimal constants or decimal CL variables. An arithmetic operator (only in symbolic form) must be between the operands. The results of all arithmetic expressions are decimal values, which may be stored in a CL variable. Note: The division operator (/) must be preceded by a blank if the operand that precedes it is a variable name. (For example, &A /2, not &A/2.) All other arithmetic operators may optionally be preceded or followed by a blank. Arithmetic operands can be signed or unsigned; that is, each operand (whether it is a numeric constant or a decimal CL variable) can be immediately preceded by a plus (+) or minus (-) sign, but a sign is not required. When used as a sign, no
193
blanks can occur between the + or - and its value. For example, a decimal constant of 23.7 can be expressed as +23.7 or -23.7 (signed) or as 23.7 (unsigned). The following are examples of arithmetic expressions:
(&A + 1) (&A - &F) (&A + (-&B)) (&A + &B -15) (&A+&B-15)
If the last nonblank character on a line is a + or -, it is treated as a continuation character and not as an arithmetic operator. v Operators in expressions on page 198 v Character string expressions v Relational expressions on page 196 v Logical expressions on page 197 v Priority of operators when evaluating expressions on page 199 v Built-in functions for CL on page 200
Character string expressions

The operands in a character string expression must be quoted or unquoted character strings, character variables, or the substring (%SUBSTRING or %SST) built-in function. The value associated with each variable or built-in function must be a character string. The result of concatenation is a character string. There are three operators that can be used in character string expressions. These operators concatenate (or join) two character strings, but each has a slightly different function. They are: v *CAT (concatenation, symbol ||) *CAT Operator The *CAT operator concatenates two character strings. For example: ABC *CAT DEF becomes ABCDEF Blanks are included in the concatenation. For example: 'ABC ' *CAT 'DEF ' becomes 'ABC DEF ' v *BCAT (concatenation with blank insertion, symbol |>) *BCAT Operator The *BCAT operator truncates all trailing blanks in the first character string; one blank is inserted, then the two character strings are concatenated. Leading blanks on the second operand are not truncated. For example: ABC *BCAT DEF becomes ABC DEF 'ABC ' *BCAT DEF becomes 'ABC DEF' v *TCAT (concatenation with trailing blank truncation, symbol |<) *TCAT Operator The *TCAT operator truncates all trailing blanks in the first character string, then the two character strings are concatenated. All leading blanks on the second operand are not truncated. For example:
194
ABC *TCAT DEF becomes ABCDEF 'ABC ' *TCAT DEF becomes 'ABCDEF' ABC *TCAT ' DEF' becomes 'ABC DEF' 'ABC '*TCAT ' DEF' becomes 'ABC DEF' All blanks that surround the concatenation operator are ignored, but at least one blank must be on each side of the reserved value operator (*CAT, *BCAT, or *TCAT). If multiple blanks are wanted in the expression, a quoted character string (a character string enclosed within apostrophes) must be used. | | See the following examples for more information about character string expressions. v Example: Character string expressions v Example: Using character strings and variables on page 196 For additional information about using other types of expressions in CL commands, see the following: v Arithmetic expressions on page 193 v Relational expressions on page 196 v v v v Logical expressions on page 197 Operators in expressions on page 198 Priority of operators when evaluating expressions on page 199 Built-in functions for CL on page 200
| |
Example: Character string expressions

The following are examples of string expressions. Assume the following variables:
Variable &AA &BB &CC &DD Expression (&AA || &BB) (&AA||&BB) (&AA *CAT &BB) (&CC |> &DD) (&CC *BCAT &DD) (A *CAT MOUSE) (A *CAT MOUSE) (FAST *CAT MOUSE) (FAST *BCAT MOUSE) (FAST *TCAT MOUSE) (AB *CAT CD) (AB *BCAT CD) (AB *TCAT CD) Value 'GOOD ' 'REPLACEMENT' 'ALSO GOOD' 'METHOD' Result GOOD REPLACEMENT GOOD REPLACEMENT GOOD REPLACEMENT ALSO GOOD METHOD ALSO GOOD METHOD AMOUSE A MOUSE FASTMOUSE FAST MOUSE FASTMOUSE ABCD AB CD ABCD
195
Expression (%SST(&AA 1 5) *CAT (%SST(&BB 3 5)) (%SST(&CC 1 9) *BCAT (%SST(&BB 3 5)) (&AA *CAT TIME) (&CC *BCAT TIME)
Result GOOD PLACE ALSO GOOD PLACE GOOD TIME ALSO GOOD TIME
For another example using character strings and variables: v Example: Using character strings and variables
Example: Using character strings and variables

The following example shows how several character variables and character strings can be concatenated to produce a message for a work station operator. The example assumes that the variables &DAYS and &CUSNUM were declared as character variables, not decimal variables.
DCL VAR(&MSG)TYPE(*CHAR) LEN(100) v v CHGVAR &MSG('Customer' *BCAT &CUSNAMD + *BCAT'Account Number' *BCAT + &CUSNUM *BCAT 'is overdue by' + *BCAT &DAYS *BCAT 'days.')
After the appropriate variables have been substituted, the resulting message might be:
Customer ABC COMPANY Account Number 12345 is overdue by 4 days.
If the variables &DAYS and &CUSNUM had been declared as decimal variables, two other CHGVAR commands would have to change the decimal variables to character variables before the concatenation could be performed. If, for example, two character variables named &DAYSALPH and &CUSNUMALPH were also declared in the program, the CHGVAR commands would be:
CHGVAR CHGVAR &DAYSALPH &DAYS &CUSNUM &CUSNUMALPH
Then instead of &DAYS and &CUSNUM, the new variables &DAYSALPH and &CUSNUMALPH would be specified in the CHGVAR command used to concatenate all the variables and character strings for &MSG. For another example using character string expressions: v Example: Using character strings and variables
Relational expressions
The operands in a relational expression can be arithmetic or character string expressions; they can also be logical constants and logical variables. Only two operands can be used with each relational operator. The data type (arithmetic, character string, or logical) must be the same for the pair of operands. The result of a relational expression is a logical value 0 or 1. Refer to the table under Operators in expressions on page 198 for the meanings of the relational operators, which can be specified by symbols (=, >, <, >=, <=, =, >, <) or their reserved values (*EQ, *GT, *LT, *GE, *LE, *NE, *NG, *NL).
196
If an operation involves character fields of unequal length, the shorter field is extended by blanks added to the right. Arithmetic fields are compared algebraically; character fields are compared according to the EBCDIC collating sequence. When logical fields are compared, a logical one (1) is greater than logical zero (0). Symbolically, this is (1 > 0). The following are examples of relational expressions:
(&X *GT 25) (&X > 25) (&X>25) (&NAME *EQ GSD) (&NAME *EQ &GSD) (&NAME *EQ 'GSD') (&BLANK *EQ ' ')
v Operators in expressions on page 198 v Character string expressions on page 194 v Logical expressions v Priority of operators when evaluating expressions on page 199 v Built-in functions for CL on page 200
Logical expressions
The operands in a logical expression consist of relational expressions, logical variables, or constants, separated by logical operators. Two or more of these types of operands can be used in combinations, making up two or more expressions within expressions, up to the maximum of five nested levels of parentheses. The result of a logical expression is a 0 or 1 that can be used as part of another expression or saved in logical variables. The logical operators used to specify the relationship between the operands are *AND and *OR (as reserved values), and & and | (as symbols). The AND operator indicates that both operands (on either side of the operator) have to be a certain value to produce a particular result. The OR operator indicates that one or the other of its operands can determine the result. The logical operator *NOT (or ) is used to negate logical variables or logical constants. All *NOT operators are evaluated before the *AND or *OR operators are evaluated. All operands that follow *NOT operators are evaluated before the logical relationship between the operands is evaluated. The following are examples of logical expressions:
((&C *LT 1) *AND (&TIME *GT 1430)) (&C *LT 1 *AND &TIME *GT 1430) ((&C < 1) & (&TIME *GT 1430)) ((&C<1)&(&TIME>1430)) (&A *OR *NOT &B) (&TOWN *EQ CHICAGO *AND &ZIP *EQ 60605)
Two examples of logical expressions used in the IF command are:

IF &A CALL PROG1 IF (&A *OR &B) CALL PROG1
197
v v v v v
Operators in expressions Character string expressions on page 194 Relational expressions on page 196 Priority of operators when evaluating expressions on page 199 Built-in functions for CL on page 200
Operators in expressions
Operators are used in expressions to indicate an action to be performed on the operands in the expression or the relationship between the operands. There are four kinds of operators, one for each of the four types of expressions: v v v v Arithmetic operators (+, -, *, /) Character operator (||, |>, |<) Logical operators (&, |, ) Relational operators (=, >, <, >=, <=, =, >, <)
Each operator must be between the operands of the expression in which it is used; for example, (&A + 4). Operators can be specified as a predefined value (for example, *EQ) or as a symbol (for example, =). v All predefined value operators must have a blank on each side of the operator:
(&VAR *EQ 7)
v Except for the division operator (/), symbolic operators need no blanks on either side. For example, either (&VAR=7) or (&VAR = 7) is valid. Where the division operator follows a variable name, the division operator must be preceded by a blank. For example, (&VAR / 5) or (&VAR /5) is valid; (&VAR/5) is not valid. The following character combinations are the predefined values and symbols that represent the four kinds of operators; they should not be used in unquoted strings for any other purpose.
Table 11. Predefined values and symbols representing the four kinds of operators Predefined Value Predefined Symbol + * / *CAT *BCAT *TCAT *AND *OR *NOT *EQ *GT ||
1
Meaning Addition Subtraction Multiplication Division Concatenation Blank insertion with concatenation
Type Arithmetic operator Arithmetic operator Arithmetic operator Arithmetic operator Character string operator Character string operator
|>1 |<1 & |

1 2
Blank truncation with Character string concatenation operator AND OR NOT Equal Greater than Logical operator Logical operator Logical operator Relational operator Relational operator
= >
198
Table 11. Predefined values and symbols representing the four kinds of operators (continued) Predefined Value *LT *GE *LE *NE *NG *NL Notes:
1
Predefined Symbol < = > <
Meaning Less than
Type Relational operator
Greater than or equal Relational operator Less than or equal Not equal Not greater than Not less than Relational operator Relational operator Relational operator Relational operator
In some national character sets and in the multinational character set, the character | (hexadecimal 4F) is replaced by the character ! (exclamation point). Either ! or *OR can be used as the OR operator and either !! or *CAT, !> or *BCAT, and !< or *TCAT can be used for concatenation in those character sets. In some national character sets and in the multinational character set, the character (hexadecimal 5F) is replaced by the character . Either or *NOT can be used as the NOT operator in those character sets.
For additional information, see the following: v Arithmetic expressions on page 193 v v v v v Character string expressions on page 194 Relational expressions on page 196 Logical expressions on page 197 Priority of operators when evaluating expressions Built-in functions for CL on page 200
Priority of operators when evaluating expressions

When multiple operators occur in an expression, the expression is evaluated in a specific order depending upon the operators in the expression. Parentheses can be used to change the order of expression evaluation. The following table shows the priority of all the operators used in expressions, including signed decimal values.
Priority 1 2 3 4 5 6 7 Operators signed (+ and -) decimal values, *NOT, *,/ +, - (when used between two operands) *CAT, ||, *BCAT, |>, *TCAT, |< *GT, *LT, *EQ, *GE, *LE, *NE, *NG, *NL, >, <, =, >=, <=, =, >, < *AND, & *OR, |
A priority of 1 is the highest priority (signed values are evaluated first); a priority of 7 is the lowest priority (OR relationships are evaluated last). When operators with different priority levels appear in an expression, operations are performed according to priorities.
199
When operators of the same priority appear in an expression, operations are performed from left to right within the expression. Parentheses can always be used to control the order in which operations are performed. The value of a parenthetical expression is determined from the innermost level to the outermost level, following the priorities stated above within matching sets of parentheses. v Operators in expressions on page 198 v Character string expressions on page 194 v Relational expressions on page 196 v Logical expressions on page 197 v Built-in functions for CL
Built-in functions for CL

CL provides the following built-in functions: v %BINARY v %SUBSTRING on page 202 v %SWITCH on page 203 See the following topics for related information: v Operators in expressions on page 198 v Character string expressions on page 194 v Relational expressions on page 196 v Logical expressions on page 197 v Priority of operators when evaluating expressions on page 199
%BINARY
The binary (%BINARY) built-in function operates on a character string that is contained in a CL character variable. %BINARY or %BIN can be used in expressions and as either operand (receiver) of the Change Variable (CHGVAR) command. See the CHGVAR command description for more information. Note: The binary built-in function can also be used on command parameters that are defined as numeric (*DEC, *INT2 and *INT4) and EXPR(*YES) has been specified. See Sample %BINARY syntax diagram on page 202 for the %BINARY syntax diagram. The binary built-in function treats the contents of the specified CL character variable, starting at the position specified for a length of 2 or 4 characters, as a signed binary integer. When the binary built-in function is used with the VAR parameter on the CHGVAR command, the decimal number or arithmetic expression in the VALUE parameter is converted to a 2-byte or 4-byte signed binary integer. A decimal fraction is not included. If the starting position and length are not specified, then a starting position of 1 and the length of the character variable specified is used. The length of the character variable must be declared as 2 or 4.
200
The following are examples of how the %BINARY built-in function can be used. Example 1: Converting binary to decimal
DCL VAR(&N) TYPE(*DEC) LEN(3 0) DCL VAR(&B2) TYPE(*CHAR) LEN(2) CHGVAR &N %BINARY(&B2) VALUE(X'0012')
The content of character variable &B2 is treated as a 2-byte signed binary number and is converted to its decimal equivalent of 18. It is then assigned to the decimal variable &N. Example 2: Converting decimal to binary
CHGVAR %BIN(&B2) &N
The number contained in the decimal variable &N is converted to a 2-byte signed binary number and is placed in the first and second bytes of the character variable &B2. Example 3: Used within an arithmetic expression
CHGVAR &N VALUE(%BIN(&B2) + 4)
The contents of character variable &B2 is treated as a 2-byte signed binary integer and is converted to its decimal equivalent of 18. The decimal number 4 is then added and the sum, 22, is assigned to the decimal variable &N. Example 4: Converting decimal to binary with truncation
CHGVAR %BINARY(&B2) VALUE(122.567)
The number 122.567 is truncated to the whole number 122 and is then converted to a 2-byte signed binary integer and assigned to the character variable &B2. Character variable &B2 will then contain the hexadecimal equivalent of X007A. Example 5: Converting a negative number
DCL VAR(&B4) TYPE(*CHAR) LEN(4) CHGVAR %BIN(&B4) VALUE(-45)
The value -45 is converted to a 4-byte signed binary integer assigned to the character variable &B4. Character variable &B4 then contains the hexadecimal equivalent of XFFFFFFD3. Example 6: Used on the IF command
IF COND(%BIN(&B4) *EQ 0) THEN(GOTO ENDIT)
The content of character variable &B4 is treated as a 4-byte signed binary integer and is compared to the decimal number 0. If they are equal, the command following the label ENDIT is run. If they are not equal, the command following the IF command is run. Example 7: Varying length character string to CPP
PGM DCL DCL DCL PARM(&P ... ) VAR(&P) VAR(&L) VAR(&C) TYPE(*CHAR) LEN(202)
TYPE(*DEC) LEN(5 0) TYPE(*CHAR) LEN(200)
201
v v CHGVAR CHGVAR v v v ENDPGM
&L &C
%BINARY(&P 1 2) %SST(&P 3 &L)
This program is the command processing program CPP for a command with a first parameter defined with the attributes TYPE(*CHAR), LEN(200) and VARY(*YES). The first two bytes of character variable &P contain the length of the parameter as *INT2, a 2-byte signed binary integer. The character string specified on the command starts in position 3 of the variable &P. The maximum length of the character string is 200 characters. The first CHGVAR command retrieves the length from the first two character positions of variable &P and treats the 2 bytes as a signed binary integer. The bytes are converted to the decimal equivalent of the signed binary integer, and are assigned to the decimal variable &L. The second CHGVAR command retrieves the contents of the parameter by making variable &P a substring and assigning it to variable &C.
Sample %BINARY syntax diagram

The syntax of the binary built-in function is:
%BINARY( character-variable-name starting-position 2 4 )
%SUBSTRING
The substring built-in function operates on a character string that is contained in a CL character variable or in a local data area. %SUBSTRING or %SST can be used in expressions and as either operand (receiver) of the Change Variable (CHGVAR) command. For more information, see the description of the CHGVAR command. This built-in function can be coded as either %SUBSTRING or %SST. See Sample %SUBSTRING syntax diagram on page 203 for the %SUBSTRING syntax diagram. This built-in function produces a substring from the contents of the specified CL character variable or local data area. The substring begins at the specified starting position in the value and continues for the length specified. For example:
%SST(&TEST 5 3)
In this example, a portion of the variable &TEST is referenced. That position (or substring) is 3 characters long and begins with the fifth character position. If &TEST contains ABCDEFGHIJ, the resulting substring will be EFG. CL variables can also be used to specify the starting position and the length values in the function. For example:
CHGVAR &X %SST(*LDA &B &C)
202
The value of the character variable named &X is to be replaced by the value in the jobs local data area, starting at the position obtained from variable &B and continuing for the length specified by the value in &C.
RTVJOBA CHGVAR SWS(&JOBSWS) VAR(&CURSW4) VALUE(%SST(&JOBSWS 4 1))
In this example, the Retrieve Job Attributes (RTVJOBA) command is used to retrieve the current value of the jobs eight job switches. The CHGVAR command is then used to extract the current value of the fourth job switch only and store it in the variable &CURSW4. If the value of the eight job switches retrieved in &JOBSWS is 10010000, the second 1 would be stored in &CURSW4.
Sample %SUBSTRING syntax diagram

The syntax of the substring built-in function is:
%SST( *LDA character-variable-name starting-position length )
%SWITCH
The built-in function %SWITCH tests one or more of the eight job switches in the current job and returns a logical value of 1 or 0. If every job switch tested by %SWITCH has the value indicated, the result is a 1 (true); if any switch tested does not have the value indicated, the result is a 0 (false). The 8-character mask is used to indicate which job switches are tested, and what value each switch is tested for. Each position in the mask corresponds with one of the eight job switches in a job. Position 1 corresponds with job switch 1, position 2 with switch 2, and so on. Each position in the mask can be specified as one of three values: 0, 1, or X. 0 1 X The corresponding job switch is tested for a 0 (off). The corresponding job switch is tested for a 1 (on). The corresponding job switch is not tested. The value in the switch does not affect the result of %SWITCH. See Sample %SWITCH syntax diagram on page 204 for the %SWITCH syntax diagram. If %SWITCH(0X111XX0) is specified, job switches 1 and 8 are tested for 0s, switches 3, 4, and 5 are tested for 1s, and switches 2, 6, and 7 are not tested. If each job switch contains the value (1 or 0 only) shown in the mask, the result of %SWITCH is true (1). Function %SWITCH can be used in the Change Variable (CHGVAR) and If (IF) commands. On the CHGVAR command, it can be used in place of a logical variable in the VALUE parameter. On the IF command, it can be used in the COND parameter as the logical expression to be tested. The following two examples show how the same mask can be used to control a branch in a program (the IF command), or to set the value of a variable (the CHGVAR command).
203
IF
COND(%SWITCH(0X111XX0)) VAR(&A)
THEN(GOTO C)
CHGVAR
VALUE(%SWITCH(0X111XX0))
If job switches 1, 3, 4, 5, and 8 respectively contain 0, 1, 1, 1, and 0 respectively when %SWITCH(0X111XX0) is specified in the IF command, the result is true and the program branches to the command having label C. If one or more of the switches tested do not have the values indicated in the mask, the result is false and the branch does not occur. If the same mask is used in the CHGVAR command and the result is true, the variable &A is set to a 1; if the result is false, &A is set to a 0. Note that &A must be declared as a logical variable.
Sample %SWITCH syntax diagram

The syntax of the switch built-in function is:
%SWITCH( )
204
Chapter 15. Command definition statements

The AS/400 control program lets users define a command that calls a program to perform some function. Users can define commands by using a command definition statement. The defined command can include the following: v Keyword notation parameters for passing data to programs v Default values for omitted parameters v Parameter validity checking so the program performing the function will have correct input v Prompt text for prompting interactive users For additional information about command definition statements, see the following: v Creating user-defined commands v Command definition statement descriptions on page 206 v CMD (command) statement on page 206 v DEP (dependent) statement on page 207 v ELEM (element) statement on page 210 v PARM (Parameter) statement on page 227 v PMTCTL (Prompt Control) statement on page 247 v QUAL (Qualifier) statement on page 249
Creating user-defined commands

Users can define a command by entering command definition statements into a source file and running a Create Command (CRTCMD) command using the source file as input. One and only one Command (CMD) statement must be somewhere in the source file. A Parameter (PARM) statement must be provided for each parameter that appears on the command being created. If any special keyword relationships need checking, the Dependent (DEP) statement is used to define the relationships. The DEP statement can only refer to parameters that have been previously defined. These statements can appear in any order. See the CL Programming book for a complete description of how to use these statements to define a command. Only one command can be defined in each source member in the source file. The CRTCMD command is run to create the command definition object from the command definition statements in one source file member. Other users can then be authorized to use the new command by the Grant Object Authority (GRTOBJAUT) command or the Edit Object Authority (EDTOBJAUT) command. v Command definition statement descriptions on page 206 v CMD (command) statement on page 206 v v v v v DEP (dependent) statement on page 207 ELEM (element) statement on page 210 PARM (Parameter) statement on page 227 PMTCTL (Prompt Control) statement on page 247 QUAL (Qualifier) statement on page 249
205
Command definition statement descriptions

The command definition statement of each command contains one or more of the following command statements: v CMD (command) statement v DEP (dependent) statement on page 207 v ELEM (element) statement on page 210 v PARM (Parameter) statement on page 227 v PMTCTL (Prompt Control) statement on page 247 v QUAL (Qualifier) statement on page 249 v Creating user-defined commands on page 205
CMD (command) statement

| | | | | | | |
CMD PROMPT (
The Command (CMD) statement specifies the prompt text for the command being created. The prompt text is displayed at a work station when a user requests prompting while entering the command that is being defined. The CMD statement can be anywhere in the source file referred to by the Create Command (CRTCMD) command; one and only one CMD statement must be used in the source file, even if no prompt text is specified for the created command. The following syntax diagram shows the syntax for the CMD definition statement.
*NONE message-identifier 'prompt-text' )
| | PROMPT Parameter Specifies the prompt text, if any, that is included in the heading (title) of the prompt display for the command being defined. The prompt text further describes the name of the command. For example, in the CRTLIB prompt heading, Create Library (CRTLIB), the words Create Library would be specified as the prompt text in this PROMPT parameter. Note: Prompt text for each of the parameters in this command can be specified in the PROMPT parameters of the PARM, ELEM, and QUAL command definition statements. They specify the prompt text for the parameters, just as the PROMPT parameter in the CMD statement specifies the prompt text for the command (in the heading). *NONE: No prompt text is included in the displayed heading of the prompt when the command is being prompted. message-identifier: Specify the message identifier that specifies the message, containing no more than 30 characters, for the prompt text that is shown when the command is being prompted. If a message having the specified identifier cannot be found in the message file specified in the PMTFILE parameter of the Create Command (CRTCMD) command, the message identifier itself is used as the prompt text. prompt-text: Specify the prompt text that is displayed during the command prompting. It must be a character string of no more than 30 characters, enclosed in apostrophes. Note: Variables cannot be coded for this parameter.
206
CMD (Command)
Example: CMD statement v Creating user-defined commands on page 205 v Command definition statement descriptions on page 206 v DEP (dependent) statement v ELEM (element) statement on page 210 v PARM (Parameter) statement on page 227 v PMTCTL (Prompt Control) statement on page 247 v QUAL (Qualifier) statement on page 249
Example: CMD statement

CMD PROMPT(UCD0001)
This statement describes a command that is prompted with additional text in the display heading; the prompt text comes from the message identified by UCD0001.
DEP (dependent) statement

The Dependent (DEP) statement defines a required relationship between parameters and parameter values that must be checked. This relationship can refer to either the specific value of a parameter or parameters or to the required presence of parameters. If a parameter has a default value and the parameter is not specified, the checking differs depending on whether the DEP statement is performing a specification check or a relational check. If a specification check is made on an unspecified parameter (checking for the presence of a value for that parameter), the system assumes that no value was specified, and the default value is not used. If a relational check is made on an unspecified parameter, the default value is used as the parameter value. The following syntax diagram shows the syntax for the DEP definition statement.
DEP CTL ( *ALWAYS (1) keyword-name (1) &keyword-name relational-operator value (2) &keyword-name )
(1) PARM ( keyword-name (
(1) (1) &keyword-name relational-operator value (2) &keyword-name )
(3) )
NBRTRUE
*ALL relational-operator
number-true
MSGID
*NONE message-identifier
Notes: 1 Must not be defined as TYPE(*NULL).

207
DEP (Dependent)
2 3 Must not be defined as TYPE(*NULL) or PASSVAL(*NULL). A maximum of 25 repetitions
CTL Parameter Specifies the controlling conditions that must be true before the parameter dependencies defined in the PARM statement must be true. The first keyword specified identifies the controlling parameter. The controlling condition can be specified either by a keyword name only or by a keyword name and a test relationship that determines whether the controlling condition requires the presence of the parameters it is dependent upon. The relationship between the controlling parameter and a specified value can be tested to determine whether the condition specified is met. If it is, the parameters that the controlling parameter is dependent upon must meet the requirements specified in the PARM and NBRTRUE statements. *ALWAYS: The parameter dependency is always checked, regardless of the form of the command. keyword-name: Specify the keyword name of the parameter for which a value must be specified to control dependency. The keyword name is the name of the parameter that is specified by the KWD parameter on the PARM statement defining it. If the keyword is specified, the parameter dependency is checked. The keyword must not be defined as TYPE(*NULL). &keyword-name relational-operator value: Specify the keyword name of the controlling parameter followed by a relational operator (such as *LE or *EQ) and a value to be tested. If the tested condition is met, the parameters that the controlling parameter is dependent upon must meet the requirements specified in the PARM statement. The value must be no longer than 32 characters. The keyword must not be defined as TYPE(*NULL). If the value being tested against has been specified as a special value or single value (SPCVAL or SNGVAL parameters of the PARM statement), the to-value must be used rather than the from-value. The keyword name must be preceded by an ampersand (&) to indicate that the value of the keyword is tested if the relational operator and value are specified; the ampersand must not be used if the relational operator and value are not specified. If the controlling parameter is a qualified name, the first qualifier will be used for the compare value. If the controlling parameter is a list, then the first element of the list will be used for the compare value. If the first element is a list, then the first element of that list is used, and so on. (&keyword-name relational-operator &keyword-name): Specify the keyword name of the controlling parameter followed by a relational operator (such as *EQ) and the keyword name of another parameter whose value is compared with the value of the controlling parameter. The keywords must not be defined as TYPE(*NULL) or with PASSVAL(*NULL) specified. PARM Parameter Specifies the parameter dependencies that must be tested if the controlling conditions defined by the CTL parameter are true. The dependencies can be one or all of the following:
208
DEP (Dependent)
v The names of one or more parameters that will be tested to determine if they are present. v One or more test relationships of keyword values to the values of other keywords or constants. A maximum of 25 parameters can be specified for the PARM parameter. Keywords specified in this parameter must not be defined as TYPE(*NULL). keyword-name: Specify the keyword name of each parameter that must have a value specified for it. &keyword-name relational-operator value: Specify the keyword name of each parameter followed by a relational operator and a value to be tested. An ampersand must precede the keyword name to indicate that the value of the keyword is tested. The value specification must be no longer than 32 characters. If the value being used for testing comparison has been specified as a special value or single value (SPCVAL or SNGVAL parameters of the PARM statement), the to-value must be used rather than the from-value. If the controlling parameter is a qualified name, the first qualifier will be used for the compare value. If the controlling parameter is a list, then the first element of the list will be used for the compare value. If the first element is a list, then the first element of that list is used, and so on. &keyword-name relational-operator &keyword-name: Specify the keyword name of one parameter followed by a relational operator and the keyword name of another parameter whose value is compared with the value of the first parameter. A keyword defined with PASSVAL(*NULL) cannot be specified. NBRTRUE Parameter Specifies the number of parameter dependencies defined in the associated PARM statement that must be true to satisfy the control condition. *ALL: All the parameter dependencies specified in the PARM statement must be true to satisfy the control condition. relational-operator number-true: Specify a relational operator and a number that specifies the number of parameter dependencies that must be true to satisfy the specified relation. For example, if (*EQ 2) is specified for NBRTRUE, then two, and only two, of the parameter dependencies must be true for the PARM statement. Note: Variables cannot be coded for this parameter. MSGID Parameter Specifies the message identifier of an error message in a message file that is sent to the user if all the specified parameter dependencies have not been satisfied. *NONE: No special message is sent. Instead, a message generated by the command analyzer is sent to the user. message-identifier: Specify the message identifier of the error message sent to the user if all the dependencies for this statement are not met. Messages whose identifiers begin with the 3-character prefixes CPF or CPD are retrieved from the IBM-supplied message file QCPFMSG. All other messages specified here
209
DEP (Dependent)
are retrieved from the message file identified by the MSGF parameter on the CRTCMD command which is used to create the command being defined with these dependencies. Note: Variables cannot be coded for this parameter. For more information about command definition statements, see the following: v Creating user-defined commands on page 205 v Command definition statement descriptions on page 206 For more information about specific command definition statements, see the following: v CMD (command) statement on page 206 v ELEM (element) statement v PARM (Parameter) statement on page 227 v PMTCTL (Prompt Control) statement on page 247 v QUAL (Qualifier) statement on page 249 Example: DEP statement
Example: DEP statement

DEP CTL(&TYPE *EQ LIST) PARM(ELEMLIST)
If TYPE(LIST) is specified, the ELEMLIST parameter must be specified.

DEP CTL(FILE) PARM(VOL LABEL) NBRTRUE(*EQ 2)
If the FILE parameter is specified, both the VOL and LABEL parameters must be specified.
DEP CTL(GLOOP) PARM(J1 D J2) NBRTRUE(*EQ 1)
If the GLOOP parameter is specified, a value must be specified for one (and only one) of the J1, D, and J2 parameters.
DEP CTL(&LIB *EQ MYLIB) PARM((&PASSWORD *eq XYZ5) (&USRPRF *EQ B0BJ)) NBRTRUE(*GE 1) MSGID(MSG001)
If the LIB parameter equals MYLIB, then the PASSWORD parameter must equal XYZ5, or the USRPRF parameter must equal BOBJ. Otherwise, message MSG001 will be sent to the user.
ELEM (element) statement

Element (ELEM) statements are used to define the elements of a mixed list (list elements) parameter on a command. A list parameter is a parameter that accepts multiple values that are passed together as consecutive values pointed to by a single keyword. The values are preceded by a 2-byte binary value that indicates the number of elements defined for the parameter. CL programs do not support binary values in variables, but you can use the %BINARY built-in function to examine the length. A list element is the value that represents one value among a group of values organized in a specific order in a list. If all of the list elements are not of the same type, one ELEM statement must be used for each element that appears in the list being defined. If all the elements are of the same type (a simple list), individual
210
ELEM (Element)
ELEM statements are not required. For a simple list, specify the number of elements in the list on the MAX parameter of the PARM statement. The order in which the ELEM statements are entered into the source file determines the position of the elements in the list. The first ELEM statement (for the first list element) must have a statement label that matches TYPE (statement-label) on the PARM or ELEM statements for the same list. The remaining ELEM statements in the list must be unlabeled. Lists of elements having different values can be nested to the depth of three levels including the highest level. A maximum of 300 elements can be included in one list. Note: The ELEM statement contains certain parameters and predefined values that can be used only when an IBM-supplied command processing program (CPP) is called by the command being defined. Because there are limitations in some high-level languages, these values may not be useful in the definition statements of user-defined commands. If the entire parameter is for IBM-supplied commands only, these parameters and values are identified by placing the phrase, (For IBM-supplied commands) immediately following the parameter keyword or the predefined value to which it applies. | The following syntax diagram shows the syntax for the ELEM definition statement.
ELEM TYPE( *DEC *LGL *CHAR *NAME *SNAME *CNAME *PNAME *GENERIC *DATE *TIME *HEX *ZEROELEM *INT2 *INT4 *UNIT2 *UNIT4 *VARNAME statement-label )
LEN(
length length
) decimal-positions
CONSTANT(
value
RSTD(
*NO *YES
DFT( )
value
211
ELEM (Element)
(1) VALUES( value ) REL( relational-operator RANGE(
&keyword-name ) value &from-keyword-value &to-keyword-value lower-limit-value upper-limit-value
(1) SPCVAL( ( from-value to-value ) )
(1) SNGVAL( ( from-value to-value ) )
MIN(
0 minimum-number
MAX(
1 maximum-number
ALWUNPRT(
*YES *NO
ALWVAR(
*YES *NO
PGM(
*NO *YES
DTAARA(
*NO *YES
FILE(
*NO *IN *OUT *UPD *INOUT *UNSPFD
FULL(
*NO *YES
EXPR(
*NO *YES
*NO (2) VARY( *YES *INT2 *INT4 PASSATR( )
*NO *YES
212
ELEM (Element)
*MONO (3) CASE( *MIXED ) DSPINPUT( *YES *PROMPT *NO
CHOICE(
*VALUES *NONE *PGM message-identifier 'choices-text'
*NONE *LIBL/ CHOICEPGM( *CURLIB/ program-name library-name/ )
PROMPT(
*NONE message-identifier 'prompt-text'
Notes: 1 2 A maximum of 300 repetitions *YES is valid only for the following parameter types: *CHAR, *NAME, *SNAME, *CNAME, *PNAME, *GENERIC, *LGL, *VARNAME, *CMD, *CMDSTR, and *X. This value can be specified only for *CHAR and *PNAME parameter types.
TYPE Parameter Specifies the type of list element being defined. The element can be an integer, a decimal or logical value, or a quoted or unquoted character string that can be a name, label, date, or time. Enter one of the following values to specify the type of element. Note: For more information on names (below), see Chapter 11. Object naming rules on page 181. *NAME: The list element is a character string that represents a basic name. The maximum length of the name is 256 characters; the first character must be A-Z, $, @, or #. The remaining characters can be the same as the first character but can also include the numbers 0 through 9, underscores (_), and periods (.). The name can also be a string of characters starting and ending with double quotation marks (). If a special value is used (as in *LIBL or *NONE), it must be specified in the SPCVAL parameter. *SNAME: The list element is a character string that represents a simple name. The maximum length of the name is 256 characters; the first character must be A-Z, $, @, or #. The remaining characters can be the same as the first but may
213
ELEM (Element)
also include the numbers 0 through 9 and underscores (_). Periods (.) are not allowed. If a special value is used (such as *LIBL or *NONE), it must be specified in the SPCVAL parameter. *CNAME: The list element is a character string that represents a communications name. The maximum length of the name is 256 characters; the first character must be A-Z, $, @, or #. The remaining characters can be the same as the first character but may also include the numbers 0 through 9. Periods (.) and underscores (_) are not allowed. If a special value is used (such as *LIBL or *NONE), it must be specified in the SPCVAL parameter. *PNAME: The list element is a character string that represents a path name. The path name can be enclosed in apostrophes. If the path name contains any special characters (not including an asterisk (*)), it must be enclosed in apostrophes. The maximum length of the path name character string is 5000 characters. Path names are used in the integrated file system. See the information in the Integrated File System section for more information on using the list element *PNAME. *GENERIC: The list element is a character string that represents a generic name. A generic name contains a maximum of 255 characters followed by an asterisk (*) or 256 characters without an asterisk and must conform to the rules for generic names. The name identifies a group of objects whose names all begin with the characters preceding the *. If an * is not included, the system assumes that the generic name is a complete object name. *DATE: The list element is a character string that represents a date. When entering the command, the year may be specified in either 2 digits or 4 digits. If a 2-digit year is specified, the date is assumed to be in the range of January 1, 1940 through December 31, 2039. If a 4-digit year is specified, the date may be in the range of August 24, 1928 through May 9, 2071. When the date is passed to the CPP, it is always passed in the format Cyymmdd, where C = century, yy = year, mm = month, and dd = day. The century digit is set to 0 for years 19xx, and it is set to 1 (one) for years 20xx. When a date value is specified in this ELEM statement, it must be specified without quotation marks in one of the following formats: mmddyy, mmddyyyy, or Cyymmdd. If the user enters a date when the command is run, it must be entered in the job date format. The job date separator specifies the optional separator character that must be used when the date is entered. If the separator character is used, the date must be enclosed in apostrophes. *TIME: The list element is a character string that represents a time. It is in the format hhmmss, where hh = hours, mm = minutes, and ss = seconds. It is passed to the CPP in a 6-byte character string as hhmmss. Values specified in this statement must be in the format hhmmss. The job time separator specifies the optional separator character that can be used when the time is entered. If the separator character is used, the time must be enclosed in apostrophes. *CHAR: The list element is a character string that optionally can be enclosed in apostrophes. If the character string contains any special characters (not including an asterisk (*)), it must be enclosed in apostrophes. The maximum length of the character string is 5000 characters. *DEC: The list element is a packed decimal number.
214
ELEM (Element)
*LGL: The list element is a logical value, either a one (1) or a zero (0). *HEX: The list element value is in hexadecimal form. The specified characters must be 0 through F. They are converted to hexadecimal (EBCDIC) characters (2 hex digits per byte), right justified, and padded with zeros. If the value is enclosed in apostrophes, an even number of digits is required. If the value is not enclosed in apostrophes, the number of digits may be odd or even. *ZEROELEM: The list element is always considered to be a list of zero elements for which no value can be specified in the command. It is used to prevent a value from being entered as an element in a list even though the CPP expects one. An element for which *ZEROELEM is specified is not prompted, although the other elements in the parameter are prompted and are passed to the CPP as a list. *INT2: The list element is an integer that is passed as a 2-byte signed binary number. CL programs do not support using binary values in variables. *INT4: The list element is an integer that is passed as a 4-byte signed binary number. CL programs do not support using binary values in variables. | | | | *UINT2: The list element is an integer that is passed as a 2-byte unsigned binary number. CL programs do not support using binary values in variables. *UINT4: The list element is an integer that is passed as a 4-byte unsigned binary number. CL programs do not support using binary values in variables. *VARNAME: (For IBM-supplied commands) The list element is a variable name that is passed as a character string. The name can contain a maximum of 11 characters, including the initial ampersand (&). statement-label: Specify a qualified name or a mixed list of values. The statement label specified here by the TYPE parameter is the statement label that identifies the first of a series of QUAL or ELEM statements that further describe the qualified name or the mixed list being defined. The label must be the same as the label specified by TYPE(statement-label) on the PARM statement for this list. | | | | | | | | | | | | | | | | LEN Parameter Specifies the length of the list element value that is passed to the CPP. If TYPE was specified as *INT2, *INT4, *UINT2, *UINT4, *DATE, *TIME, *ZEROELEM, or statement-label, LEN is not allowed. If TYPE(*DEC) was specified, the decimal length is specified in the form (n1 n2), where n1 specifies the total number of digits in the value (including the decimal portion), and n2 specifies the number of allowable decimal digits to the right of the decimal point. The value for n2 is optional, and zero is assumed if n2 is not entered. If TYPE is other than *DEC, the decimal portion (n2) must be omitted and only the number of characters must be specified.
Table 12. Lengths of Data Types That Can Be Coded Data Type Default Length *DEC *LGL *CHAR *NAME *SNAME (15 5) 1 32 10 10 Maximum Length1 (24 9) 1 5000 256 256
215
ELEM (Element)
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |
Table 12. Lengths of Data Types That Can Be Coded (continued) Data Type Default Length Maximum Length1 *CNAME *PNAME *GENERIC *HEX *VARNAME Note:
1
10 32 10 1 11
256 5000 256 256 11
The maximum length shown here is the maximum length allowed by the Command Definition. The high-level language used as the CPP for the command may have different maximum lengths for these data types (for example, *DEC values in CL programs have a maximum length of (15 9)). Whereas the maximum shown here is the maximum for the values used in the command when it is run, the maximum length of character constants specified in the command definition is limited to 32 characters. This restriction applies to the following parameters: CONSTANT, DFT, VALUES, REL, RANGE, SPCVAL, and SNGVAL.
For data types whose length cannot be coded, the following are the maximum lengths and the lengths passed.
Table 13. Lengths of Data Types That Cannot Be Coded Data Type Maximum Length *DATE1 *TIME2 *ZEROELEM *INT23 *INT44 *UINT25 *UINT46 statement-label5 Note:
1 2 3
Length Passed 7 6 0 2 4 2 4 _
8 8 0 6 11 6 11 _
If a date is specified, the value is passed as 7 characters. If a time is specified, the value is passed as 6 characters. The value must meet the following condition: -215 < value < 215-1. The value is passed as a 2-byte signed binary number. The value must meet the following condition: -231 < value < 231-1. The value is passed as a 4-byte signed binary number. The value must meet the following condition: 0< value < 216-1. The value is passed as a 2-byte unsigned binary number. The value must meet the following condition: 0 < value < 232-1. The value is passed as a 4-byte unsigned binary number. The length of the data accepted and passed is defined by the ELEM or QUAL statement that the label identifies.
CONSTANT Parameter Specifies that a value is passed to the CPP as a constant for the list element when the command being defined is processed. The value does not appear externally on the command. If specified, the value must satisfy the
216
ELEM (Element)
requirements specified by the TYPE, LEN, VALUES, REL, RANGE, SPCVAL, and FULL parameters. As noted in the LEN parameter chart, if a character constant is specified in this parameter, it can be no longer than 32 characters. CONSTANT is not valid with TYPE(*ZEROELEM), EXPR(*YES), or MAX(>1), or if DFT was coded for ELEM. If a constant is specified for the element being defined, no prompt text can be specified for the PROMPT parameter of this ELEM statement. However, the other elements of the list parameter (of which this list element is a part) are still prompted, and their values (along with this constant value) are still passed to the CPP as a list. Variables cannot be coded for this parameter. RSTD Parameter Specifies whether the value entered for the list element (specified in the ELEM statement) is restricted to only one of the values given in the VALUES, SPCVAL, or SNGVAL parameters, or whether the value can be any value that satisfies the requirements specified by the TYPE, LEN, REL, RANGE, SPCVAL, SNGVAL, and FULL parameters. *NO: The value entered for the list element defined by this ELEM statement can be anything that matches the requirements specified by the TYPE, LEN, REL, RANGE, SPCVAL, SNGVAL, and FULL parameters in this ELEM statement. *YES: The value entered for the list element in this ELEM statement is restricted to one of the values in the VALUES parameter, or to one of the from-values in the SPCVAL or SNGVAL parameter. *YES cannot be specified if TYPE(statement-label) or TYPE(*ZEROELEM) is specified. DFT Parameter Specifies the default value that is assigned to the list element. That is, the default value is used as the value of the list element if the user omits the parameter that represents this list element, or specifies *N for the element, while coding or entering the command. The default value must satisfy one of the following: v It must match the element requirements specified by the TYPE, LEN, REL, RANGE, and FULL parameters. v It must be one of the from-values in the SPCVAL or SNGVAL parameters. v If the default is a character constant, it can have no more than 32 characters (as noted in the LEN parameter chart). v If RSTD(*YES) is specified, it must be in the list of values in the VALUES parameter or in the list of from-values of the SPCVAL or SNGVAL parameters. v If this ELEM statement itself defines a list, the default value must be specified in the SNGVAL parameter. The DFT parameter is valid only if MIN is 0, which means the element defined by this ELEM statement for this list is optional. The DFT parameter is not valid if the CONSTANT parameter is specified. A default cannot be specified if TYPE(*ZEROELEM) is specified; in that case, an assumed default is passed. If DFT is not specified, the default assumed is as follows, depending on the specified element type:
217
ELEM (Element)
Assumed Default Element Types *DEC *INT2 *INT4 *UINT2 *UINT4 *ZEROELEM *LGL *DATE *TIME *HEX *CHAR *NAME *SNAME *CNAME *PNAME *GENERIC *VARNAME
| |
0 0 zeros blanks
An assumed default value is not displayed by the command prompt; a blank input field is shown instead. If a default is specified in the DFT parameter, it is displayed by the prompt exactly as specified. value: Specify the default value that meets the specified requirements or that is one of the values specified in the SPCVAL, SNGVAL, or VALUES parameters. Variables cannot be coded for this value. VALUES Parameter Specifies a list of up to 300 constants (fixed values) from which one constant can be specified as the value of the list element. The VALUES parameter is valid only if all of the following are true: RSTD(*YES) is specified, both RANGE and REL are not specified, and each constant matches the attributes specified by the TYPE, LEN, and FULL parameters in this ELEM statement. As noted in the LEN parameter chart, character constants specified in this parameter can be no longer than 32 characters. Enter the constants (not more than 300) that can be specified as the value of the list element. The VALUES parameter is not valid for TYPE(statement-label) or for TYPE(*ZEROELEM). If this ELEM statement is defining the first element in a list, the value specified for this parameter cannot be the same as the value specified in the SNGVAL parameter on either the PARM or ELEM statement that points to this ELEM statement. REL Parameter Specifies the relationship between the list element value and the value of another parameter or constant. The value associated with the referenced keyword, not the user-specified value, is passed to the CPP. To specify the relationship, enter one of the following relational operators followed by a constant or the value of another parameter. *LT *LE *EQ *GE *GT *NL *NE *NG less than less than or equal to equal to greater than or equal to greater than not less than not equal to not greater than
218
ELEM (Element)
The REL parameter is not valid if TYPE is specified as *LGL, *VARNAME, *ZEROELEM, or statement label; or if either RANGE or VALUES is specified. If a character type is specified by TYPE(*CHAR), the EBCDIC value of the character string is used as an unsigned integer in the comparison. As noted in the LEN parameter chart, if a character constant is specified in this parameter, it can be no longer than 32 characters. RANGE Parameter Specifies the range (the limits) for the value of the list element. The list element value must be greater than or equal to the lower limit value specified, and it must be less than or equal to the upper limit value specified. The value tested is the value sent to the CPP, not the user-specified value. For example, 15 would be valid if RANGE was specified as (0 16). For nonnumerical data types, such as *CHAR, the range of values and the data specified will be left-justified and padded on the right with blanks. A numeric range should not be used to define an interval for nonnumerical data unless leading zeros are specified or the data is only 1 character in length. The RANGE parameter is not valid if either REL or VALUES is specified, or if TYPE is specified as *LGL, *VARNAME, *ZEROELEM, or statement label. As noted in the LEN parameter chart, character constants specified in this parameter can be no longer than 32 characters. SPCVAL Parameter Specifies a list of up to 300 entries that define special values that can be entered for the element defined by this ELEM statement. Each entry specifies a character string (a from-value) that can be entered even though it may not meet all validity checking requirements. If the entered character string matches the from-value of one of the entries, and the to-value is specified, the string is replaced with the to-value and is then passed to the CPP without further checking. If the to-value is omitted, the from-value is passed to the CPP. The SPCVAL parameter is not valid for TYPE(statement-label) or for TYPE(*ZEROELEM). If a to-value of *CURLIB is specified, the name of the current job library is passed to the CPP instead of the value *CURLIB. If the from-value is *CURLIB and no to-value is specified, or if the to-value is *CURLIB and it is enclosed in apostrophes, the value *CURLIB is passed to the CPP. The from-value is a character string, but the to-value can be anything that is passable. However, for TYPE(*DATE), the to-value must be specified unquoted in mmddyy, mmddyyyy, or Cyymmdd format. If a CL variable is used for the from-value, its type must be *CHAR. If this ELEM statement is defining the first element in a list, the value specified for the from-value cannot be the same as the value specified in the SNGVAL parameter on either the PARM or ELEM statement that points to this ELEM statement. | | | | | | The to-value must be no longer than LEN specifies. If TYPE is *DEC, *INT2, *INT4, *UINT2, or *UINT4, the type of the to-value must be the same. If TYPE is a character type (such as *CHAR, *LGL, or *DATE), the to-value must be a character string. As noted in the LEN parameter chart, character constants specified in this parameter can be no longer than 32 characters. If a to-value is not specified, the from-value must be passable. Variables cannot be coded for this element.
219
ELEM (Element)
SNGVAL Parameter Specifies a list of up to 300 single values that can be specified for an element being defined as a statement label, or that is to have two or more list elements (defined by the MAX parameter) in its nested list. Any one of the single values can be used instead of a nested list of values or a qualified name that the element is defined to accept. Each entry specifies a character string (a from-value) that can be entered. If an entered character string matches the from-value of one of the entries and the to-value is specified, the data is replaced with the to-value and is then passed to the CPP without further checking. If the to-value is omitted, the from-value is passed to the CPP. If this ELEM statement defines the first element in a list, the value specified for the from-value cannot be the same as the value specified in the SNGVAL parameter on either the PARM or ELEM statement that points to this ELEM statement. The to-value (or the from-value, if the to-value is omitted) must be passable, as specified in the SPCVAL parameter. As noted in the LEN parameter chart, character constants specified in this parameter can be no longer than 32 characters. SNGVAL can be specified only if MAX is greater than one or TYPE is specified as a statement label; it is not valid for TYPE(*ZEROELEM). Each single value can only substitute for a list of values or a qualified name; it cannot be a list element or qualifier. It is passed as the first element of the list. If a to-value of *CURLIB is specified, the name of the current job library is passed to the CPP instead of the value *CURLIB. If the from-value is *CURLIB and no to-value is specified, or if the to-value is *CURLIB and it is enclosed in apostrophes, the value *CURLIB is passed to the CPP. Variables cannot be coded for this element. MIN Parameter Specifies the minimum number of values that must be entered for the list element being defined. For an element that does not allow multiple like values, only zero (0) for optional and one (1) for required can be specified as the minimum number of values. For an element that allows multiple like values because a value greater than one (1) is specified in the MAX parameter, zero (0) indicates that no values must be entered; therefore, it is an optional element. A value equal to or greater than one (1) indicates the minimum number of values that must be entered for the element. Therefore, it is a required element. The value specified for MIN cannot exceed the value specified for the MAX parameter. The number specified tells how many list elements are required in another list. If MIN is not specified, zero (0) is assumed, meaning that the element is optional. 0: The list element is optional; it does not have to be entered. minimum-number: Specify the minimum number of elements that must be specified in the nested list. If 1 is the assigned value, it specifies that at least
220
ELEM (Element)
one value is required for the element. If a number greater than one (1) is specified, the element contains a list that must have at least as many elements as the number specified. MAX Parameter Specifies, if this ELEM statement is defining a simple list element, the maximum number of elements that this list element can have in its nested list. If a value greater than 1 is specified, the element is capable of accepting multiple like values (that is, a simple nested list). All values entered for this element (at the time the command is run) must satisfy the validity checking requirements specified by the values specified in the other parameters on this ELEM statement. Note: The values for a nested list are passed consecutively, preceded by a 2-byte binary value that indicates the number of values entered in the list element by the user. CL programs do not support the handling of binary values in variables, but you can use the %BINARY built-in function to examine the length. 1: The list element accepts only one value; there is no nested list. maximum-number: Specify the maximum number of elements that the list element can accept. The specified maximum must be greater than or equal to the value specified in MIN, and less than or equal to 300. If the maximum is greater than one (1) and TYPE is not a statement label that identifies a QUAL statement or another ELEM statement, the parameterwhich is also an element is a simple list of like values (that is, each element in the list has the same requirements, such as type and length). If TYPE(statement-label) is specified and it points to the label of a QUAL statement or another ELEM statement, MAX should only be specified greater than 1 if a list of lists or a list of qualified names is to be accepted. A maximum greater than one (1) is not valid if the CONSTANT parameter is also specified. ALWUNPRT Parameter Specifies whether this ELEM statement should accept the hexadecimal characters XFF or those in the range of X00 to X3F. This parameter is valid only for TYPE(*CHAR) or TYPE(*X). *YES: Allows any characters to be sent to the display or printer. *NO: Does not allow unprintable characters to be passed to the command processing program. ALWVAR Parameter Specifies whether to allow variable names for the element. If TYPE was specified as *VARNAME, *ZEROELEM, *NULL, or statement-label, ALWVAR(*NO) is not allowed. *YES: Allows the use of variable names for the element. *NO: Does not allow the use of variable names for the element. PGM Parameter Specifies whether the list element is a program name. PGM(*YES) is valid only for a statement-label, *CHAR, *NAME, *SNAME, *CNAME, and *GENERIC types. The specification of the PGM(*YES) parameter has no effect on the element being defined by the ELEM statement; it only indicates to the compiler
221
ELEM (Element)
that the value for this element is a program name. This information is stored so it can be included in the output of the Display Program References (DSPPGMREF) command. *NO: The element defined in this ELEM statement is not a program name. *YES: The element is a program name. DTAARA Parameter Specifies whether the list element is a data area name. DTAARA(*YES) is valid only for statement-label, *CHAR, *NAME, *SNAME, *CNAME, and *GENERIC types. The specification of the DTAARA(*YES) parameter has no effect on the element being defined by the ELEM statement; it only indicates to the CL compiler that the value for this element is a data area. This information is stored so it can be included in the output of the Display Program References (DSPPGMREF) command. *NO: The element defined in this ELEM statement is not a data area name. *YES: The element is a data area name. FILE Parameter Specifies whether the list element is a file name and the expected use of the file. The element can be specified as the name of a file that has a specific use so that, at CL compile time, the names can be used to get file reference information about where the files are used. FILE is valid only if the value for TYPE is statement-label, *CHAR, *NAME, *SNAME, *CNAME, or *GENERIC. The specification in the FILE parameter has no effect on the list element being defined by the ELEM statement; it only indicates to the CL compiler that the value for this element is a file name and what type of file it is. This information is stored so it can be included in the output of the DSPPGMREF (Display Program References) command. One of the following types of files can be specified: *NO: The list element defined in this ELEM statement is not a file name. *IN: The list element is an input file name. *OUT: The list element is an output file name. *UPD: The list element is an update file name. *INOUT: The list element value is the name of a file to be used for both input and output. *UNSPFD: The list element value is the name of a file, but its use cannot be specified. FULL Parameter Specifies whether the number of characters in the list element must be exactly the same as the number specified in the LEN parameter (if specified) or its default length (if LEN is not specified). *NO: The number of characters in the list element can be less than that specified by the LEN parameter.
222
ELEM (Element)
*YES: The number of characters in the list element must equal the number specified by the LEN parameter or the default length for that type. The exact length is valid only for element types *LGL, *CHAR, *NAME, *SNAME, *CNAME, *GENERIC, *VARNAME, and *HEX. EXPR Parameter Specifies whether the list element can accept an expression containing a characters that are combined or linked together (concatenation). Valid character concatenation operators are as follows:
Concatenation Blank insertion with concatenation Blank truncation with concatenation *CAT or, || *BCAT or, |> *TCAT or, |<
*NO: The element value cannot be a concatenation expression. *YES: The element value can be a concatenation expression. *YES is not valid if a value is specified for the CONSTANT parameter. VARY Parameter Specifies whether the list element value passed to the CPP is preceded by a length value that indicates the number of characters entered for the elements value. This parameter may be specified as a single value (*NO) or as a list of two values (elements). *NO: The element value is not preceded by a length value. Element 1: Return Length Value *YES: The element value passed to the CPP is preceded by a field that indicates the number of characters actually specified for the parameter. *YES is valid only for the following parameter types: *CHAR, *NAME, *SNAME, *CNAME, *PNAME, *GENERIC, *LGL, *VARNAME, *CMD, *CMDSTR, and *X. Note: The length value is the actual number of characters entered for the command parameter with trailing blanks removed. The length value passed may be different than the defined parameter length or the declared variable length. The length of the field containing the character string data is determined by the defined length for the parameter or the declared LEN for CL Program variables. The length value defines how many characters in the character string data field were actually entered for the command parameter. Element 2: Value Length | | | | *INT2: The length of the element value is an integer passed as a 2-byte signed binary number. *INT4: The length of the element value is an integer passed as a 4-byte signed binary number. PASSATR Parameter (For IBM-supplied commands) Specifies whether an attribute byte is to be passed to the CPP with the list element data. PASSATR is not valid for TYPE(statement-label) or for TYPE(*ZEROELEM).
223
ELEM (Element)
*NO: No attribute byte is passed with the list element. *YES: An attribute byte is passed with the list element; the attribute byte indicates whether the data value came from the default, the data type of the value, and (if TYPE(*CHAR) was specified) whether the character string was enclosed in apostrophes. CASE Parameter Specifies whether the value that is passed to the CPP is changed from lowercase to uppercase, or is preserved in the case specified on the command parameter. *MONO: The element value is changed from lowercase to uppercase. Single quoted parameters with apostrophes preserve the case whether or not this value is specified. *MIXED: The element value is preserved in the case specified on the command parameter. This value can be specified only for *CHAR and *PNAME parameter types. | | | | | | | | | | | | | | | | | | DSPINPUT Parameter Specifies whether the keyword value is shown (displayed) in the job log or on a prompt display. DSPINPUT(*PROMPT) and DSPINPUT(*NO) are valid only for the following element types: *CHAR, *NAME, *SNAME, *CNAME, *GENERIC, *DEC, *LGL, *INT2, *INT4, *UINT2, *UINT4, *DATE, *TIME, and *HEX. Note: The DSPINPUT parameter will have no effect on the job log entries for a database reader job, for imbedded commands (for example, a command submitted on the SBMJOB command), or for commands executed using the QCMDEXC or QCAEXEC APIs. *YES: The element value is shown both on the prompt screen and in the job log. *PROMPT: The element value is shown on the prompt screen but not in the job log. *NO: The element value is not shown in either the job log or a prompt screen. When a previously entered command is retrieved, the nondisplayed field entries must be retyped and their previous values are not retrievable. When a job log entry is created, the nondisplayed field is replaced by empty parentheses (). CHOICE Parameter Specifies the text that is displayed to the right of the prompt line of each parameter on the prompt screen. Up to 30 characters of text can be displayed. *VALUES: Each possible value is displayed in the possible values field, separated by a comma and a space. If values are specified for the Default, Single value, or Special value parameters, the first value displayed is the default value; the next value is a single value, and the values following that are special values. If there are too many values to fit in 30 characters, the last value is followed by three periods. Examples of possible values text follow:
224
ELEM (Element)
v If *NO is specified on the RSTD parameter and *DEC is specified on the TYPE parameter and the RANGE parameter is not specified, the word Number is displayed in the possible values field. The resulting line will appear in the form: Number, *XXX, *YYY, *ZZZ... v If *NO is specified on the RSTD parameter and *DEC is specified on the TYPE parameter and the RANGE parameter is specified, the range of possible values is displayed in the possible values field. The resulting line will appear in the form: a-b, *XXX, *YYY, *ZZZ (where a and b are numerals defining the range). v If *YES is specified on the RSTD parameter, the possible values displayed are determined by the VALUES parameter, the SNGVAL parameter, and the SPCVAL parameter. The resulting line will appear in the form: *XXX, *YYY, *ZZZ... *NONE: No values are displayed. *PGM: A program that is called determines the values that are displayed. The program that is called is identified in CHOICEPGM parameter. message-identifier: Specify the message ID of the message used to retrieve the message containing the text for the possible values field. The message file specified on the PMTFILE parameter of the Create Command (CRTCMD) command is used to find the message. choices-text: Specify no more than 30 characters, enclosed in apostrophes. CHOICEPGM Parameter Specifies the name of the program that is called during the prompting to fill in the possible choices text and the permissible values during prompting. This parameter must be specified only if CHOICE(*PGM) is specified. *NONE: No program is identified to fill in the possible choices text and permissible values. The possible library values are: *LIBL: The library list is used to locate the program name. *CURLIB: The current library for the job is used to locate the program name. 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 where the program name is located. program-name: Specify the name of the program to be called during prompting to fill in the possible choices text or to supply a permissible value. If any exception occurs when the program is called, no possible-choices text will be left blank, and the list of permissible values will be obtained from the command. PROMPT Parameter Specifies the prompt text, if any, that is used for the list element being defined in this ELEM statement. The prompt text describes the element to the user, who may enter a response to the information displayed. Prompt text cannot be specified if TYPE(*ZEROELEM) is specified or if a constant value is specified in the CONSTANT parameter.
225
ELEM (Element)
*NONE: No prompt text is displayed for the list element defined by this ELEM statement. The input field still asks for this list element, but no text is displayed with it. message-identifier: Specify the message identifier that identifies the prompt text message of up to 30 characters displayed when the program is asking for the list element. If a message having the specified identifier cannot be found in the message file contained in the PMTFILE parameter of the Create Command (CRTCMD) command, the message identifier itself is used as the prompt text. prompt-text: Specify the prompt text displayed when the program is asking for the list element. The text must be a character string of no more than 30 characters, enclosed in apostrophes. See the Example: ELEM statement, for more information. v Creating user-defined commands on page 205 v Command definition statement descriptions on page 206 v v v v v CMD (command) statement on page 206 DEP (dependent) statement on page 207 PARM (Parameter) statement on page 227 PMTCTL (Prompt Control) statement on page 247 QUAL (Qualifier) statement on page 249
Example: ELEM statement

Example 1: Defining a JOBDESC Parameter Job: B,I
JOBDESC( job-name number )
Command definition statements:

L1: PARM KWD(JOBDESC) TYPE(L1) ELEM TYPE(*NAME) MIN(1) ELEM TYPE(*DEC) LEN(2) MIN(1) REL(*LE 60)
The parameter named JOBDESC can be omitted, but, if present, it must be a list of two elements. The first element is a name, and the second is a 2-digit number that is less than or equal to 60. Example 2: Defining a RANGE Parameter Job: B,I
*SAME RANGE( lower-value upper-value )
226
ELEM (Element)
PARM KWD(RANGE) SNGVAL((*SAME ELEM TYPE(*DEC) ELEM TYPE(*DEC) TYPE(L1) DFT(*SAME) + 101)) MIN(1) REL(*LE 100) MIN(1) REL(*LE 100)
L1:
The parameter named RANGE can be omitted, but, if present, it must be a list of two numbers, neither of which can be greater than 100. Validity checking is performed to determine that the lower-limit value is less than the upper-limit value. To allow the CPP to determine whether the value passed is a user-specified value or the default, *SAME is mapped to 101.
PARM (Parameter) statement

The Parameter (PARM) statement defines a parameter of a command being created. A parameter is the means by which a value is passed to the command processing program (CPP). One PARM statement must be used for each parameter that appears in the command being defined. The order in which the PARM statements are entered into the source file determines the order in which the parameters must be specified when the command is entered in positional form and the order in which they are passed to the validity checker and to the CPP. A maximum of 75 parameters can be defined for one command. Note, however, that commands having a large number of parameters take longer to run, regardless of how many parameters are actually coded. Note: The PARM statement contains certain parameters and predefined values that can be used only when IBM-supplied CPPs are called by the command being defined. Limitations in some high-level languages reduce the usefulness of these values in the definition statements of user-defined commands. These parameters and values are identified by the phrase (For IBM-supplied commands) that immediately follows the parameter keyword (if the entire parameter is for IBM-supplied commands only) or the predefined value to which it applies. The following syntax diagram shows the syntax for the PARM definition statement.
PARM KWD ( keyword-name ) TYPE ( *DEC *LGL *CHAR *NAME *SNAME *CNAME *PNAME *GENERIC *CMDSTR *DATE *TIME *HEX *ZEROELEM *X *INT2 *INT4 *UNIT2 *UNIT4 *VARNAME *CMD *NULL statement-label )
227
PARM (Parameter)
LEN ( length1 length2/length1 length3/length2/length1 ) RTNVAL ( *NO *YES
CONSTANT(value) RSTD(
*NO *YES
DFT( )
value
(1) VALUES( value REL(relational-operator RANGE(
) &keyword-name ) value &from-keyword-value &to-keyword-value lower-limit-value upper-limit-value
(1) SPCVAL( ( from-value to-value ) )
(1) SNGVAL( ( from-value to-value ) )
MIN(
0 minimum-number
MAX(
1 maximum-number
ALWUNPRT(
*YES *NO
ALWVAR(
*YES *NO
PGM(
*NO *YES
DTAARA(
*NO *YES
FILE(
*NO *IN *OUT *UPD *INOUT *UNSPFD
FULL(
*NO *YES
EXPR(
*NO *YES
228
PARM (Parameter)
*NO (2) VARY( *YES *INT2 *INT4 PASSATR( ) *NO *YES
PASSVAL(
*DFT *NULL
*MONO ) CASE( *MIXED (3) )
LISTDSPL(
*INT2 *INT4
DSPINPUT(
*YES *PROMPT *NO
CHOICE(
*NONE *LIBL/ CHOICEPGM( *CURLIB/ library-name/ program-name )
PMTCTL(
*NONE *PMTRQS statement-label
*NONE *LIBL/ PMTCTLPGM( *CURLIB/ library-name/ program-name )
KEYPARM(
*NO *YES
PROMPT(
relative-prompt-number
229
PARM (Parameter)
Notes: 1 2 A maximum of 300 repetitions *YES is valid only for the following parameter types: *CHAR, *NAME, *SNAME, *CNAME, *PNAME, *GENERIC, *LGL, *VARNAME, *CMD, *CMDSTR, and *X. *YES must be specified if PASSATR(*YES) and RTNVAL(*YES) are specified. This value can be specified only on *CHAR and *PNAME parameter types.
KWD Parameter Specifies the keyword name of the parameter being created. The keyword identifies the parameter in the command, and it is used when the parameter is entered in keyword form. Enter the keyword name using no more than 10 alphanumeric characters, the first character being alphabetic. TYPE Parameter Specifies the type of value being defined. The value can be an integer, a decimal or logical value, or a quoted or unquoted character string that can be a name, label, date, or time. Enter one of the following values to specify the type of parameter. Note: For more information on names (below), see Rules for Specifying Names in chapter 2. *NAME: The parameter value is a character string that represents a basic name. The maximum length of the name is 256 characters; the first character must A-Z, $, @, or #. The remaining characters can be the same as the first character but can also include the numbers 0 through 9, underscores (_), and periods (.). The name can also be a string of characters starting and ending with double quotation marks (). If a special value is used (as in *LIBL or *NONE), it must be specified in the SPCVAL parameter. *SNAME: The parameter value element is a character string that represents a simple name. The maximum length of the name is 256 characters; the first character must be A-Z, $, @, or #. The remaining characters can be the same as the first but may also include the numbers 0 through 9 and underscores (_). Periods (.) are not allowed. If a special value is used (such as *LIBL or *NONE), it must be specified in the SPCVAL parameter. *CNAME: The parameter value is a character string that represents a communications name. The maximum length of the name is 256 characters; the first character must be A-Z, $, @, or #. The remaining characters can be the same as the first character but may also include the numbers 0 through 9. Periods (.) and underscores (_) are not allowed. If a special value is used (such as *LIBL or *NONE), it must be specified in the SPCVAL parameter. *PNAME: The parameter value is a character string that represents a path name. The path name can be enclosed in apostrophes. If the path name contains any special characters (not including an asterisk (*)), it must be enclosed in apostrophes. The maximum length of the path name character string is 5000 characters. Path names are used in the integrated file system. For more information on using the parameter value *PNAME, see the Integrated File System book.
230
PARM (Parameter)
*GENERIC: The parameter value is a character string that represents a generic name. A generic name contains a maximum of 255 characters followed by an asterisk (*) or 256 characters without an asterisk and must conform to the rules for generic names. The name identifies a group of objects whose names all begin with the characters preceding the *. If an * is not included, the system assumes that the generic name is a complete object name. *CMDSTR: The parameter value is a command string that is checked for validity by the command analyzer. It is passed to the CPP as a character string. | | | | | | | | The command analyzer rebuilds the command string when it checks it for validity. When the command is rebuilt, keywords are added to parameters that were specified positionally, parameters can be reordered, and parameters that contain characters that cannot be printed (XFF and X00 - X3F) are converted to hexadecimal notation. As a result, the rebuilt command string may be substantially longer than the original command string. If the length of the rebuilt command is longer than the allowed length specified with the LEN keyword, the command will fail. Note: Selective prompting is not allowed with the *CMDSTR parameter. *DATE: The parameter value is a character string that represents a date. When entering the command, the year may be specified with either 2 digits or 4 digits. If a 2-digit year is specified, the date is assumed to be in the range of January 1, 1940 through December 31, 2039. If a 4-digit year is specified, the date may be in the range of August 24, 1928 through May 9, 2071. When it is passed to the CPP, it is always passed in the format Cyymmdd, where C = century, yy = year, mm = month, and dd = day. The century digit is set to 0 for years 19xx, and it is set to 1 (one) for years 20xx. When a date value is specified in this PARM statement, it must be specified in one of the following formats: mmddyy, mmddyyyy, or Cyymmdd. When a user enters a date in the command at run time, it must be entered in the job date format. The job date separator specifies the optional separator character that can be used when the date is entered. If the separator character is used, the date must be enclosed in apostrophes. *TIME: The parameter value is a character string that represents a time. It is entered in the format hhmmss. It is passed to the CPP in a 6-byte character string as hhmmss. The job time separator specifies the optional separator character that can be used when the time is entered. If the separator character is used, the time must be enclosed in apostrophes. *CHAR: The parameter value is a character string that (optionally) can be enclosed in apostrophes. If the character string contains any special characters (not including an asterisk (*)), it must be enclosed in apostrophes. The maximum length of the character string is 5000 characters. *DEC: The parameter value is a packed decimal number. *LGL: The parameter value is a logical value, either a one (1) or a zero (0). *HEX: The parameter value is in hexadecimal form. The specified characters must be 0 through F. They are converted to hexadecimal (EBCDIC) characters (2 hex digits per byte), right-justified, and padded on the left with zeros. If the value is enclosed in apostrophes, an even number of digits is required. If the value is not enclosed in apostrophes, an even number of digits is not required.
231
PARM (Parameter)
*ZEROELEM: The parameter is always considered as a list of zero elements, for which no value can be specified in the command. It is used to prevent a value from being entered for a parameter that is a list even though the CPP expects one. For example, if two commands use the same CPP, one command could pass a list for a parameter and the other command may not have any values to pass. The second command would be coded with TYPE(*ZEROELEM). *X: (For IBM-supplied commands) The parameter value is a character string, variable name, or numeric value. The value is passed as a numeric value if it contains only digits, a + or sign, and/or a decimal point; otherwise, it is passed as a character string. *INT2: The parameter value is an integer that is passed as a 2-byte signed binary number. CL programs do not support binary values in variables. *INT4: The parameter value is an integer that is passed as a 2-byte unsigned binary number. CL programs do not support binary values in variables. | | | | *UINT2: The parameter value is an integer that is passed as a 2-byte signed binary number. CL programs do not support binary values in variables. *UINT4: The parameter value is an integer that is passed as a 4-byte unsigned binary number. CL programs do not support binary values in variables. *VARNAME: (For IBM-supplied commands) The parameter value is a CL variable name that is passed as a character string. The name can contain a maximum of 11 characters, including the ampersand (&). *CMD: (For IBM-supplied commands) The parameter value is a command. For example, the IF command has a parameter called THEN whose value must be another command. The command is checked for validity by the command analyzer. *NULL: The parameter value is to be a null pointer, which can be used as a constant place holder. A DEP statement or the REL and RANGE keywords of other PARM statements may not reference the value of a parameter defined with TYPE(*NULL). statement-label: Specify a qualified name or a mixed list of values. The statement label specified here by the TYPE parameter is the statement label that identifies the first of a series of QUAL or ELEM statements that further describe the qualified name or the mixed list being defined by this PARM statement. | | | | | | | | | LEN Parameter Specifies the length of the parameter value that is passed to the CPP. LEN is not allowed if TYPE was specified as *INT2, *INT4, *DATE, *TIME, *CMD, *ZEROELEM, *NULL, or statement-label. With other TYPE specifications, this parameter has the following applications: v If TYPE(*DEC) was specified, the decimal length is specified in the form (length1 length2), where length1 specifies the total number of digits in the value (including the decimal portion), and length2 specifies the number of allowable decimal digits to the right of the decimal point. (The value for length2 is optional. Zero is assumed if it is not entered.)
232
PARM (Parameter)
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | v If TYPE(*CHAR), TYPE(*NAME), TYPE(*SNAME), TYPE(*CNAME), TYPE(*CMDSTR), or TYPE(*VARNAME) was specified, only length1 is specified. It identifies the number of characters passed. v If TYPE(*HEX) was specified, only length1 is specified. This length specifies the number of characters passed after the hexadecimal digits have been converted to character digits. Because 2 hexadecimal digits are converted to 1 decimal digit, the number of hexadecimal digits converted is twice the value of this length. v If TYPE(*X) was specified, the LEN parameter is used as follows: For character data, length1 specifies the minimum length to be passed. If a longer value is entered, the entire value is passed. For decimal data, length2 and length3 specify the length and decimal positions for a constant value. If a variable is entered, it is passed according to the variable attributes. For a logical value, length1 specifies the length of the value, which is always 1. The default length that is assumed by the system and the maximum length for each type of parameter value are shown in the following table:
Data Type *DEC *LGL *CHAR *NAME *SNAME *CNAME *PNAME *GENERIC *HEX *X *VARNAME *CMDSTR Note:
1
Default Length (15 5) 1 32 10 10 10 32 10 1 (1 15 5) 11 256
Maximum Length1 (24 9) 1 5000 256 256 256 5000 256 256 (256 24 9) 11 20,000
The maximum length shown here is the maximum length allowed by the Command Definition. The high-level language used as the CPP for the command may have different maximum lengths for these data types (for example, *DEC values in CL programs have a maximum length of (15 9)). Whereas the maximum shown here is the maximum for the values used in the command when it is run, the maximum length of character constants specified in the command definition is limited to 32 characters. This restriction applies to the following parameters: CONSTANT, DFT, VALUES, REL, RANGE, SPCVAL, and SNGVAL.
For data types for which length cannot be coded, the following are the maximum lengths and the lengths passed.
Data Type *DATE1 *TIME2 *ZEROELEM Maximum Length 8 8 0 Length Passed 7 6 0
233
PARM (Parameter)
| | | | | | | | | | | | | | | | | | | | | | | | | | | |
Data Type *INT23 *INT44 *UINT25 *UINT46 *CMD statement-label5 Note:
1 2 3
Maximum Length 6 11 6 11 Any _
Length Passed 2 4 2 4 Length needed _
If a date is specified, the value is passed as 7 characters. If a time is specified, the value is passed as 6 characters. The value is passed as a 2-byte signed binary number and must meet the following condition: -215 < or = value < or = 215-1 The value is passed as a 4-byte signed binary number and must meet the following condition: -231 < or = value < or = 231-1 The value is passed as a2byte unsigned binary number and must meet the following condition: 0 < < or = value < or = 216-1 The value is passed as a 4-byte signed binary number and must meet the following condition: 0 < < or = value < or = 232-1 The length of the data accepted and passed is defined by the ELEM or QUAL statement that the label identifies.
RTNVAL Parameter Specifies whether a value is returned by the CPP through the parameter being defined in this PARM statement. *NO: No value can be returned in the parameter being defined. The parameter is an input parameter only. *YES: A value is to be returned by the CPP in the parameter. A CL variable name must be specified for the parameter to receive the value (when the command is called). If a variable name is not specified when the command is invoked, a null pointer is passed to the CPP. v *YES is valid only if the TYPE parameter was specified as *DEC, *CHAR, *LGL, or *X. Also, *YES is valid only on commands that are limited to CL programs. v *YES is not valid with MAX(>1), CONSTANT, DFT, RSTD, VALUES, REL, RANGE, SPCVAL, SNGVAL, FILE, FULL, EXPR, or ALWVAR(*NO). v RTNVAL(*YES) can be specified if *BPGM, *IPGM, *BREXX, or *IREXX is specified in the CRTCMD command that uses the source file containing this PARM statement. v VARY(*YES) must be specified if PASSATR(*YES) and RTNVAL(*YES) have been specified. CONSTANT Parameter Specifies that a value is passed to the CPP as a constant when the command being defined is processed. The parameter does not appear externally on the
234
PARM (Parameter)
command. The value specified in this parameter (if any) must satisfy the requirements specified by the TYPE, LEN, VALUES, REL, RANGE, SPCVAL, and FULL parameters. As noted in the LEN parameter chart, if a character constant is specified in this parameter, it can be no longer than 32 characters. If a constant is specified for the parameter being defined, no prompt text can be specified for the PROMPT parameter in the PARM statement, because the parameter will not be prompted. The CONSTANT parameter is not valid with TYPE(*CMD), TYPE(*NULL), TYPE(*ZEROELEM), MAX(>1), DFT, RTNVAL(*YES), or EXPR(*YES). Variables cannot be coded for this parameter. RSTD Parameter Specifies whether the value entered for the parameter (specified in the PARM statement) is restricted to only one of the values given in the VALUES, SPCVAL, or SNGVAL parameters, or whether the value can be any value that satisfies the requirements specified by the TYPE, LEN, REL, RANGE, SPCVAL, SNGVAL, and FULL parameters. *NO: The value entered for the parameter specified by KWD in this PARM statement can be anything that matches the requirement specified by parameters TYPE, LEN, REL, RANGE, SPCVAL, SNGVAL and FULL in this PARM statement. *YES: The value entered for the parameter specified by KWD in this PARM statement is restricted to one of the values in the VALUES parameter, or to one of the from-values in the SPCVAL or SNGVAL parameters. *YES cannot be specified if TYPE(statement-label), TYPE(*CMD), TYPE(*NULL), TYPE(*ZEROELEM), TYPE(*X), or RTNVAL(*YES) is specified. DFT Parameter Specifies the default value that is assigned to the parameter if a value is not specified by the user. That is, the default value is used as the value of the parameter if the user omits the parameter while entering the command or if *N is entered as the parameter value. The default value must satisfy one of the following: v It must match the requirements specified by the TYPE, LEN, REL, RANGE, and FULL parameters. v It must be one of the from-values in the SPCVAL or SNGVAL parameters. v If the default is a character constant, it can have no more than 32 characters (as noted in the LEN parameter chart). v If RSTD(*YES) is specified, it must be in the list of values in the VALUES parameter or in the list of from-values of the SPCVAL or SNGVAL parameters. v It must be a from-value in the SNGVAL parameter if the parameter being defined is a list of unlike values or it is a qualified name. This is true when a statement label is specified for TYPE; the label is used to identify a QUAL or ELEM statement. The DFT parameter is not valid if CONSTANT is specified. The DFT parameter is valid only if MIN is 0, which means the parameter named in the KWD parameter is optional. A default cannot be specified if RTNVAL(*YES) is specified; instead, a null pointer is passed for the default. A default cannot be specified if TYPE(*CMD), TYPE(*ZEROELEM), or TYPE(*NULL) is specified. If
235
PARM (Parameter)
TYPE(*VARNAME) is specified, a default special value can be specified; a default variable name cannot be specified. If DFT is not specified and MIN(0) and RTNVAL(*NO) are specified, then the default assumed is as follows, depending on the specified type: Assumed Default | 0 Parameter Types *DEC *INT2 *INT4 *ZEROELEM 0 zeros blanks *LGL *DATE *TIME *HEX *CHAR *NAME *SNAME *CNAME *PNAME *GENERIC *VARNAME *CMDSTR null *CMD *X *NULL
An assumed default value is not displayed by the command prompt; a blank input field is shown instead. If a default is specified in the DFT parameter, it is displayed by the prompt exactly as specified. value: Specify the default value that meets the specified requirements or that is one of the values specified in the VALUES, SPCVAL, or SNGVAL parameters. Variables cannot be coded for this value. VALUES Parameter Specifies a list of up to 300 constants (fixed values) from which one constant can be entered as the value of the parameter named in the KWD parameter. The VALUES parameter is valid only if all of the following are true: RSTD(*YES) is specified, both the RANGE and REL parameters are not specified, and each constant matches the attributes specified by the TYPE, LEN, and FULL parameters. As noted in the LEN parameter chart, character constants specified in this parameter can be no longer than 32 characters. Enter the constants (not more than 300) that can be specified as the value of the parameter. The VALUES parameter is not valid if TYPE(*CMD), TYPE(*CMDSTR), TYPE(*X), TYPE(*NULL), TYPE(statement-label), TYPE(*VARNAME), or TYPE(*ZEROELEM), or if RTNVAL(*YES) is specified. REL Parameter Specifies the relationship between the parameter value of this parameter and the value of a constant or another parameter. If a keyword is specified, it must be preceded by an ampersand (&) to indicate that it is the value of the keyword that is to be tested. The value associated with the referenced keyword, not the user-specified value, is the value passed to the CPP. If the relationship is with another parameter whose value is a list of values or a qualified name, only the first value is used in the comparison. To specify the relationship, enter one of the following relational operators followed by either a constant or the keyword name (KWD) of the other parameter (which must be preceded by an &). *LT *LE less than less than or equal to
236
PARM (Parameter)
*EQ *GE *GT *NL *NE *NG equal to greater than or equal to greater than not less than not equal to not greater than
The REL parameter is not valid if RTNVAL(*YES) is specified, if either RANGE or VALUES is specified, or if TYPE is specified as *LGL, *VARNAME, *CMD, *CMDSTR, *X, *ZEROELEM, *NULL, or a statement label. If a character type is specified by TYPE(*CHAR), the EBCDIC value of the character string is used as an unsigned integer in the comparison. As noted in the LEN parameter chart, if a character constant is specified in this parameter, it can be no longer than 32 characters. Variables can be coded for this element. RANGE Parameter Specifies the range (the limits) for the value of the parameter. The parameter value must be greater than or equal to the lower limit value specified, and it must be less than or equal to the upper limit value specified. For example, 15 would be valid if RANGE was specified as (0 16). For nonnumeric data types, such as *CHAR, the range of values and the data specified are left-justified and padded on the right with blanks. A numeric range should not be used to define an interval for nonnumeric data unless leading zeros are specified or the data is only 1 character long. Variables can be coded for this element. The upper and lower limits of the range can be specified either by a keyword representing the value or by the value itself. If a keyword is specified, it must be preceded by an ampersand (&) to indicate that the value of the keyword is to be tested. The value of its parameter at the time of the check is used to determine the range. The value that is tested is the value passed to the CPP, not the user-specified value. If the keyword identifies a list of values or a qualified name, only the first value is used as the range limit. A keyword may not reference a parameter that is defined with PASSVAL(*NULL), and RANGE is not valid with PASSVAL(*NULL). The RANGE parameter is not valid if RTNVAL(*YES) is specified, if either REL or VALUES is specified, or if TYPE is specified as *LGL, *VARNAME, *CMD, *CMDSTR, *X, *ZEROELEM, *NULL, or statement label. As noted in the LEN parameter chart, character constants specified in this parameter can be no longer than 32 characters. Variables can be coded for this element. SPCVAL Parameter Specifies a list of up to 300 entries that define special values that can be entered on the parameter named in the KWD parameter. Each entry specifies a character string (a from-value) that can be entered even though it may not meet all validity checking requirements. If the entered character string matches
237
PARM (Parameter)
the from-value of one of the entries, and the to-value is specified, the string is replaced with the to-value and is then passed to the CPP without further checking. If the to-value is omitted, the from-value is passed to the CPP. SPCVAL is not valid if TYPE is specified as *CMD, *CMDSTR, *X, *NULL, statement-label, or *ZEROELEM, or if RTNVAL(*YES) is specified. The from-value is a character string, but the to-value can be anything that is passable. However, for TYPE(*DATE), the to-value must be specified unquoted in mmddyy, mmddyyyy, or Cyymmdd format. If a CL variable is used for the from-value, its type must be *CHAR. The to-value must be no longer than LEN specifies and, if TYPE is *DEC, *INT2, or *INT4, the type of the to-value must be the same; if TYPE is a character type (such as *CHAR, *LGL, or *DATE), the to-value must be a character string. As noted in the LEN parameter chart, character constants specified in this parameter can be no longer than 32 characters. If a to-value is not specified, the from-value must be passable. If a to-value of *CURLIB is specified, the name of the current job library is passed to the CPP instead of the value *CURLIB. If the from-value is *CURLIB and no to-value is specified, or if the to-value is *CURLIB and it is enclosed in apostrophes, the value *CURLIB is passed to the CPP. Variables cannot be coded for this element. SNGVAL Parameter Specifies a list of up to 300 single values that can be specified for a parameter being defined as a mixed list or as a qualified name (when a statement label is specified for TYPE), or specifies that it is to accept two or more values as defined by the MAX parameter. Any one of the single values can be used instead of a list of values or a qualified name that the parameter is defined to accept. Each entry specifies a character string (a from-value) that can be entered. If an entered character string matches the from-value of one of the entries and the to-value is specified, the data is replaced with the to-value and is passed to the CPP without further checking. If the to-value is omitted, the from-value is passed to the CPP. The to-value (or the from-value, if the to-value is omitted) must be passable, as specified in the SPCVAL parameter. As noted in the LEN parameter chart, character constants specified in this parameter can be no longer than 32 characters. SNGVAL can be specified only if the MAX parameter is greater than 1 or TYPE is specified as a statement label of a QUAL or ELEM statement. Each single value can only substitute for a list of values or a qualified name; it cannot be a list element or qualifier. It is passed as the first and only element of the list. SNGVAL is not valid if RTNVAL(*YES) is specified or if TYPE is specified as *CMD, *CMDSTR, *NULL, *ZEROELEM, or *X. If a to-value of *CURLIB is specified, the name of the current job library, instead of the value *CURLIB, is passed to the CPP. If the from-value is *CURLIB and no to-value is specified, or if the to-value is *CURLIB and it is enclosed in apostrophes, the value *CURLIB is passed to the CPP. Variables cannot be coded for this element. MIN Parameter Specifies the minimum number of values that must be entered for the parameter being defined.
238
PARM (Parameter)
For a parameter that does not allow multiple like values, only zero (0) for optional and 1 for required can be specified as the minimum number of values. Note: Required parameter statements must precede optional statements. If required parameter statements are not specified first, the system assumes that the specified parameter is optional, and the minimum number of values for required parameters is ignored. For a parameter that allows multiple like values (because a value greater than 1 is specified for the MAX parameter), zero (0) indicates that no values need be entered; therefore, it is an optional parameter. A value equal to or greater than one (1) indicates the minimum number of values that must be entered for the parameter; therefore, it is a required parameter. The value exceeds the value specified for the MAX parameter and cannot exceed 1 for TYPE(*NULL). 0: The parameter is optional; it does not have to be entered. minimum-number: Specify the minimum number of elements that must be specified for this parameter (named by the KWD parameter). If 1 is the assigned value, it specifies that at least one value is required for the parameter. If a number greater than 1 is specified, the parameter is a list that must have at least as many elements as the number specified. MAX Parameter Specifies, if this PARM statement is defining a simple list parameter, the maximum number of list elements that this list parameter can contain. If a value greater than 1 is specified, the parameter is capable of accepting multiple like values (that is, a simple list). This support is primarily intended for IBM-supplied commands. All values entered for this parameter (at the time the command is run) must satisfy the validity checking requirements specified by the other parameter values on this PARM statement. Note: The values for a list parameter are passed consecutively, preceded by a 2-byte binary value that indicates the number of values entered in the parameter by the user. CL programs do not support the handling of binary values in variables. 1: The parameter accepts only one value; the parameter is not a list parameter. maximum-number: Specify the maximum number of elements that the list parameter can accept. The specified maximum must be greater than or equal to the value specified in MIN, and less than or equal to 300. If the maximum is greater than 1 and TYPE is not a statement label that identifies a QUAL or ELEM statement, the parameter is a simple list of like elements (that is, each element in the list has the same requirements, such as type and length). If TYPE(statement-label) is specified and it points to the label of an ELEM or QUAL statement, MAX should only be specified greater than 1 if a list of lists or a list of qualified names is accepted. A maximum greater than 1 is not valid if TYPE is specified as *CMD, *CMDSTR, or *NULL, or if RTNVAL(*YES) or CONSTANT is specified. ALWUNPRT Parameter Specifies whether this PARM statement accepts the hexadecimal characters XFF or those in the range of X00 to X3F. This parameter is valid only for TYPE(*CHAR) or TYPE(*X).
239
PARM (Parameter)
*YES: Any characters can be passed to the CPP and sent to the display or printer. *NO: Unprintable characters cannot be passed to the CPP. ALWVAR Parameter Specifies whether to allow variable names for the parameter. If TYPE was specified as *VARNAME, *ZEROELEM, *NULL, or statement-label, ALWVAR(*NO) is not allowed. *YES: Variable names can be used for the parameter. *NO: Variable names cannot be used for the parameter. PGM Parameter Specifies whether this parameter element is a program name. PGM(*YES) is valid only for statement-label, *CHAR, *NAME, *SNAME, *CNAME, and *GENERIC types. The specification of the PGM(*YES) parameter does not have any effect on the parameter element being defined by the PARM statement; it only indicates to the compiler that the value for this parameter is a program name. This information is stored so it can be included in the output of the Display Program References (DSPPGMREF) command. *NO: The parameter defined in this PARM statement is not a program name. *YES: The parameter defined in this PARM statement is a program name. DTAARA Parameter Specifies whether the parameter is a data area name. DTAARA(*YES) is valid only for statement-label, *CHAR, *NAME, *SNAME, *CNAME, and *GENERIC types. The specification of the DTAARA(*YES) parameter does not have any effect on the parameter being defined by the PARM statement; it only indicates to the compiler that the value for this parameter is a data area. This information is stored so it can be included in the output of the Display Program References (DSPPGMREF) command. *NO: The parameter defined in this PARM statement is not a data area name. *YES: The parameter defined in this PARM statement is a data area name. FILE Parameter Specifies whether the parameter is a file name and the expected use of the file. The parameter can be specified as the name of a file that has a specific use so that, at compile time, the names can be used to get file reference information about where the files are used. The specification in the FILE parameter does not have any effect on the operation of the parameter being defined; it only indicates to the compiler that the value for this parameter is a file name and what type of file it is. This information is stored so it can be included in the output of the Display Program References (DSPPGMREF) command. The FILE parameter is valid only if *CHAR, *NAME, *SNAME, *CNAME, *GENERIC, or statement-label is specified for the TYPE parameter. The FILE parameter is not valid with RTNVAL(*YES). One of the following types of files can be specified: *NO: The parameter (named by KWD) is not a file name. *IN: The parameter value is an input file name. *OUT: The parameter value is an output file name.
240
PARM (Parameter)
*UPD: The parameter value is an update file name. *INOUT: The parameter value is the name of a file that is used for both input and output. *UNSPFD: The parameter value is the name of a file, but its use cannot be specified. The use of the file must match the type of file specified. For example, if *IN is specified, the file can be used only for input; if *UPD is specified, it can be used only to update existing records. FULL Parameter Specifies whether the number of characters in the parameter must be exactly the same as the number specified in the LEN parameter (if specified) or its default length (if LEN is not specified). *NO: The number of characters in the parameter can be less than that specified by the LEN parameter. *YES: The number of characters in the parameter must equal the number specified by LEN or the default length for that type. The exact length is valid only for the following parameter types: *LGL, *CHAR, *NAME, *SNAME, *CNAME, *GENERIC, *VARNAME, and *HEX. FULL(*YES) is valid with RTNVAL(*YES). EXPR Parameter Specifies whether the parameter named in the KWD parameter can accept an expression containing a character concatenation or a built-in function (%SUBSTRING or %BIN). Valid character concatenation operators are as follows:
Restrictions: Expressions are not allowed on parameters where the TYPE parameter specifies *CMDSTR, *CMD, *ZEROELEM, *NULL, or statement-label. *NO: The parameter value cannot be a concatenation expression or a built-in function. *YES: The parameter value can be a concatenation expression or a built-in function. VARY Parameter Specifies whether the value that is passed to the CPP is preceded by a length value that indicates the number of characters entered for the command parameter. The length value is the actual number of characters entered for the command parameters with trailing blanks removed. The length value passed may be different than the defined parameter length or the declared variable length. The length of the field containing the character string data is determined by the defined length for the parameter or the declared LEN for CL program variables. The length value defines how many characters in the character string
241
PARM (Parameter)
data field were actually entered for the command parameter. This parameter may be specified as a single value (*NO) or as a list of two values (elements). *NO: The parameter value is not preceded by a length value. Element 1: Return Length Value: *YES: The parameter value passed to the CPP is preceded by a field that indicates the number of characters actually specified for the parameter. Note: *YES is valid only for the following parameter types: *CHAR, *NAME, *SNAME, *CNAME, *PNAME, *GENERIC, *LGL, *VARNAME, *CMD, *CMDSTR, and *X. *YES must be specified if PASSATR(*YES) and RTNVAL(*YES) are specified. Element 2: Value Length: | *INT2: The length of the parameter value is an integer passed as a 2-byte signed binary number. *INT4: The length of the parameter value is an integer passed as a 4-byte signed binary number. PASSATR Parameter (For IBM-supplied commands) Specifies whether an attribute byte is to be passed to the CPP with the parameter data. *NO: No attribute byte is passed with the parameter. *YES: An attribute byte is passed with the parameter; the attribute byte indicates whether the data value came from the default, the data type of the value, and, if TYPE(*CHAR) was specified, whether the character string was enclosed in apostrophes. PASSVAL Parameter Specifies whether a value is to be passed to the command processing program for this parameter. *NULL is not valid if the parameter is a constant parameter (a parameter in which a value has been specified for the CONSTANT parameter on the PARM statement, a parameter for which TYPE(*ZEROELEM) or TYPE(*NULL) has been specified, or is a list/qualified name defined by all constant ELEM or QUAL statements). *NULL also is not valid if RTNVAL(*YES) has been specified or if the value specified for the MIN parameter is greater than zero. A DEP statement or the REL and RANGE keywords of other PARM statements may not reference the value of a parameter defined with PASSVAL(*NULL). *DFT: The default value is always passed to the CPP. *NULL: A null pointer is passed to the CPP if the parameter is not specified. CASE Parameter Specifies whether the value that is passed to the CPP is changed from lowercase to uppercase, or is preserved in the case specified on the command parameter.
242
PARM (Parameter)
*MONO: The parameter value is changed from lowercase to uppercase. Parameters with apostrophes preserve the case whether or not this value is specified. *MIXED: The parameter value is preserved in the case specified on the command parameter. This value can be specified only on *CHAR and *PNAME parameter types. LISTDSPL Parameter Specifies whether the displacement to a list within a list is 2-bytes or 4-bytes long. These displacements are generated when a parameter being passed to a CPP has a list within a list. This parameter is ignored if the value being built for the CPP does not contain a list within a list. *INT2: The displacement value is an integer passed as a 2-byte signed binary number. *INT4: The displacement value is an integer passed as a 4-byte signed binary number. | | | | | | | | | | | | | | | | DSPINPUT Parameter Specifies whether the keyword value is shown in the job log or on a prompt display. DSPINPUT(*PROMPT) and DSPINPUT(*NO) are valid for the following parameter types: *CHAR, *NAME, *SNAME, *CNAME, *GENERIC, *DEC, *LGL, *INT2, *INT4, *DATE, *TIME, *HEX, and *CMDSTR. Note: The DSPINPUT parameter has no effect on the job log entries for a database reader job, for imbedded commands (for example, a command submitted on the SBMJOB command), or for commands executed using the QCMDEXC or QCAEXEC APIs. *YES: The parameter value is displayed on the prompt display and in the job log. *PROMPT: The parameter value is displayed on the prompt display but not in the job log. *NO: The parameter value is shown in neither the job log or a prompt display. When a previously entered command is retrieved, the nondisplay field entries must be retyped (their previous values are not retrievable). When a job log entry is created, the nondisplay field is replaced by empty parentheses (). CHOICE Parameter Specifies the text that is displayed to the right of the prompt line of each parameter on the prompt screen. Up to 30 characters of text can be displayed. *VALUES: Each possible value is displayed in the possible values field, separated by a comma and a space. If values are specified for the Default, Single value, or Special value parameters, the first value displayed is the default value; the next value is a single value, and the values following that are special values. If there are too many values to fit in 30 characters, the last value is followed by three periods. Examples of possible values text follow: v If *NO is specified on the RSTD parameter and *DEC is specified on the TYPE parameter and the RANGE parameter is not specified, the word
243
PARM (Parameter)
RANGE is displayed in the possible values field. The resulting line will appear in the form: RANGE, *XXX, *YYY, *ZZZ... v If *NO is specified on the RSTD parameter and *DEC is specified on the TYPE parameter and the RANGE parameter is specified, the range of possible values is displayed in the possible values field. The resulting line will appear in the form: a-b, *XXX, *YYY, *ZZZ (where a and b are numerals defining the range). v If *YES is specified on the RSTD parameter, the possible values displayed are determined by the VALUES parameter, the SNGVAL parameter, and the SPCVAL parameter. The resulting line will appear in the form: *XXX, *YYY, *ZZZ... *NONE: No values are displayed. *PGM: A program that is called determines the values that are displayed. The program that is called is identified in CHOICEPGM parameter. message-identifier: Specify the message ID of the message used to retrieve the message containing the text for the possible values field. The message file specified on the PMTFILE parameter of the Create Command (CRTCMD) command is used to find the message. choices-text: Specify no more than 30 characters, enclosed in apostrophes. CHOICEPGM Parameter Specifies the qualified name of the program that is called during the prompting to fill in the possible choices text and the permissible values during prompting. This parameter must be specified if CHOICE(*PGM) is specified, and it may not be specified otherwise. *NONE: No program is identified to fill in the possible choices text and permissible values. The possible library values are: *LIBL: The library list is used to locate the program name. *CURLIB: The current library for the job is used to locate the program name. 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 where the program name is located. program-name: Specify the name of the program called during prompting to fill in the possible choices text or a permissible value. If an exception occurs when the program is called, no possible choices text will be left blank, and the list of permissible values will be taken from the command. PMTCTL Parameter Specifies how prompting is controlled for this parameter. Prompting may be conditioned by another parameter, specified by a PMTCTL statement referred to by label in this parameter, or called for by pressing the F10 key. *NONE: Specifies that this parameter is always prompted, unless it is omitted due to selective prompting. *PMTRQS: Specifies that this parameter is not prompted unless:
244
PARM (Parameter)
v The user requests additional parameters. v A value was entered for the parameter before the prompt was called. statement-label: Specifies the label of the PMTCTL statement that is used to determine whether this parameter is prompted. The parameter is not prompted unless: v The conditions specified on the referred to PMTCTL statement have been met. v A value was entered for the parameter before the prompt was called. PMTCTLPGM Parameter Specifies the qualified name of the program called to convert the value specified for the parameter into a value used on a PMTCTL statement. This parameter is valid only on parameters that are referred to in the CTL parameter of a PMTCTL statement. *NONE: There is no program to convert the parameter value for prompt control statements. If the parameter is specified in a PMTCTL statement, the actual value is compared in the PMTCTL statement. The possible library values are: *LIBL: The library list is used to locate the program name. *CURLIB: The current library for the job is used to locate the program name. 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 where the program name is located. program-name: Specifies the qualified name of the program called to convert the parameter value. KEYPARM Parameter Specifies whether the parameter is a key parameter. Key parameters can be used only if a prompt override program is specified on the PMTOVRPGM parameter of the CRTCMD or CHGCMD commands. The prompt override program overrides the command processing program (CPP) by showing only the key parameters on the initial prompt display. Values must be input for these parameters before the remaining parameters are shown. The remaining parameters are shown on the prompt display with the actual values, instead of *SAME or *PRV. *NO: The parameter is not a key parameter. *YES: The parameter is a key parameter. The following rules are followed if *YES is specified: 1. Key parameters must be placed before non-key parameters in the command definition statement. 2. Key parameters appear on the prompt display in the same order as they appear in the command definition statement. 3. Key parameters are valid only if a prompt override program is specified on the PMTOVRPGM parameter of the CRTCMD or CHGCMD commands; if a prompt override program is not specified, the key parameters are treated as non-key parameters, and a warning message is issued. 4. Key parameters must not be the only parameters in the command definition statement; if they are, a warning message is sent.
245
PARM (Parameter)
PROMPT Parameter Specifies the prompt text, if any, that is used for the parameter named by the KWD parameter. The prompt text further describes the keyword and input field to the user, who may enter a response to the information displayed. For example, the prompt text for the TYPE parameter on the Create Library (CRTLIB) command is: Library type When the prompt for the command is displayed, the prompt for the TYPE parameter is: Library type . . . . . . . . . .*PROD The underscored field is the prompt input field where the user enters the value for the TYPE parameter. When the prompt is displayed, the prompt input field contains the default value (*PROD in this example). Prompt text cannot be specified if TYPE(*ZEROELEM) or TYPE(*NULL) is specified or if a constant value is specified in the CONSTANT parameter. *NONE: No prompt text is displayed for the parameter defined by this PARM statement. This parameter is still asked for by its keyword name, but no text is displayed with it. message-identifier relative-prompt-number: Specify the message identifier that specifies the message that contains the prompt text of up to 30 characters that is displayed when the parameter is prompted. If a message having the specified identifier cannot be found in the message file specified in the PMTFILE parameter of the Create Command (CRTCMD) command, the message identifier itself is used as the prompt text. Optionally, a relative prompt number can be specified with the message identifier. The relative prompt number specifies the order in which parameter keywords are to be asked for. This order affects only the order of prompting, not the order in which the parameters are passed to the CPP. Parameters having prompt numbers are asked for before parameters having no prompt numbers. Parameters having no prompt numbers and that do not have PMTCTL(*PMTRQS) coded are asked for before parameters having no prompt numbers and that have PMTCTL(*PMTRQS) coded. prompt-text relative-prompt-number: Specify the prompt text that is displayed when the parameter is prompted. The text must be a character string of no more than 30 characters, enclosed in apostrophes. An optional relative prompt number can be specified with the prompt text, the same as for the message identifier option. Examples: PARM statement on page 247 v Creating user-defined commands on page 205 v Command definition statement descriptions on page 206 v CMD (command) statement on page 206 v DEP (dependent) statement on page 207 v ELEM (element) statement on page 210 v PMTCTL (Prompt Control) statement on page 247 v QUAL (Qualifier) statement on page 249
246
PARM (Parameter)
Examples: PARM statement

PARM KWD(X) TYPE(*DEC) LEN(2) MIN(1) REL(*GT 5)
The value for the parameter named X, a 2-digit decimal number, must be entered. The value must be greater than 5.
PARM KWD(CLASS) TYPE(*CHAR) LEN(1) DFT(A) VALUES(A B C) RSTD(*YES)
The value of the parameter named CLASS must be A, B, or C, if entered. If it is not present, A is assumed.
PARM KWD(MAXREC) TYPE(*DEC) MIN(1) RANGE(&MINREC 999) LEN(3)
The value of the MAXREC parameter must be entered as a decimal number of 3 digits or less, with no digits to the right of the decimal point. The value must be greater than or equal to the value entered for parameter MINREC and also must be less than or equal to 999.
PARM KWD(FILES) TYPE(*NAME) MIN(2) MAX(5)
The FILES parameter is a homogeneous list that contains 2 to 5 names.

PARM KWD(INVFNAME) SNGVAL((*ALL XXX)) FILE(*UPD) MIN(0) PROMPT(USR0002 1) TYPE(*NAME) DFT(*ALL) VALUES(DEPT1 DEPT2 DEPT3) MAX(3) RSTD(*YES)
The value of the parameter named INVFNAME can be a list of up to three file names of which DEPT1, DEPT2, DEPT3, and *ALL are the valid choices. If *ALL is entered, no other values can be entered for the parameter. If this parameter is omitted, file name XXX is passed to the command processing program. If this parameter is entered through the prompt, the prompt text, as stored in the message file, is displayed and *ALL is listed as the default.
PMTCTL (Prompt Control) statement

The Prompt Control (PMTCTL) statement specifies a condition that is tested to determine if prompting is done for the parameters whose PARM statement refers to the PMTCTL statement. The PMTCTL statement (or the first PMTCTL statement if there is more than one) must have a statement label that matches the label referred to in the PMTCTL parameter of one or more PARM statements in the command definition source. The following syntax diagram shows the syntax for the PMTCTL definition statement.
(1)
PMTCTL CTL ( keyword-name ) COND (
*SPCFD *UNSPCFD (relational-operator value )
NBRTRUE(
*ALL relational-operator-number
LGLREL(
*AND *OR
Notes: 1 A maximum of 50 repetitions

247
PMTCTL (Prompt Control)

CTL Parameter Specifies the name of the parameter that controls the prompting. The value of the parameter specified here is compared to the value specified in the COND parameter. If the PMTCTLPGM parameter is coded for the parameter specified here, the value returned by the program specified in the PMTCTLPGM parameter is compared to the values specified in the COND parameter. If the parameter specified here is a list or qualified name, only the first list element or qualifier is compared. COND Parameter Specifies the condition against which the parameter specified in the CTL parameter is tested. Up to 50 conditions can be specified. *SPCFD: The condition is true, including the default value, if it is specified for the control parameter. *UNSPCFD: The condition is true only if the control parameter is not specified. It is not true if the default value is specified. relational-operator value: Specify the relational operator and value used to compare the value of the control parameter to the value specified in the COND parameter. Relational operators are *GT, *EQ, *NL, *LT, *NE, *LE, and *NG. NBRTRUE Parameter Specifies the number of conditions (indicated in the COND parameter) that must be true if the parameter is prompted. *ALL: All the conditions must be true. relational-operator number: Specify the relational operator and number used to compare the number of conditions that are true to the number specified in the NBRTRUE parameter. Relational operators are *GT, *EQ, *NL, *LT, *NE, *LE, and *NG. LGLREL Parameter Specifies, when multiple PMTCTL statements are in a group, the logical relationship of the statement to the previous statements in the group. This parameter is not allowed on the first PMTCTL statement in a group. *AND: This statement is in an AND relationship of the statement to the previous statements in the group. *OR: This statement is in an OR relationship with the previous PMTCTL statement or statements. Statements in an OR relationship are evaluated after AND relationships are evaluated. See the Example: PMTCTL statement on page 249 for additional information. v Creating user-defined commands on page 205 v Command definition statement descriptions on page 206 v CMD (command) statement on page 206 v v v v DEP (dependent) statement on page 207 ELEM (element) statement on page 210 PARM (Parameter) statement on page 227 QUAL (Qualifier) statement on page 249
248
PMTCTL (Prompt Control)
Example: PMTCTL statement

A: PMTCTL CTL(TYPE) COND((*EQ *) (*EQ *LIST)) NBRTRUE(*EQ 1)
If TYPE(*) or TYPE(*LIST) is specified, the parameters which reference this PMTCTL statement are selected for prompting.
B: PMTCTL PMTCTL PMTCTL PMTCTL PMTCTL CTL(P1) CTL(P1) CTL(P2) CTL(P1) CTL(P2) COND((*EQ COND((*EQ COND((*EQ COND((*EQ COND((*NE *ALL)) *SOME)) LGLREL(*OR) *ALL)) LGLREL(*AND) *NONE)) LGLREL(*OR) *ALL)) LGLREL(*AND)
The parameters which refers to this group of PMTCTL statements are selected for prompting if any of the following conditions exist: v *ALL is specified for P1. v *SOME is specified for P1 and *ALL is specified for P2. v *NONE is specified for P1 and *ALL is not specified for P2.
QUAL (Qualifier) statement

The Qualifier (QUAL) statement describes one part of a qualified name. If a name is the allowed value of a parameter or list element defined in a PARM or ELEM statement, it can be changed to a qualified name by using a QUAL statement for each qualifier used to qualify the name. The order in which the QUAL statements are entered into the source file determines the positional order in which the qualifiers must be specified and passed to the validity checker and the command processing program (CPP). The QUAL statement (or only the first QUAL statement if there is more than one) must have a statement label that matches the statement label value that must be specified in a PARM or ELEM statement for which the qualifier is being defined. The qualifiers for the parameter or list element are then entered on the command in the form value3/value2/value1 where values 1 through 3 are qualifiers described by a QUAL statement. Note: In the System/38 environment, the values are passed in sequential order with periods as delimiters. An example of this form is value1.value2.value3. The values are passed with each value padded to its defined length and with the delimiters (slashes or periods) removed. Note: The QUAL statement contains certain parameters and predefined values that can be used only when IBM-supplied CPPs are called by the command being defined. Limitations in some high-level languages reduce the usefulness of these values in the definition statements of user-defined commands. These parameters and values are identified by the phrase (For IBM-supplied commands) that immediately follows the parameter keyword (if the entire parameter is for IBM-supplied commands only) or the predefined value to which it applies. The following syntax diagram shows the syntax for the QUAL definition statement.
249
QUAL
(2) QUAL TYPE( *NAME *SNAME *CNAME *GENERIC *CHAR *INT2 *INT4 *UNIT2 *UNIT4 ) LEN(length) CONSTANT(value)
RSTD(
*NO *YES
DFT(
(1) VALUES value RELrelational-operator-value RANGE lower-limit-valueupper-limit-value
SPCVAL(
from-value (1) from-valueto-value
) ALWUNPRT(
*YES *NO
ALWVAR(
*YES *NO
MIN(
0 1
FULL(
*NO *YES
EXPR(
*NO *YES
VARY(
*NO *YES
PASSATR(
*NO *YES
DSPINPUT(
*YES *PROMPT *NO
CHOICE(
*NONE *LIBL/ CHOICEPGM( *CURLIB/ library-name/ program-name )
250
QUAL
PROMPT(
Notes: 1 2 A maximum of 300 repetitions All parameters preceding this point can be specified in positional form.
TYPE Parameter Specifies the type of qualifier used to qualify a parameter name or list element name. The qualifier can be a name or generic name, a quoted or unquoted character string, or an integer. Enter one of the following options to specify the type of qualifier. The first qualifier for any qualified name must have a type of name (*NAME) or generic name (*GENERIC). *NAME: The qualifier is a character string that represents a name. The maximum length of the name is 256 characters. The first character must be alphabetic (including the special characters $, #, or @), and the remaining characters must be alphanumeric, a period, or an underscore. The name must be a string of characters starting and ending with double quotation marks (). If a special value is used (as in *LIBL or *NONE), it must be specified in the SPCVAL parameter. *SNAME: The qualifier is a character string that represents a name. The maximum length of the name is 256 characters. The first character must be alphabetic (including the special characters $, @, or #), and the remaining characters must be A through Z, 0 through 9, or $, #, or @. Periods (.) are not allowed. If a special value is used (as in *LIBL or *NONE), it should be specified in the SPCVAL parameter. *CNAME: The qualifier is a character string that represents a name. The maximum length of the name is 256 characters. The first character must be alphabetic (including the special characters $, #, or @), and the remaining characters must be A through Z, 0 through 9, $, #, or @. Periods (.) and underscores (__) are not allowed. If a special value is used (as in *LIBL or *NONE), it must be specified in the SPCVAL parameter. *GENERIC: The qualifier is a character string that represents a generic name. A generic name contains a maximum of 255 characters followed by an asterisk (*) or 256 characters without an asterisk. The name identifies a group of objects whose names all begin with the characters preceding the *. If an asterisk (*) is not included, the system assumes that the generic name is a complete object name. *CHAR: The qualifier is a character string that can (optionally) be enclosed in apostrophes. If the character string contains any special characters (not including an asterisk (*)), it must be enclosed in apostrophes. The maximum length of the character string is 5000 characters. *INT2: The qualifier is an integer that is passed as a 2-byte signed binary number. CL programs do not support binary values in variables.
251
QUAL
*INT4: The qualifier is an integer that is passed as a 4-byte signed binary number. CL programs do not support binary values in variables. LEN Parameter Specifies the length of the qualifier, if its data type is *NAME, *GENERIC, or *CHAR. The default length that is assumed by the system and the maximum length for each type of qualifier are shown in the following table:
Data Type *NAME *SNAME *CNAME *GENERIC *CHAR *INT23 *INT44 Note:
1
Default Length 10 10 10 10 32 6 11
Maximum Length1 2562 2562 2562 2562 50002
The maximum length shown here is the maximum length allowed by Command Definition. The high-level language used as the CPP for the command may have a different maximum lengths for these data types (for example, *DEC values in CL programs have a maximum length of (15 9)). Whereas the maximum shown here is the maximum for values used in the command when it is run, the maximum length of character constants specified in the command definition is limited to 32 characters. This restriction applies to the following parameters: CONSTANT, DFT, VALUES, REL, RANGE, and SPCVAL. For *INT2, length cannot be specified; its assumed length is 6. The value must meet the following condition: -215< value < 2 15-1. The value is passed as a 2-byte signed binary number. For *INT4, length cannot be specified; its assumed length is 11. The value must meet the following condition: -231< value < 2 31-1. The value is passed as a 4-byte signed binary number.
CONSTANT Parameter Specifies that a value is passed to the CPP as a constant for the qualifier when the command being defined is processed; the qualifier does not appear externally on the command. If specified, the value must satisfy the requirements specified by the TYPE, LEN, VALUES, REL, RANGE, and SPCVAL parameters. (As noted in the LEN parameter chart, if a character constant is specified in this parameter, it can be no longer than 32 characters.) If a constant is specified in this QUAL statement, and other QUAL statements immediately follow it, they must also be defined as constants, unless a label precedes one of them. A label indicates the beginning of a new group of QUAL statements, which can be defined differently. Also, if a constant is specified for the qualifier being defined, no prompt text can be specified for the PROMPT parameter of this QUAL statement. However, any other qualifiers or groups of qualifiers are still prompted, and their values are still passed to the CPP as a qualified name. The CONSTANT parameter is not valid if the DFT parameter is specified or if *YES is specified on the EXPR parameter. Variables cannot be coded for this parameter.
252
QUAL
RSTD Parameter Specifies whether the value entered for the qualifier is restricted to only one of the values given in the VALUES or SPCVAL parameters, or whether any value can be used that satisfies the requirements specified by the TYPE, LEN, REL, RANGE, and SPCVAL parameters. *NO: The value entered for the qualifier defined by this QUAL statement can be anything that satisfies the requirements specified by the TYPE, LEN, REL, RANGE, and SPCVAL parameters in this QUAL statement. *YES: The value entered for the qualifier defined by this QUAL statement is restricted to one of the values in the VALUES parameter, or to one of the from-values in the SPCVAL parameters. DFT Parameter Specifies the default value assigned to the qualifier if a value is not specified by the user. The default value must satisfy one of the following: v It must match the qualifier requirements specified by the TYPE, LEN, REL, and RANGE parameters. v It must be one of the from-values in the SPCVAL parameter. v If RSTD(*YES) is specified, it must be in the list of values in the VALUES parameter or in the list of from-values in the SPCVAL parameter. v If the default is a character constant, it can have no more than 32 characters as noted in the LEN parameter chart. The DFT parameter is valid only if the MIN parameter is 0, which means the qualifier defined by this QUAL statement for this list is optional. A default is not meaningful on this QUAL statement if it is the first one (defining the first part) for a qualified name and if a default is specified on the PARM or ELEM statement that this QUAL statement further defines. If DFT is not specified, it has a default of its own: a blank ( ) if TYPE was specified as *CHAR, *NAME, *SNAME, *CNAME, or *GENERIC; or a zero (0) if TYPE was specified as *INT2 or *INT4. An assumed default value is not displayed by the command prompt; a blank input field is shown instead. If a default is specified in the DFT parameter, it is displayed by the prompt exactly as specified. The DFT parameter is not valid if the CONSTANT parameter is specified. value: Specify the default value that meets the specified requirements or that is one of the values specified in the SPCVAL or VALUES parameters. Variables cannot be coded for this value. VALUES Parameter Specifies a list of up to 300 constants (fixed values) from which one constant can be entered as the value of the qualifier. The VALUES parameter is valid only if all of the following are true: RSTD(*YES) is specified, both RANGE and REL are not specified, and the constant matches the attributes specified by the TYPE and LEN parameters in this QUAL statement. As noted in the LEN parameter chart, character constants specified in this parameter can be no longer than 32 characters. Enter the constants (not more than 300) that can be specified as the value of the qualifier. REL Parameter Specifies the relationship between the qualifier value and the value of another
253
QUAL
parameter or constant. To specify the relationship, enter one of the following relational operators followed by a constant or the value of another parameter. *LT *LE *EQ *GE *GT *NL *NE *NG less than less than or equal to equal to greater than or equal to greater than not less than not equal to not greater than
The REL parameter is not valid if either RANGE or VALUES is specified. If a character type is specified by TYPE(*CHAR), the EBCDIC value of the character string is used as an unsigned integer in the comparison. As noted in the LEN parameter chart, if a character constant is specified in this parameter, it can be no longer than 32 characters. RANGE Parameter Specifies the range (limits) for the value of the qualifier. The qualifier value must be greater than or equal to the lower limit value specified, and it must be less than or equal to the upper limit value specified. For example, 15 would be valid if the RANGE parameter was specified as (0 16). For nonnumeric data types, such as *CHAR, the range of values and the data specified is left-justified and padded on the right with blanks. A numerical range should not be used to define an interval for nonnumeric data unless leading zeros are specified or the data is only 1 character in length. The RANGE parameter is not valid if either the REL or VALUES parameter is specified. As noted in the LEN parameter chart, character constants specified in this parameter can be no longer than 32 characters. SPCVAL Parameter Specifies a list of up to 300 entries that define special values that can be entered on the parameter named in the KWD parameter on the PARM statement. Each entry specifies a character string (a from-value) that can be entered even though it may not meet all validity checking requirements. If the entered character string matches the from-value of one of the entries, and the to-value is specified, the string is replaced with the to-value and is then passed to the CPP without further checking. If the to-value is omitted, the from-value is passed to the CPP. The from-value is a character string, but the to-value can be anything that is passable. If a CL variable is used for the from-value, its type must be *CHAR. However, the first qualifier can only have special to-values with the from-values that are a name, a generic name, or an asterisk, followed by a name, such as *ALL. Each to-value must be passable to the CPP. The to-value must be no longer than the LEN parameter specifies and, if TYPE is *INT2 or *INT4, the type of the to-value must be the same; if TYPE is a character type (such as *CHAR or *NAME), the to-value must be a character string. As noted in the LEN parameter chart, character constants specified in this parameter can be no longer than 32 characters. If a to-value is not specified, the from-value must be passable.
254
QUAL
If a to-value of *CURLIB is specified, the name of the current job library is passed to the CPP instead of the value *CURLIB. If the from-value is *CURLIB and no to-value is specified, or if the to-value is *CURLIB and it is enclosed in apostrophes, the value *CURLIB is passed to the CPP. Variables cannot be coded for this value. ALWUNPRT Parameter Specifies whether this QUAL statement should accept the hexadecimal characters XFF or those in the range of X00 to X3F. This parameter is valid only for TYPE(*CHAR) or TYPE(*X). *YES: Any characters can be sent to the display or printer. *NO: Unprintable characters cannot be passed to the command processing program. ALWVAR Parameter Specifies whether to allow variable names for the qualifier. If TYPE was specified as *VARNAME, *ZERO, *NULL, or statement-label, ALWVAR(*NO) is not allowed. *YES: Variable names can be used for the qualifier. *NO: Variable names cannot be used for the qualifier. MIN Parameter Specifies whether the qualifier being defined in this QUAL statement is required or optional. If MIN is not specified, 0 is assumed, which means the qualifier is optional. If a required qualified name is needed, MIN(1) must be coded on both the first QUAL statement and on the PARM or ELEM statement that references it. 0: The qualifier is optional on the name being qualified. 1: The qualifier is required on the name being qualified; it must be entered. FULL Parameter Specifies whether the number of characters in the qualifier value must be exactly the same as the number specified in the LEN parameter (if specified) or its default length (if LEN is not specified). *NO: The number of characters in the qualifier value can be less than that specified by the LEN parameter. *YES: The number of characters in the qualifier value must equal the number specified by the LEN parameter or the default length for that type. The exact length is valid only for the *CHAR, *NAME, and *GENERIC qualifier types. EXPR Parameter Specifies whether the qualifier can accept an expression containing a character concatenation. Valid character concatenation operators are as follows:
*NO: The qualifier value cannot be a concatenation expression.

255
QUAL
*YES: The qualifier value can be a concatenation expression. VARY Parameter Specifies whether the qualifier value passed to the CPP is preceded by a length value that indicates the number of characters entered for the qualifiers value. *NO: The qualifier value is not preceded by a length value. *YES: The qualifier value passed to the CPP is preceded by a 2-byte binary length field that indicates the number of characters actually specified for the qualifier. The data is passed in a field of the length specified by LEN or by the default length. *YES is valid only for the following qualifier types: *CHAR, *NAME, *SNAME, *CNAME, or *GENERIC. If a CL variable is specified for this qualifier, the 2-byte binary length field contains the length of the variable value with trailing blanks removed, not the declared length of the CL variable. PASSATR Parameter (For IBM-supplied commands) Specifies whether an attribute byte is to be passed to the CPP with the qualifier. *NO: No attribute byte is passed with the qualifier. *YES: An attribute byte is passed with the qualifier; the attribute byte indicates whether the data value came from the default, the data type of the value, and, if TYPE(*CHAR) was specified, whether the character string was enclosed in apostrophes. DSPINPUT Parameter Specifies whether the keyword value is shown in the job log or on a prompt screen. Note: The DSPINPUT parameter will have no effect on the job log entries for a database reader job, for imbedded commands (for example, a command submitted on the SBMJOB command), or for commands executed using the QCMDEXC or QCAEXEC APIs. *YES: The parameter value is shown on the prompt display and in the job log. *PROMPT: The parameter value is shown on the prompt display but not in the job log. *NO: The parameter value is not shown either in the job log or on a prompt display. When a previously entered command is retrieved, the nondisplay field entries must be retyped (their previous values are not retrievable). When a job log entry is created, the nondisplay field is replaced by empty parentheses (). CHOICE Parameter Specifies the text that is displayed to the right of the prompt line of each parameter on the prompt screen. Up to 30 characters of text can be displayed. *VALUES: Each possible value is displayed in the possible values field, separated by a comma and a space. If values are specified for the Default, Single value, or Special value parameters, the first value displayed is the default value; the next value is a single value, and the values following that are special values. If there are too many values to fit in 30 characters, the last value is followed by three periods. Examples of possible values text follow:
256
QUAL
v If *NO is specified on the RSTD parameter and *DEC is specified on the TYPE parameter and the RANGE parameter is not specified, the word RANGE is displayed in the possible values field. The resulting line will appear in the form: RANGE, *XXX, *YYY, *ZZZ... v If *NO is specified on the RSTD parameter and *DEC is specified on the TYPE parameter and the RANGE parameter is specified, the range of possible values is displayed in the possible values field. The resulting line will appear in the form: a-b, *XXX, *YYY, *ZZZ (where a and b are numerals defining the range). v If *YES is specified on the RSTD parameter, the possible values displayed are determined by the VALUES parameter, the SNGVAL parameter, and the SPCVAL parameter. The resulting line will appear in the form: *XXX, *YYY, *ZZZ... *NONE: No values are displayed. *PGM: A program that is called determines the values that are displayed. The program that is called is identified in CHOICEPGM parameter. message-identifier: Specify the message ID of the message used to retrieve the message containing the text for the possible values field. The message file specified on the PMTFILE parameter of the Create Command (CRTCMD) command is used to find the message. choices-text: Specify no more than 30 characters, enclosed in apostrophes. CHOICEPGM Parameter Specifies the qualified name of the program that is called during the prompting to fill in the possible choices text and the permissible values during prompting. This parameter must be specified if CHOICE(*PGM) is specified, and may not be specified otherwise. *NONE: No program is identified to fill in the possible choices text and permissible values. The possible library values are: *LIBL: The library list is used to locate the program name. *CURLIB: The current library for the job is used to locate the program name. 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 where the program name is located. program-name: Specify the name of the program to be called during prompting to fill in the possible choices text or a permissible value. If an exception occurs when the program is called, no possible choices text is left blank, and the list of permissible values is taken from the command. PROMPT Parameter Specifies the prompt text, if any, that is used for the qualifier (defined in this QUAL statement). The PROMPT parameter is not allowed for the first qualifier or for a qualifier for which the CONSTANT parameter is specified. The prompt text for the first qualifier comes from the PARM or ELEM statement PROMPT parameter that points to the qualifier. The prompt text describes the qualifier input field to the user, who may enter a response to the information displayed.
257
QUAL
*NONE: No prompt text is shown for the qualifier defined by this QUAL statement. This qualifier is still prompted by an input field, but no text is shown with it. message-identifier: Specify the message identifier that specifies the message containing the prompt text of up to 30 characters that is shown. When the program is prompting for the qualifier. If a message having the specified identifier cannot be found in the message file specified in the PMTFILE parameter of the Create Command (CRTCMD) command, the message identifier itself is used as the prompt text. prompt-text: Specify the prompt text that is shown when the program is prompting the qualifier. The text must be a character string of no more than 30 characters, enclosed in apostrophes. Example: QUAL statement Links to the following: v Creating user-defined commands on page 205 v Command definition statement descriptions on page 206 v CMD (command) statement on page 206 v DEP (dependent) statement on page 207 v ELEM (element) statement on page 210 v PARM (Parameter) statement on page 227 v PMTCTL (Prompt Control) statement on page 247
Example: QUAL statement

Example 1: Defining a SPLFILE Parameter Job: B,I
SPLFILE( * file-name job-name user-name/ job-number/ )

L1: Q1: PARM ELEM ELEM QUAL QUAL QUAL KWD(SPLFILE) TYPE(L1) DFT(*) SNGVAL(*) TYPE(*NAME) MIN(1)/*For file name */ TYPE(Q1)/*For job name */ TYPE(*NAME) MIN(1)/*For job name */ TYPE(*NAME)/*For user name */ TYPE(*CHAR) LEN(6)/*For job number */
The SPLFILE parameter is optional and, if not specified, defaults to an asterisk (*). Otherwise, the value consists of a two-element list. The first element is a file name and it is required. The second element is a qualified job name. The first qualifier is required; the last two qualifiers are optional. Example 2: Defining a DTAMBRS Parameter Job: B,I
258
QUAL
*ALL DTAMBRS( *CURLIB/ library-name/ physical-file-name *NONE member-name (1) )

PARM KWD(DTAMBRS) TYPE(L1) DFT(*ALL) MAX(32) + SNGVAL(*ALL) L1: ELEM TYPE(Q1) MIN(1) ELEM TYPE(*NAME) MIN(0) MAX(32) SPCVAL(*NONE) + DFT(*NONE) Q1: QUAL TYPE(*NAME) MIN(1) QUAL TYPE(*NAME) DFT(*CURLIB) SPCVAL(*CURLIB)
The parameter named DTAMBRS is optional and, if not specified, defaults to *ALL. Otherwise, the value consists of a list, each element of which is itself a list. Each sublist consists of a qualified file name optionally followed by one or more member names. If no member name is specified, *NONE is taken as the default. If no library qualifier is specified for the physical file, *CURRENT is taken as the default. This means that the library is the one currently indicated by the qualified physical file name saved in the description of the logical file to which this DTAMBRS parameter applies. Each sublist can contain one file name and up to 32 member names. Up to 32 such sublists can appear as the value of DTAMBRS.
259
QUAL
260
Chapter 16. Parameter values used for testing and debugging

This section contains expanded descriptions of the program variable, basing pointer, subscript, and qualified-name parameter values. These values can be specified on the Add Breakpoint (ADDBKP), Add Trace (ADDTRC), Change High-Level Language Pointer (CHGHLLPTR), Change Program Variable (CHGPGMVAR), and Display Program Variable (DSPPGMVAR) commands.
Program-variable description
Program Variable
(1) qualified-name subscript ,subscript
The program variable must be enclosed in apostrophes if it contains special characters. Up to 132 characters can be specified for a program variable name. This includes any subscripts, embedded blanks, parentheses, and commas. It does not include the enclosing apostrophes when special characters are used. Some examples are:
COUNTA 'VAR1(2,3)' 'A.VAR1(I,3,A.J,1)' 'VAR1 OF A(I,3,J OF A)' '&LIBNAME'
Basing-pointer description
Basing Pointer
(1) qualified-name subscript ,subscript
The basing pointer must be enclosed in apostrophes if it contains special characters. Up to 132 characters can be specified for a basing pointer name. This includes any subscripts, embedded blanks, parentheses, and commas. It does not include the enclosing apostrophes when special characters are used. Some examples are:
PTRVAR1 'ABC.PGMPTR(5,B.I)'
261
Parameter Values Used for Testing and Debugging

If more than one basing pointer is specified for a variable, the list of basing pointers must be enclosed in parentheses. When multiple basing pointers are specified, they must be listed in order, from the first basing pointer to the last, when used to locate the variable. In the example below, the PTR_1 basing pointer is the first basing pointer used to locate the variable; it either must have a declared basing pointer, or it must not be a based variable. The address contained in the PTR_1 pointer is used to locate the A.PTR_2 pointer (which must be declared as a based pointer variable). The contents of the A.PTR_2 pointer are used to locate the PTR_3 pointer array (which must also be declared based), and the contents of the specified element in the last pointer array are used to locate the variable. An example is:
('PTR_1' 'A.PTR_2' 'PTR_3(1,B.J)')
Subscript description
Subscript
integer-number qualified-name *
An integer number contains from 1 through 15 digits with an optional leading sign (either plus or minus). A decimal point is not allowed in an integer-number subscript. If a decimal point is specified, the subscript value is not interpreted as the correct numeric value by the system, and an error message is returned. An asterisk (*) can be used to request a single-dimensional cross-section display of an array program variable. An asterisk can only be specified for a subscript on the primary variable (not on a basing pointer) for the PGMVAR keyword on the Add Break Point (ADDBKP), Add Trace (ADDTRC), and Display Program Variable (DSPPGMVAR) commands. In addition, if the variable has multiple dimensions, only one of the subscript values can be an asterisk. An example of a request to display an array cross-section is:
DSPPGMVAR PGMVAR('X1(*,5,4)')
This display shows the values of all elements of the array that have the second subscript equal to five, and the third subscript equal to four.
Qualified-name description
Qualified-Name
/ODV-number (1) variable OF IN variable
(1) variable
262
Parameter Values Used for Testing and Debugging

Note: Some high-level languages may allow you to declare more than one variable with the same fully qualified name (although you generally are not able to refer to these variables in the high-level language program after they are declared). If you attempt to refer to such a variable using an OS/400 test facility command, the system selects one of the variables and uses it for the operation. No error is reported when a duplicate fully qualified name is selected.
Rules for qualified name description

v An ODV number is a slash (/) followed by 1 to 4 hexadecimal digits (0 through 9, and A through F). v The variable-name must be the name of a variable in the program. This name must be specified the same way in the high-level language. Some high-level languages introduce qualifier variable names in addition to the ones you specified in the source for your program. See the appropriate high-level language manual for more information about variable names. v Blanks must separate the variable-names from the special words OF and IN. v When a period is used to form a qualified name, no blanks can appear between it and the variable-names. v The ordering of the variable names must follow these rules: For qualified names that contain no embedded period, the variable names are assumed to be specified from the lowest to the highest levels in the structure. For qualified names that contain one or more embedded periods, the variable names are assumed to be specified from the highest to the lowest levels in the structure. v When an ODV number is not used for the qualified name, enough qualifier variable names must be specified so that a single unique variable can be identified in the program. Whether the qualified name is a simple name (only one variable name specified) or a name with multiple qualifier variable names, the variable in the program is uniquely identified if either of the following conditions is true (these conditions may require you to specify more qualifier variable names for OS/400 test facility commands than you need to specify in the high-level language program to uniquely select a program variable): A variable is uniquely identified if there is one and only one variable in the program with a set of qualifier variables matching the qualified variable name specified. A variable is uniquely identified in the program if it has exactly the same set of qualifier variables as the qualifier variable names specified. When the complete set of qualifiers is specified, the variable name is said to be fully qualified. A variable that is a fully qualified match for the qualified-name is selected even if there are other variables with names that match the qualified name but have additional qualifier variables which were not specified.
Chapter 16. Parameter values used for testing and debugging
263
264
Printed in U.S.A.

Cllss

Uploaded by

Copyright:

Available Formats

Cllss

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Cllss

Uploaded by

Copyright:

Available Formats

Control Language (CL)

Control Language (CL)

Chapter 8. Command syntax . . . . . 159

Chapter 9. About syntax diagrams

Chapter 5. OS/400 objects . . . . . . 105

Chapter 10. CL character sets and values . . . . . . . . . . . . . . 177

Chapter 6. Command description format . . . . . . . . . . . . . . 115 Chapter 7. Command parts . . . . . 117

Chapter 11. Object naming rules . . . 181

Chapter 15. Command definition statements . . . . . . . . . . . . 205

Example: QUAL statement .

Control Language (CL)

Part 1. Control Language (CL)

Copyright IBM Corp. 2000

Control Language (CL)

Chapter 1. Whats new for V4R5

Control Language (CL)

Chapter 1. Whats new for V4R5

Control Language (CL)

Chapter 1. Whats new for V4R5

Control Language (CL)

Chapter 2. Print this topic

Copyright IBM Corp. 2000

Control Language (CL)

Chapter 3. Monitorable messages

Copyright IBM Corp. 2000

Control Language (CL)

Chapter 4. OS/400 commands

Alphabetical listing of commands

Copyright IBM Corp. 2000

Control Language (CL)

Control Language (CL)

Control Language (CL)

Control Language (CL)

Chapter 4. OS/400 commands

Control Language (CL)

Control Language (CL)

Control Language (CL)

Chapter 4. OS/400 commands

Control Language (CL)

Chapter 4. OS/400 commands

Control Language (CL)

Control Language (CL)

Chapter 4. OS/400 commands

Control Language (CL)

Chapter 4. OS/400 commands

Control Language (CL)

Display Display Display Display Display

Control Language (CL)

End End End End End

Control Language (CL)

Control Language (CL)

Control Language (CL)

Chapter 4. OS/400 commands

Control Language (CL)

Chapter 4. OS/400 commands

Control Language (CL)

Control Language (CL)

Control Language (CL)

Control Language (CL)