z/OS V1R7.0 ISPF Reference Summary

z/OS V1R7.0 ISPF Reference Summary
Interactive System Productivity Facility (ISPF)
Reference Summary
z/OS Version 1 Release 7.0
SC34-4816-04
Interactive System Productivity Facility (ISPF)
Reference Summary
z/OS Version 1 Release 7.0
SC34-4816-04
Note
Before using this document, read the general information under “Notices” on page 175.
Fifth Edition (September 2005)
This edition applies to ISPF for Version 1 Release 7.0 of the licensed program z/OS (program number 5694-A01)
and to all subsequent releases and modifications until otherwise indicated in new editions.
IBM welcomes your comments. A form for comments appears at the back of this publication. If the form has been
removed and you have ISPF-specific comments, address your comments to:
IBM Corporation
Department J87/D325
555 Bailey Avenue
San Jose, CA 95141-1003
U.S.A.
Internet: comments@us.ibm.com
If you would like a reply, be sure to include your name and your address, telephone number, e-mail address, or
FAX number.
Make sure to include the following in your comment or note:
v Title and order number of this document
v Page number or topic related to your comment
When you send information to IBM, you grant IBM a nonexclusive right to use or distribute the information in any
way it believes appropriate without incurring any obligation to you.
The ISPF development team maintains a site on the World Wide Web. The URL for the site is:
http://www.ibm.com/software/awdtools/ispf/
© Copyright International Business Machines Corporation 1989, 2005. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract
with IBM Corp.
Contents
Preface . . . . . . . . . . . . . . . ix
Who should use this document . . . . . . . . ix
Using LookAt to look up message explanations . . ix
Using IBM Health Checker for z/OS . . . . . . x
Chapter 1. ISPF General Information . . 1
Invoking an ISPF Application . . . .
Invoking the ISPF Conversion Utility .
ISPF System Information . . . . .
Files Used by ISPF . . . . . .
ISPF System Commands . . . .
Command Table Actions . . . .
Dialog Test Commands . . . . .
Message Definitions . . . . . .
Skeleton Control Statements . . .
Panel Definitions . . . . . . .
PDF Browse Primary Commands . .
PDF Member List Commands . . .
Primary Commands . . . . .
Line Commands . . . . . . .
PDF Data Set List Commands . . .
Primary Commands . . . . .
Line Commands . . . . . . .
PDF Edit and View Commands . . .
Primary Commands . . . . .
Line Commands . . . . . . .
Search Strings . . . . . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
. 1
. 1
. 2
. 2
. 3
. 5
. 5
. 6
. 6
. 6
. 10
. 10
. 10
. 11
. 12
. 12
. 12
. 13
. 13
. 17
. 18
Chapter 2. ISPF Service Syntax with
Return Codes . . . . . . . . . . . . 19
Syntax Notation . . . . . . . . . .
ISPEXEC Command Invocation . . . .
ISPEXEC Parameter Conventions . . .
The ISPLINK Interface . . . . . . .
CALL ISPLINK Parameters . . . . .
The ISPEXEC Interface . . . . . .
CALL ISPEXEC Parameters . . . . .
ISPF Services . . . . . . . . . . .
ADDPOP – Start Pop-Up Window Mode
BRIF – Browse Interface . . . . . .
BROWSE – Browse a Data Set . . . .
CONTROL – Set Processing Modes . .
DISPLAY – Display Panels and Messages
DSINFO – Data Set Information Dialog .
EDIF – Edit Interface . . . . . . .
EDIREC – Initialize Edit Recovery . . .
EDIT – Edit a Data Set . . . . . .
EDREC – Specify Edit Recovery Handling
FILESTAT – Statistics for a file . . . .
FILEXFER – Upload or download file .
FTCLOSE – End File Tailoring . . . .
FTERASE – Erase File Tailoring Output .
FTINCL – Include a Skeleton . . . .
FTOPEN – Begin File Tailoring . . . .
GETMSG – Get a Message . . . . .
© Copyright IBM Corp. 1989, 2005
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
19
19
19
19
20
20
20
20
20
21
22
22
23
24
24
25
26
27
27
28
28
29
29
30
30
GRERROR – Graphics Error Block Service . . .
GRINIT – Graphics Initialization . . . . . .
GRTERM – Graphics Termination Service . . .
LIBDEF – Allocate Application Libraries . . . .
LIST – Write Lines to the List Data Set . . . .
LMCLOSE – Close a Data Set . . . . . . .
LMCOMP – Compresses a Partitioned Data Set
LMCOPY – Copy Members of a Data Set . . .
LMDDISP – Data Set Display Service . . . . .
LMDFREE – Free a Data Set List . . . . . .
LMDINIT – Initialize a Data Set List . . . . .
LMDLIST – List a Data Set . . . . . . . .
LMERASE – Erase a Data Set . . . . . . .
LMFREE – Free Data Set from its Association
with Data ID . . . . . . . . . . . . .
LMGET – Read a Logical Record from a Data Set
LMINIT – Generate a Data ID for a Data Set . .
LMMADD – Add a Member to a Data Set . . .
LMMDEL – Delete Members from a Data Set . .
LMMDISP – Member List Service . . . . . .
LMMFIND – Find a Library Member . . . . .
LMMLIST – List a Library’s Members . . . .
LMMOVE – Move Members of a Data Set . . .
LMMREN – Rename a Data Set Member . . .
LMMREP – Replace a Member of a Data Set . .
LMMSTATS – Set and Store ISPF Statistics . . .
LMOPEN – Open a Data Set . . . . . . .
LMPRINT – Print a Partitioned or Sequential
Data Set . . . . . . . . . . . . . .
LMPUT – Write a Logical Record to a Data Set
LMQUERY – Give a Dialog Information about a
Data Set . . . . . . . . . . . . . .
LMRENAME – Rename an ISPF Library . . . .
LOG – Write a Message to the Log Data Set . .
MEMLIST – Member List Dialog . . . . . .
PQUERY – Obtain Panel Information . . . . .
QBASELIB – Query Base Library Information . .
QLIBDEF – Query LIBDEF Definition
Information . . . . . . . . . . . . .
QTABOPEN – Query Open ISPF Tables . . . .
QUERYENQ – Query System ENQ Data . . . .
REMPOP – Remove a Pop-Up Window . . . .
SELECT – Select a Panel or Function . . . . .
SETMSG – Set Next Message . . . . . . .
TBADD – Add a Row to a Table . . . . . .
TBBOTTOM – Set the Row Pointer to Bottom . .
TBCLOSE – Close and Save a Table . . . . .
TBCREATE – Create a New Table . . . . . .
TBDELETE – Delete a Row from a Table. . . .
TBDISPL – Display Table Information . . . .
TBEND – Close a Table without Saving . . . .
TBERASE – Erase a Table . . . . . . . . .
TBEXIST – Determine Whether a Row Exists in a
Table . . . . . . . . . . . . . . .
TBGET – Retrieve a Row from a Table . . . .
TBMOD – Modify a Row in a Table . . . . .
30
31
31
32
32
33
33
34
35
35
35
36
36
37
37
38
39
39
40
43
44
45
46
46
47
48
48
49
49
50
51
51
52
52
53
53
53
54
55
56
56
57
57
58
58
59
60
61
61
61
62
iii
TBOPEN – Open a Table . . . . . . . . .
TBPUT – Update a Row in a Table . . . . .
TBQUERY – Obtain Table Information . . . .
TBSARG – Define a Search Argument . . . .
TBSAVE – Save a Table . . . . . . . . .
TBSCAN – Search a Table . . . . . . . .
TBSKIP – Move the Row Pointer . . . . . .
TBSORT – Sort a Table. . . . . . . . . .
TBSTATS – Retrieve Table Statistics . . . . .
TBTOP – Set the Row Pointer to the Top . . .
TBVCLEAR – Clear Table Variables . . . . .
TRANS – Translate Data from One Coded
Character Set Identifier (CCSID) to Another . .
VCOPY – Create a Copy of a Variable . . . .
VDEFINE – Define Function Variables . . . .
VDELETE – Remove a Definition of Function
Variables . . . . . . . . . . . . . .
VERASE – Remove Variables from Shared
and/or Profile Pool . . . . . . . . . . .
VGET – Retrieve Variables from a Pool or Profile
VIEW – View a Data Set . . . . . . . . .
VIIF – View Interface . . . . . . . . . .
VMASK – Associate an Edit Mask with a Dialog
Variable . . . . . . . . . . . . . .
VPUT – Update Variables in the Shared or Profile
Pool . . . . . . . . . . . . . . . .
VREPLACE – Replace a Variable . . . . . .
VRESET – Reset Function Variables . . . . .
WSCON — Connect to a Workstation . . . .
WSDISCON — Connect to a Workstation . . .
62
63
63
64
64
65
65
66
66
67
67
68
68
68
69
69
69
70
71
72
72
73
73
73
74
Chapter 3. Edit Macro Commands . . . 75
AUTOLIST - Set or Query Autolist Mode . .
Macro Command Syntax . . . . . . .
Assignment Statement Syntax . . . . .
Return Codes . . . . . . . . . . .
AUTONUM - Set or Query Autonum Mode .
Macro Command Syntax . . . . . . .
Assignment Statement Syntax . . . . .
Return Codes . . . . . . . . . . .
AUTOSAVE - Set or Query Autosave Mode .
Macro Command Syntax . . . . . . .
Assignment Statement Syntax . . . . .
Return Codes . . . . . . . . . . .
BLKSIZE - Query the Block Size . . . . .
Assignment Statement Syntax . . . . .
Return Codes . . . . . . . . . . .
BOUNDS - Set or Query the Edit Boundaries .
Macro Command Syntax . . . . . . .
Assignment Statement Syntax . . . . .
Return Codes . . . . . . . . . . .
BROWSE - Browse from within an Edit Session
Macro Command Syntax . . . . . . .
Return Codes . . . . . . . . . . .
BUILTIN - Process a Built-In Command . . .
Macro Command Syntax . . . . . . .
Return Codes . . . . . . . . . . .
CANCEL - Cancel Edit Changes . . . . .
Macro Command Syntax . . . . . . .
Return Codes . . . . . . . . . . .
CAPS - Set or Query Caps Mode . . . . .
iv
z/OS V1R7.0 ISPF Reference Summary
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
75
75
75
75
75
75
75
75
75
75
75
76
76
76
76
76
76
76
76
76
76
76
76
76
77
77
77
77
77
Macro Command Syntax . . . . . . . .
Assignment Statement Syntax . . . . . .
Return Codes . . . . . . . . . . . .
CHANGE - Change a Search String . . . . .
Macro Command Syntax . . . . . . . .
Return Codes . . . . . . . . . . . .
CHANGE_COUNTS - Query Change Counts . .
Assignment Statement Syntax . . . . . .
Return Codes . . . . . . . . . . . .
COMPARE - Compare Data Set . . . . . . .
Macro Command Syntax . . . . . . . .
Return Codes . . . . . . . . . . . .
COPY - Copy Data . . . . . . . . . . .
Macro Command Syntax . . . . . . . .
Return Codes . . . . . . . . . . . .
CREATE - Create a Data Set Member . . . . .
Macro Command Syntax . . . . . . . .
Return Codes . . . . . . . . . . . .
CTL_LIBRARY - Query Controlled Library Status
Assignment Statement Syntax . . . . . .
Return Codes . . . . . . . . . . . .
CURSOR - Set or Query the Cursor Position . .
Assignment Statement Syntax . . . . . .
Return Codes . . . . . . . . . . . .
CUT — Cut and Save Lines . . . . . . . .
Assignment Statement Syntax . . . . . .
Return Codes . . . . . . . . . . . .
DATA_CHANGED - Query the Data Changed
Status . . . . . . . . . . . . . . .
Assignment Statement Syntax . . . . . .
Return Codes . . . . . . . . . . . .
DATA_WIDTH - Query Data Width . . . . .
Assignment Statement Syntax . . . . . .
Return Codes . . . . . . . . . . . .
DATAID - Query Data ID . . . . . . . .
Assignment Statement Syntax . . . . . .
Return Codes . . . . . . . . . . . .
DATASET - Query the Current Data Set Name .
Assignment Statement Syntax . . . . . .
Return Codes . . . . . . . . . . . .
DEFINE - Define a Name . . . . . . . . .
Macro Command Syntax . . . . . . . .
Return Codes . . . . . . . . . . . .
DELETE - Delete Lines . . . . . . . . .
Macro Command Syntax . . . . . . . .
Return Codes . . . . . . . . . . . .
DISPLAY_COLS - Query Display Columns . . .
Assignment Statement Syntax . . . . . .
Return Codes . . . . . . . . . . . .
DISPLAY_LINES - Query Display Lines . . . .
Assignment Statement Syntax . . . . . .
Return Codes . . . . . . . . . . . .
DOWN - Scroll Down . . . . . . . . . .
Macro Command Syntax . . . . . . . .
Return Codes . . . . . . . . . . . .
EDIT - Edit from Within an Edit Session . . . .
Macro Command Syntax . . . . . . . .
Return Codes . . . . . . . . . . . .
END - End the Edit Session . . . . . . . .
Macro Command Syntax . . . . . . . .
Return Codes . . . . . . . . . . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
77
77
77
77
77
77
78
78
78
78
78
78
78
78
78
78
78
78
79
79
79
79
79
79
79
79
79
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
79
79
79
80
80
80
80
80
80
80
80
80
80
80
80
81
81
81
81
81
81
81
81
81
81
81
81
82
82
82
82
82
82
EXCLUDE - Exclude Lines from the Panel . . . .
Macro Command Syntax . . . . . . . . .
Return Codes . . . . . . . . . . . . .
EXCLUDE_COUNTS - Query Exclude Counts . . .
Assignment Statement Syntax . . . . . . .
Return Codes . . . . . . . . . . . . .
FIND - Find a Search String . . . . . . . . .
Macro Command Syntax . . . . . . . . .
Return Codes . . . . . . . . . . . . .
FIND_COUNTS - Query Find Counts . . . . .
Assignment Statement Syntax . . . . . . .
Return Codes . . . . . . . . . . . . .
FLIP - Reverse Excluded Status of Lines . . . . .
Macro Command Syntax . . . . . . . . .
Return Codes . . . . . . . . . . . . .
FLOW_COUNTS - Query Flow Counts . . . . .
Assignment Statement Syntax . . . . . . .
Return Codes . . . . . . . . . . . . .
HEX - Set or Query Hexadecimal Mode . . . . .
Macro Command Syntax . . . . . . . . .
Assignment Statement Syntax . . . . . . .
Return Codes . . . . . . . . . . . . .
HIDE - Hide Excluded Lines Message . . . . .
Macro Command Syntax . . . . . . . . .
Return Codes . . . . . . . . . . . . .
HILITE - Enhanced Edit Coloring . . . . . . .
Macro Command Syntax . . . . . . . . .
Return Codes . . . . . . . . . . . . .
IMACRO - Set or Query an Initial Macro . . . .
Macro Command Syntax . . . . . . . . .
Assignment Statement Syntax . . . . . . .
Return Codes . . . . . . . . . . . . .
INSERT - Prepare Display for Data Insertion . . .
Macro Command Syntax . . . . . . . . .
Return Codes . . . . . . . . . . . . .
LABEL - Set or Query a Line Label . . . . . .
Assignment Statement Syntax . . . . . . .
Return Codes . . . . . . . . . . . . .
LEFT - Scroll Left . . . . . . . . . . . .
Macro Command Syntax . . . . . . . . .
Return Codes . . . . . . . . . . . . .
LEVEL - Set or Query the Mod Level Number . . .
Macro Command Syntax . . . . . . . . .
Assignment Statement Syntax . . . . . . .
Return Codes . . . . . . . . . . . . .
LINE - Set or Query a Line from the Data Set . . .
Assignment Statement Syntax . . . . . . .
Return Codes . . . . . . . . . . . . .
LINE_AFTER - Add a Line to the Current Data Set
Assignment Statement Syntax . . . . . . .
Return Codes . . . . . . . . . . . . .
LINE_BEFORE - Add a Line to the Current Data Set
Assignment Statement Syntax . . . . . . .
Return Codes . . . . . . . . . . . . .
LINE_STATUS - Query Source and Change
Information for a Line in a Data Set . . . . . .
Assignment Statement Syntax . . . . . . .
Return Codes . . . . . . . . . . . . .
LINENUM - Query the Line Number of a Labeled
Line . . . . . . . . . . . . . . . . .
Assignment Statement Syntax . . . . . . .
82
82
82
83
83
83
83
83
83
83
83
83
83
83
83
84
84
84
84
84
84
84
84
84
84
84
84
85
85
85
85
85
85
85
85
86
86
86
86
86
86
86
86
86
86
87
87
87
87
87
87
87
87
87
87
87
88
88
88
Return Codes . . . . . . . . . . . .
LOCATE - Locate a Line . . . . . . . . .
Specific Locate Syntax . . . . . . . . .
Generic Locate Syntax . . . . . . . . .
Return Codes . . . . . . . . . . . .
LRECL - Query the Logical Record Length . . .
Assignment Statement Syntax . . . . . .
Return Codes . . . . . . . . . . . .
MACRO - Identify an Edit Macro . . . . . .
Macro Command Syntax . . . . . . . .
Return Codes . . . . . . . . . . . .
MACRO_LEVEL - Query the Macro Nesting Level
Assignment Statement Syntax . . . . . .
Return Codes . . . . . . . . . . . .
MASKLINE - Set or Query the Mask Line . . .
Assignment Statement Syntax . . . . . .
Return Codes . . . . . . . . . . . .
MEMBER - Query the Current Member Name . .
Assignment Statement Syntax . . . . . .
Return Codes . . . . . . . . . . . .
MEND - End a Macro in the Batch Environment .
Macro Command Syntax . . . . . . . .
Return Codes . . . . . . . . . . . .
MODEL - Copy a Model into the Current Data Set
Macro Command Model Name Syntax . . .
Macro Command Class Name Syntax. . . .
Return Codes . . . . . . . . . . . .
MOVE - Move a Data Set Member . . . . .
Macro Command Syntax . . . . . . . .
Return Codes . . . . . . . . . . . .
NONUMBER - Turn Off Number Mode . . . .
Syntax . . . . . . . . . . . . . .
Return Codes . . . . . . . . . . . .
NOTES - Set or Query Note Mode . . . . . .
Macro Command Syntax . . . . . . . .
Assignment Statement Syntax . . . . . .
Return Codes . . . . . . . . . . . .
NULLS - Set or Query Nulls Mode . . . . .
Macro Command Syntax . . . . . . . .
Assignment Statement Syntax . . . . . .
Return Codes . . . . . . . . . . . .
NUMBER - Set or Query Number Mode . . . .
Macro Command Syntax . . . . . . . .
Assignment Statement Syntax . . . . . .
Return Codes . . . . . . . . . . . .
PACK - Set or Query Pack Mode . . . . . .
Macro Command Syntax . . . . . . . .
Assignment Statement Syntax . . . . . .
Return Codes . . . . . . . . . . . .
PASTE — Move or Copy Lines from Clipboard .
Macro Command Syntax . . . . . . . .
Return Codes . . . . . . . . . . . .
PRESERVE - Enable Saving of Trailing Blanks . .
Macro Command Syntax . . . . . . . .
Assignment Statement Syntax . . . . . .
Return Codes . . . . . . . . . . . .
PROCESS - Process the Panel . . . . . . .
Macro Command Syntax . . . . . . . .
Return Codes . . . . . . . . . . . .
PROFILE - Set or Query the Current Profile . .
Macro Command Profile Control Syntax . . .
Contents
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
88
88
88
88
88
88
88
88
89
89
89
89
89
89
89
89
89
89
89
89
90
90
90
90
90
90
90
90
90
90
90
90
91
91
91
91
91
91
91
91
91
91
91
91
92
92
92
92
92
92
92
92
92
92
92
92
93
93
93
93
93
v
Macro Command Profile Lock Syntax . . . .
Macro Command Profile Reset Syntax . . . .
Assignment Statement Syntax . . . . . . .
Return Codes . . . . . . . . . . . . .
RANGE_CMD - Query a Command That You
Entered . . . . . . . . . . . . . . . .
Assignment Statement Syntax . . . . . . .
Return Codes . . . . . . . . . . . . .
RCHANGE - Repeat a Change . . . . . . . .
Macro Command Syntax . . . . . . . . .
Return Codes . . . . . . . . . . . . .
RECFM - Query the Record Format . . . . . .
Assignment Statement Syntax . . . . . . .
Return Codes . . . . . . . . . . . . .
RECOVERY - Set or Query Recovery Mode . . . .
Macro Command Syntax . . . . . . . . .
Assignment Statement Syntax . . . . . . .
Return Codes . . . . . . . . . . . . .
RENUM - Renumber Data Set Lines . . . . . .
Macro Command Syntax . . . . . . . . .
Return Codes . . . . . . . . . . . . .
REPLACE - Replace a Data Set or Data Set Member
Macro Command Syntax . . . . . . . . .
Return Codes . . . . . . . . . . . . .
RESET - Reset the Data Display . . . . . . .
Macro Command Syntax . . . . . . . . .
Return Codes . . . . . . . . . . . . .
RFIND - Repeat Find . . . . . . . . . . .
Macro Command Syntax . . . . . . . . .
Return Codes . . . . . . . . . . . . .
RIGHT - Scroll Right . . . . . . . . . . .
Macro Command Syntax . . . . . . . . .
Return Codes . . . . . . . . . . . . .
RMACRO - Set or Query the Recovery Macro . . .
Macro Command Syntax . . . . . . . . .
Assignment Statement Syntax . . . . . . .
Return Codes . . . . . . . . . . . . .
SAVE - Save the Current Data . . . . . . . .
Macro Command Syntax . . . . . . . . .
Return Codes . . . . . . . . . . . . .
SAVE_LENGTH - Set or Query Length for Variable
Length Data . . . . . . . . . . . . . .
Macro Command Syntax . . . . . . . . .
Return Codes . . . . . . . . . . . . .
SCAN - Set Command Scan Mode . . . . . . .
Macro Command Syntax . . . . . . . . .
Assignment Statement Syntax . . . . . . .
Return Codes . . . . . . . . . . . . .
SEEK - Seek a Data String, Positioning the Cursor
Macro Command Syntax . . . . . . . . .
Return Codes . . . . . . . . . . . . .
SEEK_COUNTS - Query Seek Counts . . . . .
Assignment Statement Syntax . . . . . . .
Return Codes . . . . . . . . . . . . .
SESSION — Identify Type of Session . . . . . .
Assignment Statement Syntax . . . . . . .
Return Codes . . . . . . . . . . . . .
SETUNDO - Set UNDO Mode . . . . . . . .
Macro Command Syntax . . . . . . . . .
Assignment Statement Syntax . . . . . . .
Return Codes . . . . . . . . . . . . .
vi
z/OS V1R7.0 ISPF Reference Summary
93
93
93
93
93
93
93
94
94
94
94
94
94
94
94
94
94
94
94
95
95
95
95
95
95
95
95
95
95
95
95
96
96
96
96
96
96
96
96
96
96
96
97
97
97
97
97
97
97
97
97
97
97
97
97
98
98
98
98
SHIFT ( - Shift Columns Left . . . . .
Macro Command Syntax . . . . . .
Return Codes . . . . . . . . . .
SHIFT ) - Shift Columns Right . . . . .
Macro Command Syntax . . . . . .
Return Codes . . . . . . . . . .
SHIFT < - Shift Data Left . . . . . . .
Macro Command Syntax . . . . . .
Return Codes . . . . . . . . . .
SHIFT > - Shift Data Right . . . . . .
Macro Command Syntax . . . . . .
Return Codes . . . . . . . . . .
SORT - Sort Data . . . . . . . . .
Macro Command Syntax . . . . . .
Return Codes . . . . . . . . . .
STATS - Set or Query Stats Mode . . . .
Macro Command Syntax . . . . . .
Assignment Statement Syntax . . . .
Return Codes . . . . . . . . . .
SUBMIT - Submit Data for Batch Processing
Macro Command Syntax . . . . . .
Return Codes . . . . . . . . .
TABS - Set or Query Tabs Mode . . . .
Macro Command Syntax . . . . .
Assignment Statement Syntax . . . .
Return Codes . . . . . . . . .
TABSLINE - Set or Query Tabs Line . . .
Assignment Statement Syntax . . . .
Return Codes . . . . . . . . .
TENTER - Set Up Panel for Text Entry . .
Macro Command Syntax . . . . .
Return Codes . . . . . . . . .
TFLOW - Text Flow a Paragraph . . . .
Macro Command Syntax . . . . .
Return Codes . . . . . . . . .
TSPLIT - Text Split a Line . . . . . .
Macro Command Syntax . . . . .
Return Codes . . . . . . . . .
UNNUMBER - Remove Sequence Numbers
Macro Command Syntax . . . . .
Return Codes . . . . . . . . .
UP - Scroll Up . . . . . . . . . .
Macro Command Syntax . . . . .
Return Codes . . . . . . . . .
USER_STATE - Save or Restore User State .
Assignment Statement Syntax . . . .
Return Codes . . . . . . . . .
VERSION - Set or Query Version Number .
Macro Command Syntax . . . . .
Assignment Statement Syntax . . . .
Return Codes . . . . . . . . .
VIEW - View from within an Edit Session .
Macro Command Syntax . . . . .
Return Codes . . . . . . . . .
VOLUME — Query Volume Information .
Assignment Statement Syntax . . . .
Return Codes . . . . . . . . .
XSTATUS - Set or Query Exclude Status of a
Assignment Statement Syntax . . . .
Return Codes . . . . . . . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
. 98
. 98
. 98
. 98
. 98
. 98
. 98
. 98
. 99
. 99
. 99
. 99
. 99
. 99
. 99
. 99
. 99
. 99
. 99
. 99
. 99
. . . 100
. . . 100
. . . 100
. . . 100
. . . 100
. . . 100
. . . 100
. . . 100
. . . 100
. . . 100
. . . 100
. . . 101
. . . 101
. . . 101
. . . 101
. . . 101
. . . 101
. . . 101
. . . 101
. . . 101
. . . 101
. . . 101
. . . 101
. . . 102
. . . 102
. . . 102
. . . 102
. . . 102
. . . 102
. . . 102
. . . 102
. . . 102
. . . 102
. . . 102
. . . 102
. . . 102
Line 103
. . . 103
. . . 103
Chapter 4. SCLM Services and Macros 105
SCLM Services . . . . . . . . . . . . .
ACCTINFO - Retrieve Accounting Information
AUTHCODE - Set or Retrieve an AUTHCODE
BUILD - Build a Member . . . . . . . .
DBACCT - Retrieve Accounting Records for a
Member . . . . . . . . . . . . . .
DBUTIL - Generate a Tailored Data Set and
Report . . . . . . . . . . . . . . .
DELETE - Delete Database Components . . .
DELGROUP - Delete Database Components
from Group . . . . . . . . . . . . .
DSALLOC—Allocate Data Sets for Group/Type
EDIT— Edit a Member of a Controlled Library
END - End an SCLM Services Session . . . .
EXPORT - Extract SCLM Accounting
Information for a Group . . . . . . . . .
FREE - Free Database from its Association with
SCLM ID . . . . . . . . . . . . . .
GETBLDMP—Retrieve Build Map Information
IMPORT - Import SCLM Accounting
Information to Current Project . . . . . . .
INIT - Generate an SCLM ID for a Database . .
LOCK - Lock a Member or Assign an Access
Key . . . . . . . . . . . . . . . .
MIGRATE - Create Accounting Information for
Selected Members . . . . . . . . . . .
NEXTGRP - Find the Next Group in a Hierarchy
PARSE - Parse a Member for Statistical and
Dependency Information . . . . . . . .
PROMOTE - Promote a Member from One
Library to Another . . . . . . . . . .
RPTARCH - Generate an SCLM Architecture
Report . . . . . . . . . . . . . . .
SAVE - Lock, Parse, and Store a Member . . .
SCLMINFO - Return Project Information . . .
START - Generate an Application ID for a
Service Session . . . . . . . . . . . .
STORE - Store Member Information in an
Accounting Record . . . . . . . . . .
UNLOCK - Unlock a Member in a Development
Library . . . . . . . . . . . . . .
VERDEL—Delete Version Information . . . .
VERINFO - Retrieve Version Information . . .
VERRECOV - Recover A Version . . . . . .
SCLM Macros . . . . . . . . . . . . .
FLMABEG - Define the Project Name of the
Project Definition . . . . . . . . . . .
FLMAEND - Last Macro in the Project
Definition . . . . . . . . . . . . .
FLMAGRP - Define a Group of Authorization
Codes . . . . . . . . . . . . . . .
FLMALLOC - Define Each DDname in the
DDname Substitution List for a Translator . . .
FLMALTC - Specify Alternate Control
Information . . . . . . . . . . . . .
FLMATVER - Enable the Audit and Version
Utility . . . . . . . . . . . . . . .
105
105
106
107
108
108
109
109
110
111
112
113
113
114
114
115
116
FLMCMPLB - Define a Set of Data Sets for a
Language Containing Project Compool
Dependencies . . . . . . . . . . . .
FLMCNTRL - Specify Project-Specific Control
Options . . . . . . . . . . . . . .
FLMCPYLB - Identify Additional Data Sets to
Be Concatenated to a DDname . . . . . .
FLMGROUP - Define One Group in the Project
Definition . . . . . . . . . . . . .
FLMINCLS - Associate Include-Sets with Types
in the Project Hierarchy . . . . . . . . .
FLMLANGL - Define a Language to SCLM . .
FLMSYSLB - Define a Set of Data Sets for a
Language Containing Project Macros or
Included Members . . . . . . . . . .
FLMTCOND - Select Build Translators Based on
Group and Return Codes . . . . . . . .
FLMTOPTS - Select the Options Based on
Group . . . . . . . . . . . . . . .
FLMTRNSL - Define Once for Each Translator to
Be Invoked for a Language . . . . . . . .
FLMTYPE - Define One FLMTYPE in the Project
Definition . . . . . . . . . . . . .
126
126
127
127
128
128
128
128
128
128
129
Chapter 5. System Variables . . . . . 131
121
Configuration Utility . . . . .
Time and Date . . . . . . .
General . . . . . . . . .
Terminal and Function Keys . .
Scrolling . . . . . . . . .
PRINTG Command . . . . .
Table Display Service . . . . .
LIST Service . . . . . . . .
LOG and LIST Data Sets . . .
Dialog Error . . . . . . . .
Tutorial Panels . . . . . . .
Selection Panels . . . . . .
DTL Panels or Panels Containing a
121
Chapter 6. Dialog Variables . . . . . 141
116
117
118
118
119
120
120
122
122
123
124
125
PDF Non-Modifiable Variables
.
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
. . . . . .
)PANEL Section
.
.
.
.
.
132
132
133
136
137
138
138
138
139
139
139
139
140
. 146
Chapter 7. Dialog Tag Language (DTL)
Tags . . . . . . . . . . . . . . . 147
Tag Summary .
.
.
.
.
.
.
.
.
.
.
.
. 147
125
Appendix. Accessibility . . . . . . . 173
125
Using assistive technologies . . . . .
Keyboard navigation of the user interface .
z/OS information . . . . . . . . .
.
.
.
.
.
.
. 173
. 173
. 173
125
125
125
Notices . . . . . . . . . . . . . . 175
Programming Interface Information .
Trademarks . . . . . . . . .
.
.
.
.
.
.
.
.
. 176
. 176
126
Contents
vii
viii
z/OS V1R7.0 ISPF Reference Summary
Preface
This document is a quick reference for application developers and library
administrators who use various components of the ISPF product.
Chapter 1 contains general information about ISPF.
Chapters 2 through 4 contain the syntax and return codes for the following:
v ISPF services
v Edit macro commands
v SCLM services and macros.
This document also contains tables of ISPF system variables and dialog variables
(Chapters 5 and 6) and a summary of the Dialog Tag Language (DTL) tags for ISPF
(Chapter 7).
Information in this document was extracted from the following prerequisite books:
v z/OS ISPF Dialog Developer’s Guide and Reference
v z/OS ISPF User’s Guide Vol I
v z/OS ISPF User’s Guide Vol II
v z/OS ISPF Services Guide
v z/OS ISPF Edit and Edit Macros
v z/OS ISPF Software Configuration and Library Manager Reference
v z/OS ISPF Dialog Tag Language Guide and Reference
Who should use this document
This document is for:
v Application programmers who write programs or command procedures that
invoke ISPF services.
v Application programmers who use the ISPF editor and edit macros.
v Library administrators who use library management facilities.
Using LookAt to look up message explanations
LookAt is an online facility that lets you look up explanations for most of the
IBM® messages you encounter, as well as for some system abends and codes.
Using LookAt to find information is faster than a conventional search because in
most cases LookAt goes directly to the message explanation.
You can use LookAt from these locations to find IBM message explanations for
z/OS® elements and features, z/VM®, VSE/ESA™, and Clusters for AIX® and
Linux™:
v The Internet. You can access IBM message explanations directly from the LookAt
Web site at http://www.ibm.com/servers/eserver/zseries/zos/bkserv/lookat/.
v Your z/OS TSO/E host system. You can install code on your z/OS or z/OS.e
systems to access IBM message explanations using LookAt from a TSO/E
command line (for example: TSO/E prompt, ISPF, or z/OS UNIX® System
Services).
© Copyright IBM Corp. 1989, 2005
ix
v Your Microsoft® Windows® workstation. You can install LookAt directly from
the z/OS Collection (SK3T-4269) or the z/OS and Software Products DVD Collection
(SK3T4271) and use it from the resulting Windows graphical user interface
(GUI). The command prompt (also known as the DOS > command line) version
can still be used from the directory in which you install the Windows version of
LookAt.
v Your wireless handheld device. You can use the LookAt Mobile Edition from
http://www.ibm.com/servers/eserver/zseries/zos/bkserv/lookat/lookatm.html
with a handheld device that has wireless access and an Internet browser (for
example: Internet Explorer for Pocket PCs, Blazer or Eudora for Palm OS, or
Opera for Linux handheld devices).
You can obtain code to install LookAt on your host system or Microsoft Windows
workstation from:
v A CD-ROM in the z/OS Collection (SK3T-4269).
v The z/OS and Software Products DVD Collection (SK3T4271).
v The LookAt Web site (click Download and then select the platform, release,
collection, and location that suit your needs). More information is available in
the LOOKAT.ME files available during the download process.
Using IBM Health Checker for z/OS
IBM Health Checker for z/OS is a z/OS component that installations can use to
gather information about their system environment and system parameters to help
identify potential configuration problems before they impact availability or cause
outages. Individual products, z/OS components, or ISV software can provide
checks that take advantage of the IBM Health Checker for z/OS framework. This
book refers to checks or messages associated with this component.
For additional information about checks and about IBM Health Checker for z/OS,
see IBM Health Checker for z/OS and Sysplex: User’s Guide. z/OS V1R4, V1R5, and
V1R6 users can obtain the IBM Health Checker for z/OS from the z/OS
Downloads page at
http://www.ibm.com/servers/eserver/zseries/zos/downloads/.
SDSF also provides functions to simplify the management of checks. See z/OS
SDSF Operation and Customization for additional information.
x
z/OS V1R7.0 ISPF Reference Summary
Chapter 1. ISPF General Information
Invoking an ISPF Application
ISPSTART
{PANEL(panel-name) [OPT(option)][ADDPOP]}
{CMD(command parm1 parm2) [LANG(APL|CREX)]}
{PGM(program-name) [PARM(parameters)]}
{WSCMD(workstation-command)
[MODAL|MODELESS]
[WSDIR(dir)]
[MAX|MIN]
[VIS|INVIS]}
{WSCMDV(var_name)
[MODAL|MODELESS]
[WSDIR(dir)]
[MAX|MIN]
[VIS|INVIS]}
[GUI(LU:address:tpname | IP:address:port |,FI:) |,NOGUIDSP)] [TITLE(title)]
[GUISCRW(screen-width)]
[GUISCRD(screen-depth)]
[FRAME(STD|FIX|DLG)]
[CODEPAGE(codepage)] [CHARSET(character_set)]
[BKGRND(STD|DLG)]
[NEWAPPL[(application-id)]]
[SCRNAME(screen-name)]
[TEST|TESTX|TRACE|TRACEX]
[NOLOGO|LOGO(logo-panel-name)]
[BATSCRW(screen-width)]
[BATSCRD(screen-depth)]
[BDISPMAX(max-number-of-displays)]
[BREDIMAX(max-number-of-redisplays)]
[BDBCS]
[DANISH|ENGLISH|GERMAN|JAPANESE|PORTUGUE|SPANISH|KOREAN|
FRENCH|ITALIAN|CHINESET|CHINESES|SGERMAN|UPPERENG]
Figure 1. ISPSTART Command
Invoking the ISPF Conversion Utility
ISPDTLC
(for interactive interface)
OR
ISPDTLC ?
(for help information)
OR
(command syntax)
© Copyright IBM Corp. 1989, 2005
1
ISPF General Information
REPLACE
SCREEN
NODBCS
NOREPLACE
DISK
DBCS
ISPDTLC source-filespec(
NOPANEL
NOMSGSUPP
NOCUASUPP
PANEL
MSGSUPP
CUASUPP
NOKANA
KANA
KEYLAPPL=xxxx
PREP
CUAATTR
NOLSTVIEW
STATS
NOSCRIPT
NOPREP
NOCUAATTR
LSTVIEW
NOSTATS
SCRIPT
NOLISTING
NOMSGEXPAND
LOGREPL
LISTREPL
MSGEXPAND
NOLOGREPL
NOLISTREPL
NOFORMAT
LISTING
FORMAT
ACTBAR
GUI
VERSION
NOMERGESAREA
NODISPLAY
NOACTBAR
NOGUI
NOVERSION
MERGESAREA
DISPLAY
NODISPLAYW
DSNCHK
GRAPHIC
ZVARS
NODBALIGN
DISPLAYW
NODSNCHK
NOGRAPHIC
NOZVARS
DBALIGN
NOPLEB
NOMCOMMENT
NOV3PADC
PLEB
MCOMMENT
V3PADC
PROFILE=data-set-name
PROFDDN=ddname|*
national-language
ISPF System Information
Files Used by ISPF
Note: Files used by a given invocation of ISPF must be allocated before ISPF is
invoked.
2
DDNAME(lib-type)
Description
ISPFILE
ISPILIB
ISPMLIB
ISPPLIB
ISPPROF
ISPSLIB
ISPTABLE
ISPTLIB
SYSPROC
SYSEXEC
File tailoring output
Image library
Message
Panel
User profile
Skeleton
Table output
Table input
REXX/CLIST library
REXX library
z/OS V1R7.0 ISPF Reference Summary
ISPF General Information
ISPF System Commands
ACTIONS
BACKWARD
BOTTOM
CANCEL
CMDE
COLOR
CRETRIEV
CUAATTR
CURSOR
DOWN
DDLIST
DSLIST [list name | DSname level]
DTEST [parameter number]
END
ENVIRON [ENBLDUMP [ON | OFF]]
[TERMTRAC [ON | ERROR | DUMP | OFF]]
[TERMSTAT [QUERY]]
EPDF datasetname [Browse] [View]
[Macro macroname] [Profile profilename]
[Panel panelname] [Format formatname]
[Recover] [Mixed YES|NO]
EXHELP
EXIT
FKA [ON | SHORT | OFF | PREFIX | NOPREFIX]
FORWARD
HELP
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
INT
ISPDPTRC [END]
[VIEW]
[QUIET]
[DSP|DISPLAY( None | In | Out | Both ) ]
[PNL|PANEL( * | panel_name | panel_mask ) ]
[READ( None | Summary | Detail ) ]
[SCR|SCREEN( 0 | * | screen_id )]
[SECT|SECTION( * | All | None | [Init] [Reinit] [Proc] |
[NOInit] [NOReinit] [NOProc] ) ]
[SVC|SERVICE( None | Detail ) ]
ISPDTLC
ISPFTTRC [END]
[VIEW]
[QUIET]
[READ( None | Summary | Detail ) ]
[REC|RECORDS( * | All | None | [Src|Source] [Data] [Cntl] |
[NOSrc|NOSource] [NOData] [NOCntl] ) ]
[SCR|SCREEN( 0 | * | screen_id )]
[SVC|SERVICE( None | Detail ) ]
[SKL|SKEL|SKELETON( * | skel_name | skel_mask ) ]
[TBV|TBVARS( None | Detail ) ]
ISPFVAR [LMSG (ON|OFF) | JUMP(ON|OFF) | ABTAB(ON|OFF) | PSTAB(ON|OFF) |
SESM(ON|OFF) | EDPRT(ON|OFF) | EURO (ON|OFF) | SPLTLINE (ON|OFF) |
SCRML(ON|OFF)]
ISPFWORK
ISPLIBD [libtype]
Chapter 1. ISPF General Information
3
ISPF General Information
ISPPREP
ISRRLIST
ISRROUTE
KEYLIST [PRIVATE | SHARED | ON | OFF]
KEYS
KEYSHELP
LEFT
LIST [PRINT | DELETE | KEEP]
LOG [PRINT | DELETE | KEEP]
MSGID [ON | OFF]
NOP
NRETRIEV
PANELID [ON | OFF]
PFSHOW [ON | OFF | TAILOR]
PRINT
PRINTG
PRINT-HI
PRINTL
PRINTLHI
PSCOLOR
RCHANGE
REFACTD [nnnnnnnn
REFACTL [nnnnnnnn
REFADDD [nnnnnnnn
REFADDL [nnnnnnnn
REFLISTD [xx]
REFLISTL [xx]
REFOPEND
REFOPENL
RESIZE
RETF
RETP
RETRIEVE
RETURN
RFIND
RIGHT
xx]
xx]
xx]
xx]
SAREA
SCRNAME [screen name | PERM | ON | OFF]
SETTINGS
SPLIT [NEW]
SPLITV
START
SWAP [LIST | PREV | NEXT | screen name | n]
SWITCH [3270 | GUI]
SYSNAME [ON | OFF]
|
TOP
TSO
TSOCMD
TSOGUI [ON | OFF]
TUTOR [panelid]
UP
USERID [ON | OFF]
|
WINDOW
WS
4
z/OS V1R7.0 ISPF Reference Summary
ISPF General Information
WSCON
WSDISCON
ZKEYS
Command Table Actions
ALIAS
When followed by the name of another command and optional
parameters, allows specification of command aliases.
NOP
Causes the command to be functionless. System displays an
“inactive command” message in this case.
PASSTHRU
Causes the command to be passed to the dialog, as though it had
not been found in the table.
SELECT
When followed by selection keywords, causes the selected dialog
command, program or selection panel to be given control
immediately.
SETVERB
Causes the command to be passed to the dialog with the command
verb stored separately from the parameters.
Blank (no action)
Causes the table entry to be ignored, and scanning to continue (to
search for additional entries having the same verb).
Variable name
Begins with an ampersand. Its content may be one of the above
actions. Allows dynamic specification of a command action.
Dialog Test Commands
Primary Commands
You can enter the following commands on the Command line while using Dialog
Test (option 7).
CANCEL
END
LOCATE string
LOC
L
QUAL
RESUME
RES
Line Commands
The following line commands have special meaning during testing operations.
D[n]
Delete one or n lines starting with this line.
I[n]
Insert one or n lines directly after this line, with underscores and quotes in
the appropriate fields.
R[n]
Repeat this line once or n times.
Chapter 1. ISPF General Information
5
ISPF General Information
Message Definitions
Line 1:
msgid [’short message’] [.HELP=panel-name|*] [NOKANA|KANA]
[.WINDOW=RESP|NORESP|LRESP|LNORESP] [.TYPE=NOTIFY|WARNING|ACTION|CRITICAL]
Line 2:
’long message’ [+]
Line 3:
[’long message’ [+] ]
Line 4:
[’long message’ [+] ]
Line n:
[’long message’
]
Skeleton Control Statements
)BLANK [number]
)CM comment
)DEFAULT abcdefg
)DO [do-expression] [WHILE while-expression | UNTIL until-expression]
)DO FOREVER
)DO count
)ITERATE
)LEAVE [DOT]
)ENDDO
|
)DOT table-name [SCAN [(name-cond-pairs)] ]
)ENDDOT
)IF relational-expression THEN [control-statement]
)ELSE [control-statement]
)NOP
)IM skel-name [NT] [OPT]
)SEL relational-expression
)ENDSEL
)SET variable = expression
)TB value1 ... value16
)TB value1[A] ... value16[A]
)TBA value1 ... value16
Panel Definitions
All parameters on header statements are optional. When preparing a panel header
statement, use only one line.
Coded Character Set Identifier Section
)CCSID NUMBER(xxxxx)
Panel Section
)PANEL [KEYLIST (keylist-name[,keylist-applid,SHARED])]
[IMAGE (image-name, row, col)]
6
z/OS V1R7.0 ISPF Reference Summary
ISPF General Information
Attribute Section:
)ATTR [DEFAULT (def1def2def3)]
[FORMAT(EBCDIC|DBCS|MIX)]
[OUTLINE([L][R][O][U]|BOX|NONE]
Action Bar Choice Section:
)ABC DESC(choice-description-text) MNEM(number)
PDC DESC(choice-description-text) UNAVAIL(variable) MNEM(number)
ACC(key1[+key2][+key3])
PDSEP(OFF|ON)
ACTION RUN(command-name) PARM(command-parms)
Note: The MNEM keyword is only valid when running in GUI mode.
Action Bar Choice Initialization Section:
)ABCINIT
Note: Only valid when the Action Bar Choice section is specified.
Action Bar Choice Processing Section:
)ABCPROC
Note: Only valid when the Action Bar Choice section is specified.
Body Section:
)BODY [CMD(field-name)]
[DEFAULT(def1def2def3)]
[SMSG(field-name)]
[KANA]
[LMSG(field-name)]
[WIDTH(width)]
[ASIS]
[EXPAND(xy)]
[WINDOW(width,depth)] [FORMAT(EBCDIC|DBCS|MIX)]
[OUTLINE([L][R][O][U]|BOX|NONE]
Note: All keywords must be specified on the same panel line.
Model Section:
|
)MODEL [CLEAR(var-name,var-name...)]
[ROWS(ALL | SCAN)]
[SFIHDR]
Area Section:
)AREA name [DEPTH(depth)]
Initialization Section:
)INIT
Reinitialization Section:
)REINIT
Processing Section:
)PROC
Field Section:
)FIELD FIELD(field-name)
[IND(field-name,value)]
[RIND(field-name,value)]
[LCOL(field-name)]
[SCALE(field-name)]
Help Section:
[LEN(value|field-name)]
[LIND(field-name,value)]
[SIND(field-name,value)]
[RCOL(field-name)]
[SCROLL(value|field-name)]
)HELP FIELD(field-name) PANEL(help-panel-name)| MSG(msg_name) | PASSTHRU
List Section
)LIST (list-name)
VAL(value) CHOICE(value)
Specifying point and shoot fields:
)PNTS FIELD(field-name)|ZPSxxyyy) VAR(variable) VALUE(value)
[DEPTH (depth)] [IMAGE(image-name)] [IMAGEP(image-name)]
[TEXT(’text’)] [PLACE(a, b, l, r)]
Chapter 1. ISPF General Information
7
ISPF General Information
Specifying the End of a Panel Definition:
)END
Panel Statements and Built-in Functions
Attribute Section:
AREA(DYNAMIC|GRAPHIC|SCRL)
ATTN(ON|OFF)
CAPS(ON|OFF|IN|OUT)
CKBOX(ON|OFF)
COLOR(WHITE|RED|BLUE|GREEN|PINK|YELLOW|TURQ)
COMBO(ON|OFF|name)
CSGRP(x)
CUADYN(value)
DATAMOD(datamod-code)
DDLIST(ON|OFF|name)
DEPTH(d)
EXTEND(ON|OFF)
FORMAT(EBCDIC|DBCS|MIX)
GE(ON|OFF)
(Note: For use with TYPE(CHAR) only.)
HILITE(USCORE|BLINK|REVERSE)
INTENS(HIGH|LOW|NON)
JUST(LEFT|RIGHT|ASIS)
LISTBOX(ON|OFF|name)
NOJUMP(ON|OFF)
NUMERIC(ON|OFF)
OUTLINE([L][R][O][U] |BOX|NONE)
PAD(NULLS|USER|char)
PADC(NULLS|USER|char)
PAS(ON|OFF)
RADIO(ON|OFF)
REP(character)
SCROLL(ON|OFF)
SKIP(ON|OFF)
TYPE(TEXT|INPUT|OUTPUT|DATAIN|DATAOUT)
UNAVAIL(ON|OFF)
USERMOD(usermod-code)
WIDTH(w)
Note: Common User Access® (CUA®) attribute TYPE values listed below are
identified in the section that follows.
TYPE(AB|ABSL|CEF|CH|CHAR|CT|DATAIN|DATAOUT|DT|EE|
ET|FP|LEF|LI|LID|NEF|NT|PIN|
PS|PT|RP|SAC|SI|SUC|VOI|WASL|WT)
TYPE(GRPBOX|SC)
CUA Attribute TYPE Values:
TYPE Value
AB
ABSL
CEF
CH
CHAR
CT
DATAIN
DATAOUT
DT
EE
ET
8
z/OS V1R7.0 ISPF Reference Summary
Description
Action Bar Unselected Choices
Action Bar Separator Line
Choice Entry Field
Column Heading
Character attributes in a dynamic area
Caution Text
Input (unprotected) field in a dynamic area
Output (protected) field in a dynamic area
Descriptive Text
Error Emphasis
Emphasized Text
ISPF General Information
Field Prompt
Group Box
Input (unprotected) field
List Entry Field
List Items
List Item Description
Normal Entry Field
Normal Text
Output (protected) field
Panel Instruction
Point-and-Shoot
Panel Title
Reference Phrase
Select Available Choices
Selected choice
Scroll Information
Select Unavailable Choices
Text (protected) field
Variable Output Information
Work Area Separator Line
Warning Text
FP
GRPBOX
INPUT
LEF
LI
LID
NEF
NT
OUTPUT
PIN
PS
PT
RP
SAC
SC
SI
SUC
TEXT
VOI
WASL
WT
Initialization, Reinitialization, and Processing Sections:
variable
variable
variable
variable
variable
variable
variable
variable
variable
=
=
=
=
=
=
=
=
=
value
LVLINE(areaname)
PFK(value)
TRANS (variable value,value...[MSG=message-id])
TRUNC (variable,value)
ADDSOSI(variable)
DELSOSI(variable)
ONEBYTE(variable)
TWOBYTE(variable)
GOTO label
IF (variable operator value[,value...])
ELSE
EXIT
PANEXIT((value,value,...),
{PGM, exit_add [,exit-data] [,MSG=value]
LOAD, exit-mod[,exit-data] [,MSG=msgid]})
REFRESH(field1, field2, ...)
*REXX[([*,]value,value,...[,(member)])]
TOG (mode,fld,&variable [,value1,value2])
VEDIT (variable[,MSG=value])
VGET name-list [ ASIS | SHARED | PROFILE ])
VPUT name-list [ ASIS | SHARED | PROFILE ])
VER (variable[,NONBLANK],keyword[,value...]
[,MSG=message-id])
VER Keywords:
ALPHA
DSNAMEPQ
INCLUDE
LISTVX
PICTCN
ALPHAB
DSNAMEQ
ITIME
LISTX
RANGE
BIT
EBCDIC
JDATE
MIX
STDDATE
DBCS
ENUM
JSTD
NAME
STDTIME
DSNAME
FILEID
LEN
NAMEF
DSNAMEF
HEX
LIST
NUM
DSNAMEFM
IDATE
LISTV
PICT
Panel Control Variables
.ALARM = YES|NO|blank|null|variable
.ATTR(field) = ’keyword(value), keyword(value) ...’
.ATTRCHAR(char) = ’keyword(value), keyword(value) ...’
.AUTOSEL = YES|NO
Chapter 1. ISPF General Information
9
ISPF General Information
.CSRPOS = cursor-position
.CSRROW = table-row-number
.CURSOR = field-name
.HELP = panel-name
.MSG = message-id
.PFKEY = contains function key pressed by user (PF01,PF02, ...,PF24)
.RESP = ENTER|END
.TRAIL = contains remainder from TRUNC operation
.ZVARS = ’(name-list)’
PDF Browse Primary Commands
You can enter the following commands on the command line while using the
Browse function.
BROWSE [member]
BRO
COLUMNS [ON | OFF]
COLS
COL
|
DISPLAY [LINE start_line [end_line]] [COLS start_col [end_col]] [CCSID ccsid_number]
OR:
DISPLAY [char] [NOCC | CC]
DISPL
DISP
DIS
EDIT [member]
|
|
|
FIND string [UTF8]
[NEXT ] [CHARS ] [col-1 [col-2]]
F
[ASCII] [ALL ] [PREFIX]
[USASCII] [FIRST] [SUFFIX]
[LAST ] [WORD ]
[PREV ]
HEX [ON | OFF]
[VERT | DATA]
LOCATE {line-number | label}
LOC
L
RESET
SUBMIT
VIEW [member]
You can use the following format to enter label definitions on the command line:
.ccccc
Defines a label (PDF component internal symbol), which is equated to the
top line on the screen. Can be used with LOCATE to scroll directly to that
line.
PDF Member List Commands
Primary Commands
You can enter the following commands on the command line on member list
displays.
10
z/OS V1R7.0 ISPF Reference Summary
PDF Component General Information
CONFIRM
LOCATE string
LOC
L
MLC
MLS
REFRESH
RESET
SAVE [list-id]
SELECT {pattern | * } [lcmd]
SEL
S
|
SORT [field1 [A|D] [field2 [A|D]]]
Line Commands
On all member list displays except those for option 3.1 and 3.4, you can enter the
following 1-character command at the beginning of a line.
S
Selects the member.
On option 3.1 and 3.4 member list displays, you can enter the following 1-character
commands at the beginning of a line.
B
Browses the member.
C
Copies the member.
D
Deletes the member.
E
Edits the member.
G
Resets the member.
J
Submits the member.
M
Moves the member.
P
Prints the member.
R
Renames the member. When using this command, you must also enter the
new name to the right of the member name.
T
TSO command.
V
Views the member.
W
WS command.
TSO commands, CLISTs, and REXX EXECs can be entered in member lists that
have an expanded line command field. These are member lists displayed by using
option M of the Data Set List utility. Here, any command other than B, D, E, P, R,
or V is considered to be a TSO command, CLIST, or REXX EXEC.
Chapter 1. ISPF General Information
11
PDF Component General Information
PDF Data Set List Commands
Primary Commands
You can enter the following commands on the command line on option 3.4 data set
list displays.
APPEND
CONFIRM [ON | OFF]
CON
C
DSLIST
EXCLUDE
FIND string [NEXT ]
F
[ALL ]
[FIRST]
[LAST ]
[PREV ]
[CHARS ]
[PREFIX]
[SUFFIX]
[WORD ]
LC
LOCATE lparm
LOC
L
REFRESH
RESET
RFIND
SAVE [list-id]
SHOWCMD [ON | OFF]
SHOW
SORT [field1[field2]]
VA
VS
VT
VW
Line Commands
On option 3.4 data set list displays, you can enter the following 1-character
commands at the beginning of a line. Any other command entered at the
beginning of a line is considered to be a TSO command, CLIST, or REXX EXEC.
12
B
For a library or partitioned data set, displays a member list. You can then
use the S command to select a member to browse. For a sequential data
set, displays the data set in browse mode.
C
Catalogs the data set.
CO
Copies a data set.
D
Deletes an entire data set. Displays a Confirm Delete panel if you request
confirmation.
z/OS V1R7.0 ISPF Reference Summary
PDF Component General Information
E
For a library or partitioned data set, displays a member list. You can then
use the S command to select a member to edit. For a sequential data set,
displays the data set in edit mode.
F
Frees unused space in a data set.
I
Displays library or data set information.
M
For a library or partitioned data set, displays a member list.
MO
Moves a data set.
NX
Unexclude a line from display.
NXF
Unexclude the first of a set of excluded data sets.
NXL
Unexclude the last of a set of excluded data sets.
P
Prints the library or data set.
PX
Prints an index listing.
R
Displays a panel, on which you can rename the library or data set.
RA
Adds a data set to a reference list.
RS
Resets statistical data.
S
Displays library or data set information in short format.
U
Uncatalogs the data set.
V
For a library or partitioned data set, displays a member list. You can then
use the S command to select a member to view. For a sequential data set,
displays the data set in view mode.
X
Excludes a data set from the list.
Z
Compresses a library or data set.
=
Repeats the last line command entered.
PDF Edit and View Commands
Primary Commands
While you are using the PDF editor to edit or view data, the following commands
can be entered on the command line.
AUTOLIST [ON ]
[OFF]
AUTONUM [ON ]
[OFF]
AUTOSAVE [ON
]
[OFF PROMPT ]
[OFF NOPROMPT]
BOUNDS [left-col right-col]
BOUND
BNDS
BND
BROWSE [member]
BUILTIN cmdname
CANCEL
Chapter 1. ISPF General Information
13
PDF Component General Information
CAN
CAPS [ON ]
[OFF]
CHANGE str-1 str-2 [range] [NEXT ]
CHG
[ALL ]
CHA
[FIRST]
C
[LAST ]
[PREV ]
[CHARS ] [X ] [col-1 [col-2]]
[PREFIX] [NX]
[SUFFIX]
[WORD ]
COLS
[ON ]
COLUMNS [OFF]
COL
COMPARE
[DSNAME ] [EXCLUDE ] [SAVE ] [SYSIN] [NEXT]
COPY [member] [AFTER label ]
[BEFORE label]
CREATE [member] [range]
CRE
CUT [lptr-range ] [DEFAULT | clipboardname ] [REPLACE ] [DISPLAY ]
DEFINE name {MACRO CMD }
DEF
{MACRO PGM }
{ALIAS name-2}
{NOP
}
{RESET
}
{DISABLED
}
DELETE {ALL X|NX }
DEL
{range X|NX }
{ALL range}
EDIT [member]
EDITSET
EDSET
END
EXCLUDE str [range] [NEXT ]
EXC
[ALL ]
EX
[FIRST]
X
[LAST ]
[PREV ]
FIND str [range] [NEXT ]
F
[ALL ]
[FIRST]
[LAST ]
[PREV ]
[CHARS ] [col-1 [col-2]]
[PREFIX]
[SUFFIX]
[WORD ]
[CHARS ] [X ] [col-1 [col-2]]
[PREFIX] [NX]
[SUFFIX]
[WORD ]
FLIP [label1] [label2]
HEX [ON DATA]
[ON VERT]
[OFF
]
HIDE X
HILITE [ON
]
HI
[OFF
]
[LOGIC ]
[IFLOGIC]
[DOLOGIC]
14
z/OS V1R7.0 ISPF Reference Summary
[AUTO ] [RESET] [PAREN] [FIND] [CURSOR] [SEARCH] [DISABLED]
[DEFAULT]
[OTHER ]
[ASM
]
[BOOK ]
PDF Component General Information
|
|
[NOLOGIC] [C
[COBOL
[DTL
[HTML
[IDL
[JCL
[PANEL
[PASCAL
[PLI
[REXX
[SKEL
[SUPERC
[XML
]
]
]
]
]
]
]
]
]
]
]
]
]
IMACRO [name|NONE]
LEVEL num
LEV
LOCATE {label
}
LOC
{line-number}
L
LOCATE [FIRST] {CHANGE } [range]
LOC
[LAST ] {COMMAND }
L
[NEXT ] {ERROR }
[PREV ] {EXCLUDED}
{LABEL }
{SPECIAL }
MODEL [CLASS [class-name]]
MOD
MODEL [model-name [qualifier...]] {AFTER label } [NOTE ]
MOD
{BEFORE label} [NONOTE]
MOVE [member] [AFTER label ]
[BEFORE label]
NONUMBER
NOTES [ON ]
NOTE [OFF]
NULLS [ON STD]
NULL [ON ALL]
NUL [OFF ]
NUMBER [ON ] [STD
] [DISPLAY]
NUMB [OFF] [COBOL
]
NUM
[STD COBOL]
[STD COBOL]
[NOSTD]
[NOCOBOL]
[NOSTD NOCOBOL]
PACK [ON ]
[OFF]
PASTE [clipboardname] [AFTER label][BEFORE label] [KEEP]
PRESERVE
PROFILE [name] [number]
PROF
PRO
PR
PROFILE RESET
Chapter 1. ISPF General Information
15
PDF Component General Information
PROF
PRO
PR
PROFILE [LOCK | UNLOCK]
PROF
PRO
PR
RCHANGE
RECOVERY [ON | OFF]
RECOVER [WARN | NOWARN | SUSP]
RECOV
REC
RENUM [ON ] [STD
] [DISPLAY]
[COBOL
]
[STD COBOL]
REN
REPLACE [member] [range]
REPL
REP
RESET [CHANGE ] [range]
RES [COMMAND ]
[ERROR ]
[EXCLUDED]
[FIND
]
[HIDE
]
[LABEL ]
[SPECIAL ]
RFIND
RMACRO [name|NONE]
SAVE
SETUNDO [STORAGE | RECOVER | OFF]
SETU
SORT [range] [X ] [sort-field1...sort-field5]
[NX]
STATS [mode]
SUBMIT [range]
SUB
TABS [ON ] [STD]
TAB [OFF] [ALL]
[tab-character]
UNDO
UNNUMBER
UNNUM
UNN
VERSION num
VERS
VER
VIEW [member]
16
z/OS V1R7.0 ISPF Reference Summary
PDF Component General Information
Line Commands
Under Edit or View, you can enter the following line commands at the beginning
of a line by typing over the line number. If you do not enter a value of n, the
default is 1 except for:
v The shift commands, which default to 2 column positions
v The TE command, which defaults to the number of lines remaining on the
screen
v The TF command, which defaults to the current right boundary.
<[n | 2]
<<[n | 2]
>[n | 2]
>>[n | 2]
([n | 2]
(([n | 2]
)[n | 2]
))[n | 2]
A[n]
B[n]
BOUNDS
BOUND
BNDS
BND
C[n]
CC
COLS
COL
D[n]
DD
F[n]
I[n]
L[n]
LC[n]
LCC
LCLC
M[n]
MM
MASK
MD
MDD
MDMD
O[n]
OO
R[n]
RR[n]
S[n]
TABS
TAB
TE[n]
TF[n]
Shifts data left the specified number of positions (default 2).
Shifts data right the specified number of positions (default 2).
Shifts columns left the specified number of positions (default 2).
Shifts columns right the specified number of positions (default 2).
Identifies the line after which copied, moved, or model lines are to be
inserted.
Identifies the line before which copied, moved, or model lines are to be
inserted.
Displays the column boundary definition line.
Copies one or more lines from one location to another.
Displays a position identification line.
Deletes one or more lines.
Redisplays one or more lines at the beginning of a block of excluded
lines.
Inserts a blank data entry line.
Redisplays one or more lines at the end of a block of excluded lines.
Converts all uppercase alphabetic characters in one or more lines to
lowercase.
Moves one or more lines from one location to another.
Displays the contents of the mask when used with the I (insert), TE (text
entry), and TS (text split) line commands.
Makes NOTE, MSG, INFO, and COLS lines into data lines.
Rearranges a single column list of items into multiple column, or
tabular, format.
Repeats one or more lines.
Redisplays one or more lines with the leftmost indentation in a block of
excluded lines.
Displays the tab definition line.
Inserts blank lines to allow power typing for text entry.
Restructures paragraphs following deletions, insertions, splitting, and so
forth.
Chapter 1. ISPF General Information
17
PDF Component General Information
TS[n]
UC[n]
UCC
UCUC
Divides a line so that data can be added.
Converts all lowercase alphabetic characters in one or more lines to
uppercase.
X[n]
XX
Excludes one or more lines from a panel.
Search Strings
Picture Strings – Special Characters for String-1:
P’=’
Any character
P’¬’
Any character that is not a blank
P’.’
Any character that cannot be displayed
P’#’
Any numeric character, 0-9
P’-’
Any nonnumeric character
P’@’
Any alphabetic character, uppercase or lowercase
P’<’
Any lowercase alphabetic character
P’>’
Any uppercase alphabetic character
P’$’
Any special character, neither alphabetic nor numeric.
If you are using an APL or TEXT keyboard, you can use the following additional
characters in a picture string:
P’
P’_’
’
Any APL-specific or TEXT-specific character
Any underscored nonblank character.
Picture Strings – Special Characters for String-2
P’=’
Equal to the corresponding character in string-1
P’>’
Converts the corresponding character in string-1 to uppercase
P’<’
Converts corresponding character in string-1 to lowercase.
Character String Format
18
Simple string:
cccccc (no embedded blanks or commas)
Delimited string:
’ccccc’ or "ccccc"
Hex string:
X’hhhh’ or ’hhhh’X
Text string:
T’cccc’ or ’cccc’T
Picture string:
P’ssss’ or ’ssss’P
Character string:
C’cccc’ or ’cccc’C
Previous string:
* (single asterisk)
z/OS V1R7.0 ISPF Reference Summary
Chapter 2. ISPF Service Syntax with Return Codes
This chapter contains the ISPF services. The services are presented in alphabetical
order. For each service, the command procedure format is shown, followed by the
PL/I call formats. For more complete information, see the z/OS ISPF Services Guide.
Each service description consists of the following information:
Format
The syntax used to code the service, showing both command
invocation and call invocation.
Return Codes A description of the codes returned by the service. For all services,
a return code of 12 or higher implies a severe error. This error is
usually a syntax error, but can be any severe error detected when
using the services.
Syntax Notation
In this manual, the following syntax notation conventions are used:
v Uppercase commands and their operands should be spelled as shown, but need
not be entered in uppercase. Operands shown in lowercase are variables; a value
should be substituted for them.
v Operands shown in brackets [ ] are optional, with a choice indicated by vertical
bars |. One or none can be chosen; the defaults are underscored.
v Operands shown in braces { } are alternatives; one must be chosen.
v An ellipsis (...) indicates that the parameter shown can be repeated to specify
additional items of the same category.
ISPEXEC Command Invocation
The general format for a command invocation is:
ISPEXEC service-name parameter1 parameter2 parameter3 ...
ISPEXEC Parameter Conventions
service-name
Alphabetic; up to 8 characters long.
parameter1
Positional parameter; required for some services.
parameter2 parameter3 ...
Keyword parameters. They can take either of two forms:
keyword
or
keyword(value)
The ISPLINK Interface
For calls in PL/I or COBOL, the general call format for invoking ISPF services
from functions by using ISPLINK is:
CALL ISPLINK (service-name, parameter1, parameter2, ...);
© Copyright IBM Corp. 1989, 2005
19
ISPF Service Syntax
CALL ISPLINK Parameters
These parameters are positional. They must appear in the order described for each
service.
Parameters shown inside brackets ([ ]) are optional, but ISPF assumes default
values for those parameters you do not choose.
If you want to omit a parameter, you must still account for it by inserting a blank
enclosed in single quotes (’ ’) in its place. This is how you would omit parm2
from this sample call:
CALL ISPLINK (service-name, parm1, ’ ’, parm3);
If you need only the first few of a list of parameters, you must omit all other
parameters to the right of the last parameter you need. For example, if you are
using a service that has five parameters, but you need to use only the first three,
code it like this:
CALL ISPLINK (service-name, parm1, parm2, parm3);
You must show the last parameter in the calling sequence with a ‘1’ as the high
order bit in the last entry of the address list. PL/I, COBOL, Pascal, and FORTRAN
call statements automatically generate this high-order bit. However, you must use
the VL keyword in assembler call statements.
The ISPEXEC Interface
You can use the command function form for service requests in a program function
by using the call format of ISPEXEC. Excluding calls in FORTRAN, Pascal, and
APL2®, the general call format for invoking ISPF services from program functions
by using ISPEXEC is:
CALL ISPEXEC (buf-len, buffer);
CALL ISPEXEC Parameters
buf-len
Specifies a fullword fixed binary integer containing the length of the buffer.
buffer
Specifies a buffer containing the name of the service and its parameters just as
they would appear in an ISPEXEC invocation for a command invocation
written in CLIST.
The maximum buffer size is 32767 bytes.
All services that are valid through ISPEXEC command invocation statements are
valid through the CALL ISPEXEC interface.
ISPF Services
ADDPOP – Start Pop-Up Window Mode
Command Invocation Format
ISPEXEC ADDPOP [POPLOC(field-name)] [ROW(row)]
[COLUMN(column)]
20
z/OS V1R7.0 ISPF Reference Summary
ADDPOP service
Call Invocation Format
CALL ISPEXEC (buf-len, buffer);
OR
CALL ISPLINK (’ADDPOP ’ [,field-name] [,row]
[,column ] );
Return Codes
0
12
20
Normal completion.
An ADDPOP service call was issued before the panel was displayed or
another ADDPOP service call was issued before a panel was displayed for
the previous ADDPOP call.
Severe error.
BRIF – Browse Interface
Command Invocation Format
Command procedures cannot be used to invoke this service.
Call Invocation Format
CALL ISPLINK (’BRIF
’,[data-name] ,rec-format
,rec-len ,read-routine
,[cmd-routine] ,[dialog-data]
,[panel-name] ,[format-name]
,[’YES
’|’NO
’]);
Return Codes
Read Routine:
0
Normal completion.
4
Temporary end of file.
8
Record requested beyond end of data. The relative record number of the
last data record and a pointer to the last data record are returned.
16
Read error. Browse data obtained up to the read error is formatted and
displayed with an indication that a read error was encountered.
20
Severe error. (The BRIF service terminates immediately with a return code
of 20.)
Command Routine:
0
Normal completion.
4
The PDF component should process the requested function.
12
Command deferred; retain the command on the Command line. Browse
data is redisplayed.
20
Severe error. (The BRIF service terminates immediately with a return code
of 20.)
BRIF service:
0
Normal completion.
12
No data to browse.
16
Unexpected return code received from a dialog-supplied routine; unable to
continue. When an unexpected return code is received, the BRIF service
terminates immediately with a return code of 16.
20
Severe error; unable to continue.
Chapter 2. ISPF Service Syntax with Return Codes
21
BROWSE service
BROWSE – Browse a Data Set
Command Invocation Format
ISPEXEC BROWSE DATASET(dsname)
[VOLUME(serial)]
[PASSWORD(pswd-value)]
[PANEL(panel-name)]
[FORMAT(format-name)]
[MIXED(YES|NO)]
OR
ISPEXEC BROWSE DATAID(data-id)
[MEMBER(member-name)]
[PANEL(panel-name)]
[FORMAT(format-name)]
[MIXED(YES|NO)]
Call Invocation Format
CALL ISPLINK (’BROWSE ’,{dsname},[serial]
,[pswd-value]
,[panel-name]
,{data-id}
,[member-name]
,[format-name]
,[’YES
’|’NO
’];
OR
CALL ISPEXEC (buf-len, buffer);
Return Codes
0
12
14
16
18
20
Normal completion.
Zero-length data; empty sequential data set or zero-length member of a
partitioned data set.
Specified member not found.
One of the following:
v No members matched the specified pattern.
v No members in the partitioned data set.
A VSAM data set was specified but the ISPF Configuration Table does not
allow VSAM processing.
Severe error; unable to continue.
CONTROL – Set Processing Modes
Command Invocation Format
ISPEXEC CONTROL {
{
{
{
{
{
{
{
{
{
{
{
{
{
{
{
{
{
22
z/OS V1R7.0 ISPF Reference Summary
DISPLAY {
{
{
{
{
{
LOCK
LINE [START(line-number)]
SM [START(line-number)]
REFRESH
SAVE|RESTORE
ALLVALID
}
}
}
}
}
}
}
}
}
}
}
}
}
NONDISPL [ENTER|END][NOSETMSG]}
ERRORS
SPLIT
[CANCEL|RETURN]
{ ENABLE }
{ DISABLE }
NOCMD
SUBTASK { PROTECT }
{ CLEAR }
}
}
}
}
}
}
}
}
}
}
CONTROL service
{
{ TSOGUI [QUERY|OFF|ON]
{ REFLIST [UPDATE|NOUPDATE]
}
}
}
Call Invocation Format
CALL ISPEXEC (buf-len, buffer);
OR
CALL ISPLINK (’CONTROL ’, operand);
Note: parameters that can appear in operand are:
{
{
{
{
{
{
{
{
{
{
{
{
{
{
{
{
{
{
{
’DISPLAY ’{
{
{
{
{
{
’NONDISPL’
’ERRORS ’
’SPLIT
’
’NOCMD
’
’SUBTASK ’
’TSOGUI ’
{ ’REFLIST
,’LOCK
’
,’LINE
’ [,line-number]
,’SM
’ [,line-number]
,’REFRESH ’
,’SAVE
’|’RESTORE ’
,’ALLVALID’
}
}
}
}
}
}
}
}
}
}
}
}
}
[,’ENTER ’|’END
’]
}
}
[,’CANCEL ’|’RETURN ’][NOSETMSG]
}
{ ,’ENABLE ’ }
}
{ ,’DISABLE ’ }
}
}
}
}
{ ,’PROTECT ’ }
}
{ ,’CLEAR ’ }
}
[,’QUERY’|’OFF
’|’ON
’]}
’ [,’UPDATE’|’NOUPDATE’]
}
}
Return Codes
0
8
20
Normal completion.
Split-screen mode already in effect. Applies only to a SPLIT DISABLE
request. Split-screen mode remains enabled.
Severe error.
DISPLAY – Display Panels and Messages
Command Invocation Format
ISPEXEC DISPLAY [PANEL(panel-name)]
[MSG(message-id)]
[CURSOR(cursor-field-name)]
[CSRPOS(cursor-position)]
[COMMAND(stack-buffer-name)
[RETBUFFR(ret-buffer-name)]
[RETLGTH(ret-length-name)]
[MSGLOC(message-field-name)]]
Call Invocation Format
CALL ISPEXEC (buf-len, buffer);
OR
CALL ISPLINK (’DISPLAY ’ [,panel-name]
[,message-id]
[,cursor-field-name]
[,cursor-position]
[,stack-buffer-name]
Chapter 2. ISPF Service Syntax with Return Codes
23
DISPLAY service
[,ret-buffer-name]
[,ret-length-name]
[,message-field-name]]);
Return Codes
0
4
8
12
16
20
Normal completion. For the COMMAND option, the ret-buffer-name is set
to blanks and the ret-length-name is set to zero. Passing an empty
command chain buffer also results in a normal completion.
One or more commands in the stack could not be found in the active set of
command tables.
User requested termination via the END or RETURN command. For panels
generated with the tag conversion utility, CANCEL and EXIT commands
also give a return code of 8.
The specified panel, message, cursor field, or message location field could
not be found.
Truncation or translation error in storing defined variables.
Severe error.
DSINFO – Data Set Information Dialog
Command Invocation Format
ISPEXEC DSINFO DATASET(dsname)
[VOLUME(serial)]
Call Invocation Format
CALL ISPEXEC (buf-len, buffer);
OR
CALL ISPLINK (’DSINFO ’ [,dsname]
[,serial]
Return Codes
0
8
12
20
Normal completion.
User requested data set was not found.
One of the following:
v FAMS error.
v Obtain error.
v Error obtaining directory information.
Severe error; unable to continue.
EDIF – Edit Interface
Command Invocation Format
Command procedures cannot be used to invoke this service.
Call Invocation Format
CALL ISPLINK (’EDIF
’,[data-name] ,profile-name
,rec-format ,rec-len
,read-routine, write-routine
,[cmd-routine] ,[dialog-data]
,[edit-len] ,[panel-name]
,[macro-name] ,[format-name]
,[’YES
’|’NO
’]
,[’YES
’|’NO
’]
,[parm-var]);
OR
CALL ISPLINK (’EDIF
24
z/OS V1R7.0 ISPF Reference Summary
’,[data-name] ,’ ’
,[rec-format] ,[rec-len]
,read-routine ,write-routine
EDIF service
,[cmd-routine] ,[dialog-data]
,’ ’ ,’ ’ ,’ ’ ,’ ’ ,’ ’
,’YES
’);
Return Codes
Read Routine:
0
Normal completion.
8
End of data records (no data record returned).
16
Read error. If a read error is encountered when building the initial edit
display, the EDIF service terminates with a return code of 20. Otherwise,
the edit data is redisplayed.
20
Severe error. (EDIF service terminates immediately with a return code of
20.)
Write Routine Return Codes:
0
Normal completion.
16
Output error, return to Edit mode.
20
Severe error. (EDIF service terminates immediately with a return code of
20).
Command Routine Return Codes:
0
Normal completion.
4
The PDF component should process the requested function.
12
Command deferred; retain the command on the Command line. Edit data
is redisplayed.
20
Severe error. (EDIF service terminates immediately with a return code of
20.)
EDIF Return Codes:
0
Normal completion, data saved.
4
Normal completion, data not saved.
16
Unexpected return code received from a dialog-supplied routine. When an
unexpected return code is received, the EDIF service terminates
immediately with a return code of 16.
20
Severe error; unable to continue.
EDIREC – Initialize Edit Recovery
Command Invocation Format
Command procedures cannot be used to invoke this service.
Call Invocation Format
CALL ISPLINK (’EDIREC ’, {’INIT
{’QUERY
{’CANCEL
{’DEFER
’[,command-name]}
’}
’}
’});
Return Codes
0
4
20
Normal completion.
v INIT - EDIF recovery table was successfully created.
v QUERY - Recovery is not pending.
Normal completion.
v INIT - EDIF recovery table already exists for current application
v QUERY - Entry found in EDIF recovery table (recovery is pending).
Severe error; unable to continue.
Chapter 2. ISPF Service Syntax with Return Codes
25
EDIT service
EDIT – Edit a Data Set
Command Invocation Format
ISPEXEC EDIT DATASET(dsname) [VOLUME(serial)]
[PASSWORD(pswd-value)]
[PANEL(panel-name)]
[MACRO(macro-name)]
[PROFILE(profile-name)]
[FORMAT(format-name)]
[MIXED(YES|NO)]
[LOCK(YES|NO)]
[CONFIRM(YES|NO)]
[WS(YES|NO)]
[PRESERVE]
[PARM(parm-var)]
OR
ISPEXEC EDIT DATAID(data-id) [MEMBER(member-name)]
[PANEL(panel-name)]
[MACRO(macro-name)]
[PROFILE(profile-name)]
[FORMAT(format-name)]
[MIXED(YES|NO)]
[LOCK(YES|NO)]
[CONFIRM(YES|NO)]
[WS(YES|NO)]
[PRESERVE]
[PARM(parm-var)]
OR
ISPEXEC EDIT WSFN(ws-filename) [PANEL(panel-name)]
[MACRO(macro-name)]
[PROFILE(profile-name)]
[FORMAT(format-name)]
[MIXED(YES|NO)]
[LOCK(YES|NO)]
[CONFIRM(YES|NO)]
[WS(YES|NO)]
[PRESERVE]
[PARM(parm-var)]
Call Invocation Format
CALL ISPLINK (’EDIT
’, {dsname} ,[serial]
,[pswd-value]
,[panel-name]
,[macro-name]
,[profile-name]
,{data-id}
,[member-name]
,[format-name]
,[’YES
’|’NO
’]
,[’YES
’|’NO
’]
,[’YES
’|’NO
’]
,{ws-filename-buffer-name}
,[’YES’|’NO’]
,[’PRESERVE’]
, ’ ’
, [parm-var]);
OR
CALL ISPEXEC (buf-len, buffer);
26
z/OS V1R7.0 ISPF Reference Summary
EDIT service
Return Codes
0
4
12
14
16
18
20
Normal completion; data was saved.
Normal completion; data was not saved.
YES was specified for the LOCK parameter.
Member or sequential data set in use.
One of the following:
v No members matched the specified pattern.
v No members in the partitioned data set.
A VSAM data set was specified but the ISPF Configuration Table does not
allow VSAM processing.
Severe error; unable to continue.
EDREC – Specify Edit Recovery Handling
Command Invocation Format
ISPEXEC EDREC {INIT
[CMD(command-name)]}
{QUERY }
{PROCESS [PASSWORD(pswd-value)]
[DATAID(data-id)]}
{CANCEL }
{DEFER }
Call Invocation Format
CALL ISPLINK (’EDREC
’ {,’INIT
{,’QUERY
{,’PROCESS
{,’CANCEL
{,’DEFER
’ [,command-name]}
’}
’ [,pswd-value] [,data-id]}
’}
’});
OR
CALL ISPEXEC (buf-len, buffer);
Return Codes
0
4
20
Normal return.
v INIT - Edit recovery table was successfully created.
v QUERY - Recovery is not pending.
v PROCESS - Recovery was completed and the data was saved.
Normal return.
v INIT - Edit recovery table already exists for current application.
v QUERY - Entry found in edit recovery table; recovery is pending.
v PROCESS - Recovery was completed, but user did not save data.
Severe error; unable to continue.
FILESTAT – Statistics for a file
Command Invocation Format
ISPEXEC FILESTAT FILE(var-name)
[LRECL(var-name),DATE(var-name)]
Call Invocation Format
CALL ISPLINK (’FILESTAT’,var-name
,[var-name,var-name])
Return Codes
0
4
Workstation file exists.
Workstation file does not exist.
Chapter 2. ISPF Service Syntax with Return Codes
27
FILESTAT service
8
10
12
20
Error in variable specification.
No workstation connection exists.
Workstation device is not ready.
Severe error in FILESTAT service.
FILEXFER – Upload or download file
Command Invocation Format
ISPEXEC FILEXFER HOST(var-name) WS(var-name) TO(HOST|WS)
[VOLUME(volume)]
[BINARY|TEXT]
[STATS|NOSTATS]
[CHKDATE (YES|NO)]
[SETDATE (YES|SCLM|NO)]
[MAKEPATH (YES|NO)]
Call Invocation Format
CALL ISPEXEC (buf-len, buffer);
OR
CALL ISPLINK (’FILEXFER’,host_var,ws_var,’HOST’|’WS’,
[volume,’BINARY’|’TEXT,
’STATS’|’NOSTATS’,
’YES’|’NO’,
’YES’|’SCLM’|’NO’
’YES’|’NO’,])
Return Codes
2
4
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
Source file and target file have the same date and time.
LMSTAT failed.
Data set not cataloged.
Error in variable specification.
″TO″ direction not valid.
Host name is too long.
No workstation connection exists.
Return code 1 from DTTRANSFER. Host data set had null object handle.
Return code 2 from DTTRANSFER. Workstation file had null object handle.
Return code 3 from DTTRANSFER. Host data set could not be opened.
Return code 4 from DTTRANSFER. Workstation file could not be opened.
Return code 5 from DTTRANSFER. Error reading host data set.
Return code 6 from DTTRANSFER. Error reading workstation file.
Return code 7 from DTTRANSFER. Error writing host data set.
Return code 8 from DTTRANSFER. Error writing workstation file.
Return code 9 from DTTRANSFER. Error closing host data set.
Severe error in transfer service.
Return code 10 from DTTRANSFER. Error closing workstation file.
Return code 11 from DTTRANSFER. User refused file access.
Data set or member in use.
FTCLOSE – End File Tailoring
Command Invocation Format
ISPEXEC FTCLOSE [NAME(member-name)]
[LIBRARY(library)]
[NOREPL]
28
z/OS V1R7.0 ISPF Reference Summary
FTCLOSE service
Call Invocation Format
CALL ISPEXEC (buf-len, buffer);
OR
CALL ISPLINK (’FTCLOSE ’ [,member-name]
[,library]
[,’NOREPL ’]);
Return Codes
0
4
8
12
16
20
Normal completion.
Member already exists in the output library and NOREPL was specified.
The original member is unchanged.
File not open. FTOPEN was not used before FTCLOSE.
Output file in use. ENQ failed.
Skeleton library or output file not allocated.
Severe error.
FTERASE – Erase File Tailoring Output
Command Invocation Format
ISPEXEC FTERASE member-name [LIBRARY(library)]
Call Invocation Format
CALL ISPEXEC (buf-len, buffer);
OR
CALL ISPLINK (’FTERASE ’, member-name [,library]);
Return Codes
0
8
12
16
20
Normal completion.
File does not exist.
Output file in use; ENQ failed.
Alternate output library not allocated.
Severe error.
FTINCL – Include a Skeleton
Command Invocation Format
ISPEXEC FTINCL skel-name [NOFT]
Call Invocation Format
CALL ISPEXEC (buf-len, buffer);
OR
CALL ISPLINK (’FTINCL ’, skel-name [,’NOFT
’] );
Return Codes
0
8
12
Normal completion.
Skeleton does not exist.
Skeleton in use; ENQ failed.
Chapter 2. ISPF Service Syntax with Return Codes
29
FTINCL service
16
20
Data truncation occurred or skeleton library or output file not allocated.
Severe error.
FTOPEN – Begin File Tailoring
Command Invocation Format
ISPEXEC FTOPEN [TEMP]
Call Invocation Format
CALL ISPEXEC (buf-len, buffer);
OR
CALL ISPLINK (’FTOPEN ’ [,’TEMP
’] );
Return Codes
0
8
12
16
20
Normal completion.
File tailoring already in progress.
Output file in use; ENQ failed.
Skeleton library or output file not allocated.
Severe error.
GETMSG – Get a Message
Command Invocation Format
ISPEXEC GETMSG MSG(message-id) [SHORTMSG(short-message-name)]
[LONGMSG(long-message-name)]
[ALARM(alarm-name)]
[HELP(help-name)]
[TYPE(type-name)]
[WINDOW(window-name)]
[CCSID(ccsid-name)]
Call Invocation Format
CALL ISPEXEC (buf-len, buffer);
OR
CALL ISPLINK (’GETMSG ’ ,message-id [,short-message-name]
[,long-message-name]
[,alarm-name]
[,help-name]
[,type-name]
[,window-name]
[,ccsid-name]);
Return Codes
0
12
20
Normal completion.
The specified message could not be found.
Severe error.
GRERROR – Graphics Error Block Service
Command Invocation Format
ISPEXEC *This service does not apply to
command or APL2 procedures*
30
z/OS V1R7.0 ISPF Reference Summary
GRERROR service
Call Invocation Format
CALL ISPEXEC *This service cannot be used
with this interface*
OR
CALL ISPLINK (’GRERROR ’, error-record-pointer,
call-format-descriptor-module-pointer);
Return Codes
0
8
20
Normal completion.
ISPF/ GDDM® interface is not established.
Severe error.
GRINIT – Graphics Initialization
Command Invocation Format
ISPEXEC *This service does not apply to
command or APL2 procedures*
Call Invocation Format
CALL ISPEXEC *This service cannot be used
with this interface*
OR
CALL ISPLINK (’GRINIT ’ ,application-anchor-block
[,panel-name]);
Return Codes
0
8
12
20
Normal completion.
The specified panel does not contain a GRAPHIC area.
The specified panel could not be found.
Severe error.
GRTERM – Graphics Termination Service
Command Invocation Format
ISPEXEC *This service does not apply to
command or APL2 procedures*
Call Invocation Format
CALL ISPEXEC *This service cannot be used
with this interface*
OR
CALL ISPLINK (’GRTERM ’);
Return Codes
0
20
Normal completion.
Severe error.
Chapter 2. ISPF Service Syntax with Return Codes
31
LIBDEF service
LIBDEF – Allocate Application Libraries
Command Invocation Format
ISPEXEC LIBDEF lib-type [DATASET|EXCLDATA|LIBRARY|EXCLLIBR]
[ID(dataset-list)|ID(libname)]
[COND|UNCOND|STACK|STKADD]
Note: The default option is set in the ISPF configuration table keyword
DEFAULT_LIBDEF_PROCESSING_OPTION. By default this keyword is set
to UNCOND.
|
|
|
Call Invocation Format
CALL ISPEXEC (buf-len, buffer);
OR
CALL ISPLINK (’LIBDEF ’, lib-type
[,’DATASET ’|’EXCLDATA’|’LIBRARY ’|’EXCLLIBR’]
[,dataset-list|libname]
[,’COND
’|’UNCOND ’]|’STACK ’|’STKADD ’);
Note: The default option is set in the ISPF configuration table keyword
DEFAULT_LIBDEF_PROCESSING_OPTION. By default this keyword is set
to UNCOND.
|
|
|
Return Codes
0
4
|
8
12
16
20
Normal completion.
When removing the application library: Application library does not exist
for this type.
When STKADD is specified: There is no existing stack.
When COND is used: Application library already exists for this type.
ISPPROF was specified as the lib-type; invalid lib-type specified with
EXCLDATA or EXCLLIBR.
A libname was not allocated, or the dataset-list contains an invalid MVS
dsname.
Severe error.
LIST – Write Lines to the List Data Set
Command Invocation Format
ISPEXEC LIST
BUFNAME(dialog-variable-name)
LINELEN(line-length)
[PAGE]
[SINGLE|DOUBLE|TRIPLE]
[OVERSTRK]
[CC]
Call Invocation Format
CALL ISPEXEC (buf-len, buffer);
OR
CALL ISPLINK
32
z/OS V1R7.0 ISPF Reference Summary
(’LIST
’, dialog-variable-name, line-length
[,’PAGE
’]
[,’SINGLE ’|’DOUBLE ’|’TRIPLE ’]
[,’OVERSTRK’]
[,’CC
’]);
LIST service
Return Codes
0
8
12
20
Normal completion.
Maximum line length or data set LRECL exceeded; data has been
truncated.
Specified dialog variable not found.
Severe error.
LMCLOSE – Close a Data Set
Command Invocation Format
ISPEXEC LMCLOSE DATAID(data-id)
Call Invocation Format
CALL ISPLINK (’LMCLOSE ’,data-id);
OR
CALL ISPEXEC (buf-len, buffer);
Return Codes
0
8
10
20
Normal completion.
Data set is not open.
No ISPF library or data set is associated with the given data ID; that is,
LMINIT has not been completed.
Severe error; unable to continue.
LMCOMP – Compresses a Partitioned Data Set
Command Invocation Format
ISPEXEC LMCOMP DATAID(data-id)
Call Invocation Format
CALL ISPLINK (’LMCOMP ’,data-id);
OR
CALL ISPEXEC (buf-len,buffer);
Return Codes
0
10
12
20
Successful completion.
No data set is associated with the given data ID.
One of the following:
v Data set not partitioned.
v Data set specified not allocated.
v Data set is open.
v Data set is not movable.
v Data set must be allocated exclusively. Use ENQ(EXCLU) in LMINIT
service
v Concatenated libraries are not allowed for LMCOMP
Severe error; unable to continue.
Chapter 2. ISPF Service Syntax with Return Codes
33
LMCOPY service
LMCOPY – Copy Members of a Data Set
Command Invocation Format
ISPEXEC LMCOPY FROMID(from-data-id)
[FROMMEM(from-member-name)]
TODATAID(to-data-id)
[TOMEM(to-member-name)]
[REPLACE]
[PACK]
[TRUNC]
[LOCK]
[SCLMSET(YES|NO)]
[ALIAS|NOALIAS]
Call Invocation Format
CALL ISPLINK (’LMCOPY ’, from-data-id
,[from-member-name]
,to-data-id
,[to-member-name]
,[’REPLACE ’]
,[’PACK
’]
,[’TRUNC ’]
,[’LOCK
’]
,[’YES
’|’NO
’|’ ’]
,[’ALIAS ’|’NOALIAS ’]);
OR
CALL ISPEXEC (buf-len,buffer);
Return Codes
0
4
8
10
12
16
20
34
Normal completion.
Member not available:
v The member is in a controlled ISPF library and is currently owned by
another user.
v The member is in a controlled ISPF library and the user is not a valid
user as specified by member access ID.
v Lock was requested but the project is SCLM-controlled.
v “From” library not LMF-controlled.
v “From” data set is empty.
v No members matched the specified pattern in the “from” data set.
“From” member not found.
No data set is associated with the given data ID.
One of the following:
v Invalid data set organization.
v Data set attribute invalid for copying or copying packed data.
v Open error.
v A like named member already exists in the ’TO’ data set, and the
Replace option was not specified.
v One or more members of the ’TO’ data set are “in use” by you or
another user and could not be copied.
Truncation error.
Severe error; unable to continue.
z/OS V1R7.0 ISPF Reference Summary
LMDDISP service
LMDDISP – Data Set Display Service
Command Invocation Format
ISPEXEC LMDDISP LISTID(dslist-id)
[VIEW(VOLUME|SPACE|ATTRIB|TOTAL)]
[CONFIRM(YES|NO)]
[PANEL(panel-name)]
Call Invocation Format
CALL ISPEXEC (buf-len,buffer);
OR
CALL ISPLINK(’LMDDISP ’,
,
,
,
dslist-id
[’VOLUME ’|’SPACE
[’YES
’|’NO
[panel-name]);
’|’ATTRIB ’|’TOTAL
’]
’]
Return Codes
0
10
12
20
Normal completion.
A data set list does not exist for the list-id specified via keyword LISTID.
Invalid parameter value.
A severe error occurred while processing the data set list.
LMDFREE – Free a Data Set List
Command Invocation Format
ISPEXEC LMDFREE LISTID(list-id-var)
Call Invocation Format
CALL ISPLINK (’LMDFREE ’,list-id);
OR
CALL ISPEXEC (buf-len, buffer);
Return Codes
0
8
10
20
Normal completion.
Free dslist-id failed. The error condition is described in “Dialog Error” on
page 139.
No data set level or volume is associated with the given dslist-id.
LMDINIT has not been completed.
Severe error; unable to continue.
LMDINIT – Initialize a Data Set List
Command Invocation Format
ISPEXEC LMDINIT LISTID(dslist-id-var)
{LEVEL(dsname-level)}
{VOLUME(volume-serial)}
Call Invocation Format
CALL ISPLINK (’LMDINIT ’ ,dslist-id-var
,{dsname-level}
,{volume-serial} );
Chapter 2. ISPF Service Syntax with Return Codes
35
LMDINIT service
OR
CALL ISPEXEC (buf-len, buffer);
Return Codes
0
8
12
16
20
Normal completion. The unique dslist-id is returned in the variable
specified in keyword LISTID.
Dslist-id not created; the error condition is described “Dialog Error” on
page 139.
A keyword value is incorrect.
Truncation or translation error in accessing dialog variables.
Severe error; unable to continue.
LMDLIST – List a Data Set
Command Invocation Format
ISPEXEC LMDLIST LISTID(dslist-id)
OPTION(LIST|FREE|SAVE)
DATASET(dataset-var)
[STATS(Yes|NO)]
[GROUP(group)]
Call Invocation Format
CALL ISPLINK (’LMDLIST ’ ,dslist-id
,’LIST
’|’FREE
,dataset-var
,[’YES
’|’NO
,[group]
’|’SAVE
’
’]
OR
CALL ISPEXEC (buf-len, buffer);
Return Codes
0
4
8
10
12
16
20
One of the following:
v LIST option - Normal completion. The name of the next data set in the
list is returned in the variable specified in keyword DATASET. Data set
statistics are returned, if requested.
v FREE option - Normal completion. The internal storage associated with
the data set is freed.
v SAVE option - Normal completion. The data set list has been
successfully written to a data set.
No data sets matched specified search criteria (the values for keywords
LEVEL and VOLUME on the LMDINIT service).
End of data set list.
Data set list does not exist for list-id.
A keyword value is incorrect.
Truncation or translation error in accessing dialog variables.
Severe error; unable to continue.
LMERASE – Erase a Data Set
Command Invocation Format
ISPEXEC LMERASE {PROJECT(project)
GROUP(group)
TYPE(type)
}
36
z/OS V1R7.0 ISPF Reference Summary
LMERASE service
{DATASET(dataset)}
[PURGE(YES|NO)]
[VOLUME(volume)]
[PASSWORD(password)]
Call Invocation Format
CALL ISPLINK(’LMERASE ’,{project
,group
,type
}
,{dataset}
,[’YES
’|’NO
,[volume]
,[password]);
’]);
OR
CALL ISPEXEC (buf-len, buffer);
Return Codes
0
8
12
20
Normal completion.
One of the following:
v Specified data set is not cataloged.
v Erase data set failed.
v Data set has not expired yet.
v Data set name is an alias.
v No data set specified as input
v PROJECT specified, but GROUP or TYPE not specified.
Expiration data not expired and PURGE (NO) specified.
Severe error; unable to continue.
LMFREE – Free Data Set from its Association with Data ID
Command Invocation Format
ISPEXEC LMFREE DATAID(data-id)
Call Invocation Format
CALL ISPLINK (’LMFREE ’,data-id);
OR
CALL ISPEXEC (buf-len, buffer);
Return Codes
0
8
10
20
Normal completion.
Free data ID failed; the error condition is described “Dialog Error” on page
139.
No ISPF library or data set is associated with the given data ID; that is,
LMINIT has not been completed.
Severe error; unable to continue.
LMGET – Read a Logical Record from a Data Set
Command Invocation Format
ISPEXEC LMGET DATAID(data-id)
MODE(MOVE|LOCATE|INVAR|MULTX)
DATALOC(dataloc-var)
DATALEN(datalen-var)
MAXLEN(max-length)
Chapter 2. ISPF Service Syntax with Return Codes
37
LMGET service
Call Invocation Format
CALL ISPLINK (’LMGET
’,data-id
,’MOVE
’|’LOCATE ’|’INVAR
,dataloc-var
,datalen-var
,max-length);
’|’MULTX
’
OR
CALL ISPEXEC (buf-len, buffer);
Return Codes
0
8
10
12
16
20
Normal completion.
End-of-data set condition; no message formatted.
No ISPF library or data set associated with the given data ID; that is,
LMINIT has not been completed.
One of the following:
v The data set is not open or is not open for input.
v An LMMFIND was not done for a partitioned data set.
v The parameter value is invalid.
Truncation or translation error in accessing dialog variables.
Severe error; unable to continue.
LMINIT – Generate a Data ID for a Data Set
Command Invocation Format
ISPEXEC LMINIT DATAID(data-id-var)
{PROJECT(project) GROUP1(group1) TYPE(type)
[GROUP2(group2)] [GROUP3(group3)] [GROUP4(group4)]}
{DATASET(dsname)
}
{DDNAME(ddname)
}
[VOLUME(serial)] [PASSWORD(password)]
[ENQ(SHR|EXCLU|SHRW|MOD)] [ORG(org-var)]
Call Invocation Format
CALL ISPLINK (’LMINIT ’, data-id-var
,{project,group1 [,group2]
[,group3] [,group4] ,type}
,{dsname
}
,{ddname
}
,[serial] ,[password]
,[’SHR
’|’EXCLU ’|’SHRW
’|’MOD
’] ,[org-var]);
OR
CALL ISPEXEC (buf-len,buffer);
Return Codes
0
8
12
16
20
38
Normal completion.
Data ID not created.
The parameter value is invalid.
Truncation or translation error in accessing dialog variables.
Severe error; unable to continue.
z/OS V1R7.0 ISPF Reference Summary
LMMADD service
LMMADD – Add a Member to a Data Set
Command Invocation Format
ISPEXEC LMMADD DATAID(data-id)
MEMBER(member-name)
[STATS(YES|NO)]
[NOENQ]
Call Invocation Format
CALL ISPLINK (’LMMADD ’,data-id
,member-name
,[’YES
’|’NO’])
,[’NOENQ’]);
OR
CALL ISPEXEC (buf-len, buffer);
Return Codes
0
4
10
12
14
16
20
Normal completion.
Directory already contains the specified name.
No ISPF library or MVS data set is associated with the given data ID; that
is, LMINIT has not been completed.
One of the following:
v The data set is not open or is not open for output.
v The parameter value is invalid.
v The data set organization is invalid.
v The values for some member statistics are invalid.
No record has been written for the member to be added.
Truncation or translation error in accessing dialog variables.
Severe error; unable to continue.
LMMDEL – Delete Members from a Data Set
Command Invocation Format
ISPEXEC LMMDEL DATAID(data-id)
MEMBER(member-name)
[NOENQ]
Call Invocation Format
CALL ISPLINK(’LMMDEL ’,data-id
,member-name)
,[’NOENQ’]);
OR
CALL ISPEXEC (buf-len, buffer);
Return Codes
0
8
10
12
Normal completion.
Member not found.
No data set is associated with the given data ID; that is, LMINIT has not
been completed.
One of the following:
v The data set is not open or is not open for output.
v The parameter value is invalid.
v The data set organization is invalid.
Chapter 2. ISPF Service Syntax with Return Codes
39
LMMDEL service
20
Severe error; unable to continue.
LMMDISP – Member List Service
Display Option
Command Invocation Format:
ISPEXEC LMMDISP DATAID(data-id)
[OPTION(DISPLAY)]
[MEMBER(pattern)]
[STATS(YES|NO)]
[PANEL(panel-name)]
[CURSOR(ZCMD|ZLLCMD|ZLUDATA)]
[TOP(top-row)]
[COMMANDS(S|ANY)]
[FIELD(1|9)]
[ALLOWNEW]
Call Invocation Format:
CALL ISPLINK(’LMMDISP ’, data-id
,[’DISPLAY ’]
,[pattern]
,[’YES
’|’NO
’]
,[panel-name]
,[’ZCMD
’|’ZLLCMD ’|’ZLUDATA ’]
,[top-row]
,’ ’
,’ ’
,[’S
’|’ANY
’]
,[1|9]
,[’ALLOWNEW’];
OR
CALL ISPEXEC (buf-len,buffer);
Return Codes:
0
One or more members were selected or a primary command not
recognized by LMMDISP was entered.
4
The requested data sets were empty, or no members matched the specified
pattern.
8
END or RETURN was entered.
10
No data set is associated with the given data ID; LMINIT has not been
completed.
12
Indicates one of the following conditions:
v Data sets not open.
v Data sets not partitioned.
v Invalid parameter value.
v Invalid data set organization.
v Invalid invocation syntax.
16
Truncation or translation error in accessing dialog variables.
20
Severe error; unable to continue.
GET Option
Command Invocation Format:
ISPEXEC LMMDISP DATAID(data-id)
OPTION(GET)
[STATS(YES|NO)]
40
z/OS V1R7.0 ISPF Reference Summary
LMMDISP service
Call Invocation Format:
CALL ISPLINK(’LMMDISP ’, data-id
,’GET
’
,’ ’
,[’YES
’|’NO
’]);
OR
CALL ISPEXEC (buf-len,buffer);
Return
0
8
10
12
16
20
Codes:
Successful completion.
No more selected members.
No data set is associated with the given data ID; LMINIT has not been
completed.
Indicates one of the following conditions:
v Data sets not open.
v Data sets not partitioned.
v Invalid parameter value.
v Invalid data set organization.
v Invalid invocation syntax.
v Member list has not been created.
Truncation or translation error in accessing dialog variables.
Severe error; unable to continue.
PUT Option
Command Invocation Format:
ISPEXEC LMMDISP DATAID(data-id)
OPTION(PUT)
MEMBER(member-name)
[ZLLCMD(lcmd-value)]
[ZLUDATA(udata-value)]
Call Invocation Format:
CALL ISPLINK(’LMMDISP ’, data-id
,’PUT
’
,member-name
,’ ’
,’ ’
,’ ’
,’ ’
,[lcmd-value]
,[udata-value]);
OR
CALL ISPEXEC (buf-len,buffer);
Return
0
8
10
12
Codes:
Successful completion.
Specified member does not exist.
No data set is associated with the given data ID; LMINIT has not been
completed.
Indicates one of the following conditions:
v Data sets not open.
v Data sets not partitioned.
v Invalid parameter value.
v Invalid data set organization.
Chapter 2. ISPF Service Syntax with Return Codes
41
LMMDISP service
16
20
v Invalid invocation syntax.
v Member list has not been created.
Truncation or translation error in accessing dialog variables.
Severe error; unable to continue.
ADD Option
Command Invocation Format:
ISPEXEC LMMDISP DATAID(data-id)
OPTION(ADD)
MEMBER(member-name)
[ZLLCMD(lcmd-value)]
[ZLUDATA(udata-value)]
Call Invocation Format:
CALL ISPLINK(’LMMDISP ’, data-id
,’ADD
’
,member-name
,’ ’
,’ ’
,’ ’
,’ ’
,[lcmd-value]
,[udata-value]);
OR
CALL ISPEXEC (buf-len,buffer);
Return
0
8
10
12
16
20
Codes:
Successful completion.
Member already exists in member list.
No data set is associated with the given data ID; LMINIT has not been
completed.
Indicates one of the following conditions:
v Data sets not open.
v Data sets not partitioned.
v Invalid parameter value.
v Invalid data set organization.
v Invalid invocation syntax.
v Member list has not been created.
Truncation or translation error in accessing dialog variables.
Severe error; unable to continue.
DELETE Option
Command Invocation Format:
ISPEXEC LMMDISP DATAID(data-id)
OPTION(DELETE)
MEMBER(member-name)
Call Invocation Format:
CALL ISPLINK(’LMMDISP ’, data-id
,’DELETE ’
,member-name);
OR
CALL ISPEXEC (buf-len,buffer);
42
z/OS V1R7.0 ISPF Reference Summary
LMMDISP service
Return
0
8
10
12
16
20
Codes:
Successful completion.
A specified member does not exist in the member list.
No data set is associated with the given data ID; LMINIT has not been
completed.
Indicates one of the following conditions:
v Data sets not open.
v Data sets not partitioned.
v Invalid parameter value.
v Invalid data set organization.
v Invalid invocation syntax.
v Member list has not been created.
Truncation or translation error in accessing dialog variables.
Severe error; unable to continue.
FREE Option
Command Invocation Format:
ISPEXEC LMMDISP DATAID(data-id)
OPTION(FREE)
Call Invocation Format:
CALL ISPLINK(’LMMDISP ’, data-id
,’FREE
’);
OR
CALL ISPEXEC (buf-len,buffer);
Return
0
8
10
12
16
20
Codes:
Successful completion.
No member list is associated with the given data ID.
No data set is associated with the given data ID; LMINIT has not been
completed.
Indicates one of the following conditions:
v Data sets not open.
v Data sets not partitioned.
v Invalid parameter value.
v Invalid data set organization.
v Invalid invocation syntax.
Truncation or translation error in accessing dialog variables.
Severe error; unable to continue.
LMMFIND – Find a Library Member
Command Invocation Format
|
ISPEXEC LMMFIND DATAID(data-id)
MEMBER(member-name)
[LOCK]
[LRECL(lrecl-var)]
[RECFM(recfm-var)]
[GROUP(group-var)]
[STATS(YES|NO)]
[NOLLA]
Chapter 2. ISPF Service Syntax with Return Codes
43
LMMFIND service
Call Invocation Format
CALL ISPLINK (’LMMFIND ’,data-id
,member-name
,[’LOCK
’]
,[lrecl-var]
,[recfm-var]
,[group-var]
,[’YES
’|’NO
,[’NOLLA ’]);
|
’]
OR
CALL ISPEXEC (buf-len, buffer);
Return Codes
0
4
8
10
12
16
20
Normal completion. If you specify LOCK and the member is in a
controlled ISPF library, a return code of zero shows that the user is a valid
user as specified by the member access ID. The member is available and is
now currently owned by the user. The member is not available for
updating by any other user. For more information about the member
access ID, see ISPF Library Management Facility.
One of the following:
v Member not available; the member resides in a controlled ISPF library
and is currently owned by another user.
v Member not available; the member resides in a controlled ISPF library,
and the user is not a valid user as specified by the member access ID.
v Lock was requested but the project is SCLM-controlled.
Member not found.
No data set is associated with the given data ID; that is, LMINIT has not
been completed.
One of the following:
v Data set is not open or is not open for input.
v The parameter value is invalid.
v Data set is not partitioned.
Truncation or translation error in accessing dialog variables.
Severe error; unable to continue.
LMMLIST – List a Library’s Members
Command Invocation Format
ISPEXEC LMMLIST DATAID(data-id)
[OPTION(LIST|FREE|SAVE)]
[MEMBER(member-var)]
[STATS(YES|NO)]
[GROUP(group)]
[PATTERN(member-pattern)]
[LONG]
Call Invocation Format
CALL ISPLINK (’LMMLIST ’,data-id
,[’LIST
’|’FREE
,[member-var]
,[’YES
’|’NO
,[group])
,[member-pattern]
,[LONG]);
OR
CALL ISPEXEC (buf-len, buffer);
44
z/OS V1R7.0 ISPF Reference Summary
’|’SAVE
’]
’]
LMMLIST service
Return Codes
0
4
8
10
12
16
20
One of the following:
v LIST option - Normal completion. The member list is available and the
next member in the list is returned in the member-var parameter.
v FREE option - Normal completion. The member list is freed successfully.
v SAVE option - Normal completion. The member list is successfully
written to the data set.
Empty member list.
One of the following:
v LIST option - End of member list.
v FREE option - Member list does not exist.
v SAVE option - For a data ID, the LMMLIST service was invoked with
the SAVE option after being invoked with the LIST option, but before
being invoked with the FREE option.
No data set is associated with the given data ID; that is, LMINIT has not
been completed.
One of the following:
v The data set is not open or is not partitioned.
v The parameter value is invalid.
v Member list was created using LMMDISP.
Truncation or translation error in accessing dialog variables.
Severe error; unable to continue.
LMMOVE – Move Members of a Data Set
Command Invocation Format
ISPEXEC LMMOVE FROMID(from-data-id)
[FROMMEM(from-member-name)]
TODATAID(to-data-id)
[TOMEM(to-member-name)]
[REPLACE]
[PACK]
[TRUNC]
[SCLMSET(YES|NO)]
[ALIAS|NOALIAS]
Call Invocation Format
CALL ISPLINK (’LMMOVE ’ ,from-data-id
,[from-member-name]
,to-data-id
,[to-member-name]
,[’REPLACE ’]
,[’PACK
’]
,[’TRUNC ’]
,[’YES
’|’NO
’|’ ’]
,[’ALIAS ’|’NOALIAS ’]);
OR
CALL ISPEXEC (buf-len,buffer);
Return Codes
0
4
8
10
12
Successful completion.
One of the following:
v “From” data set is empty.
v No member matched the pattern in the “from” data set.
“From” member not found.
No data set is associated with given data ID.
One of the following:
Chapter 2. ISPF Service Syntax with Return Codes
45
LMMOVE service
Invalid data set organization.
Data set attribute invalid for packed data.
Open error.
A like named member already exists in the ’TO’ data set, and the
Replace option was not specified.
v One or more members of the ’TO’ data set are “in use” by you or
another user and could not be copied.
Truncation error.
Severe error; unable to continue.
v
v
v
v
16
20
LMMREN – Rename a Data Set Member
Command Invocation Format
ISPEXEC LMMREN DATAID(data-id)
MEMBER(old-member-name)
NEWNAME(new-member-name)
[NOENQ]
Call Invocation Format
CALL ISPLINK(’LMMREN ’,data-id
,old-member-name
,new-member-name)
,[’NOENQ’]);
OR
CALL ISPEXEC (buf-len, buffer);
Return Codes
0
4
8
10
12
20
Normal completion.
Directory already contains the specified new name.
Member not found.
No data set is associated with the given data ID; that is, LMINIT has not
been completed.
One of the following:
v The data set is not open or is not open for output.
v The parameter value is invalid.
v The data set organization is invalid.
Severe error; unable to continue.
LMMREP – Replace a Member of a Data Set
Command Invocation Format
ISPEXEC LMMREP DATAID(data-id)
MEMBER(member-name)
[STATS(YES|NO)]
[NOENQ]
Call Invocation Format
CALL ISPLINK(’LMMREP ’,data-id
,member-name
,[’YES
’|’NO
,[’NOENQ’]);
OR
CALL ISPEXEC (buf-len, buffer);
46
z/OS V1R7.0 ISPF Reference Summary
’])
LMMREP service
Return Codes
0
8
10
12
14
16
20
Normal completion.
Member is added; it did not previously exist.
No data set is associated with the given data ID; that is, LMINIT has not
been completed.
One of the following:
v The data set is not open or is not open for output.
v The parameter value is invalid.
v The data set organization is invalid.
v Some member statistics have invalid values.
No record has been written for the member to be replaced.
Truncation or translation error in accessing dialog variables.
Severe error; unable to continue.
LMMSTATS – Set and Store ISPF Statistics
Command Invocation Format
|
ISPEXEC LMMSTATS DATAID(data-id) MEMBER(member-name)
[VERSION(version-number)]
[MODLEVEL(mod-level)]
[CREATED(create-date)]
[MODDATE(last-modified-date)]
[MODTIME(last-modified-time)]
[CURSIZE(current-size)]
[INITSIZE(initial-size)]
[MODRECS(records-modified)]
[USER(user-id)]
[DELETE]
[CREATED4(4-char-year-create-date)]
[MODDATE4(4-char-year-last-modified-date)]
[SCLM(ON|OFF|ASIS)]
[NOLLA]
Call Invocation Format
|
CALL ISPLINK (’LMMSTATS’,data-id
,member-name
,[version-number]
,[mod-level]
,[create-date]
,[last-modified-date]
,[last-modified-time]
,[current-size]
,[initial-size]
,[records-modified]
,[user-id]
,[’DELETE ’]
,[4-char-year-create-date]
,[4-char-year-last-modified-date]
,[ON|OFF|ASIS]
,[’NOLLA ’]);
OR
CALL ISPEXEC (buf-len,buffer);
Return Codes
0
4
8
Normal completion.
One of the following:
v Data set is empty.
v No members matched the pattern.
Member not found.
Chapter 2. ISPF Service Syntax with Return Codes
47
LMMSTATS service
10
12
20
No data set is associated with the given data ID; that is, LMINIT has not
been completed.
One of the following:
v Invalid parameter value.
v Data set is not partitioned.
v Data ID represents a concatenation of data sets.
v Data set is open for output.
Severe error; unable to continue.
LMOPEN – Open a Data Set
Command Invocation Format
ISPEXEC LMOPEN DATAID(data-id)
[OPTION(INPUT|OUTPUT)]
[LRECL(lrecl-var)]
[RECFM(recfm-var)]
[ORG(org-var)]
Call Invocation Format
CALL ISPLINK (’LMOPEN ’,data-id
,[’INPUT ’|’OUTPUT ’]
,[lrecl-var]
,[recfm-var]
,[org-var]);
OR
CALL ISPEXEC (buf-len, buffer);
Return Codes
0
8
10
12
16
20
Normal completion.
Data set could not be opened.
No data set is associated with the given data ID; that is, LMINIT has not
been completed.
One of the following:
v The parameter value is invalid.
v Data set is already open.
v Cannot open concatenated data sets for output.
v Cannot open a data set allocated SHR for output.
Truncation or translation error in accessing dialog variables.
Severe error; unable to continue.
LMPRINT – Print a Partitioned or Sequential Data Set
Command Invocation Format
ISPEXEC LMPRINT DATAID(data-id)
[MEMBER(member-name)]
[INDEX]
[FORMAT(YES|NO)]
[NOLLA]
|
Call Invocation Format
CALL ISPLINK (’LMPRINT ’,data-id
,[member-name]
,[’INDEX ’]
,[’YES
’|’NO
,[’NOLLA ’]);
|
48
z/OS V1R7.0 ISPF Reference Summary
’]
LMPRINT service
OR
CALL ISPEXEC (buf-len,buffer);
Return Codes
0
4
8
10
12
20
Normal completion.
One of the following:
v Data set is empty.
v No members matched the pattern.
Member not found.
No data set associated with given data ID.
One of the following:
v Invalid data set organization; must be partitioned or sequential.
v Invalid parameter.
Severe error; unable to continue.
LMPUT – Write a Logical Record to a Data Set
Command Invocation Format
ISPEXEC LMPUT DATAID(data-id)
MODE(INVAR|MOVE|MULTX)
DATALOC(dataloc-var)
DATALEN(data-length)
[NOBSCAN]
Call Invocation Format
CALL ISPLINK (’LMPUT
’,data-id
,’INVAR ’|’MOVE
,dataloc-var
,data-length
,’ ’
,[’NOBSCAN ’]);
’|’MULTX’
OR
CALL ISPEXEC (buf-len, buffer);
Return Codes
0
10
12
16
20
Normal completion.
No data set is associated with the given data ID; that is, LMINIT has not
been completed.
One of the following:
v The data set is not open or is not open for output.
v The parameter value is invalid.
Truncation or translation error in accessing dialog variables.
Severe error; unable to continue.
LMQUERY – Give a Dialog Information about a Data Set
Command Invocation Format
ISPEXEC LMQUERY DATAID(data-id)
[PROJECT(proj-var)]
[GROUP1(group1-var)]
[GROUP2(group2-var)]
[GROUP3(group3-var)]
[GROUP4(group4-var)]
[TYPE(type-var)]
[DATASET(dsn-var)]
Chapter 2. ISPF Service Syntax with Return Codes
49
LMQUERY service
[DDNAME(ddn-var)]
[VOLUME(serial-var)]
[ENQ(enq-var)]
[OPEN(open-var)]
[LRECL(lrecl-var)]
[RECFM(recfm-var)]
[DSORG(dsorg-var)]
[ALIAS(alias-var)]
[PASSWORD(password-var)]
[OVOLUME(ovolume-var)]
Call Invocation Format
CALL ISPLINK (’LMQUERY ’,data-id
,[proj-var]
,[group1-var]
,[group2-var]
,[group3-var]
,[group4-var]
,[type-var]
,[dsn-var]
,[ddn-var]
,[serial-var]
,[enq-var]
,[open-var]
,[lrecl-var]
,[recfm-var]
,[dsorg-var]
,[alias-var]
,[password-var]
,[ovolume-var]);
OR
CALL ISPEXEC (buf-len, buffer);
Return Codes
0
4
10
16
20
Normal completion.
No applicable information available for a specified keyword; blanks are
returned.
No data set is associated with the given data ID; that is, LMINIT has not
been completed.
Truncation or translation error in accessing dialog variables.
Severe error; unable to continue.
LMRENAME – Rename an ISPF Library
Command Invocation Format
ISPEXEC LMRENAME PROJECT(project)
GROUP(group)
TYPE(type)
{[NEWPROJ(new-project)]
[NEWGROUP(new-group)]
[NEWTYPE(new-type)] }
Call Invocation Format
CALL ISPLINK(’LMRENAME’,project
,group
,type
,{[new-project]
,[new-group]
,[new-type] });
50
z/OS V1R7.0 ISPF Reference Summary
LMRENAME service
OR
CALL ISPEXEC (buf-len, buffer);
Return Codes
0
4
8
12
20
Normal completion.
New name already exists.
One of the following:
v Specified data set does not exist.
v Rename or catalog failed.
v Data set name is an alias.
The parameter value is invalid.
Severe error; unable to continue.
LOG – Write a Message to the Log Data Set
Command Invocation Format
ISPEXEC LOG MSG(message-id)
Call Invocation Format
CALL ISPEXEC (buf-len, buffer);
OR
CALL ISPLINK (’LOG
’, message-id);
Return Codes
0
12
20
Normal completion.
The message ID contains invalid syntax or was not found.
Severe error.
MEMLIST – Member List Dialog
Command Invocation Format
ISPEXEC MEMLIST DATAID(data-id)
[MEMBER(pattern)]
[CONFIRM(YES|NO)]
[PANEL(panel-name)]
[FIELD(1|9)]
Call Invocation Format
CALL ISPEXEC (buf-len, buffer);
OR
CALL ISPLINK
(’MEMLIST ’, data-id,
[,pattern]
[,YES|NO]
[,panel-name]
[,1|9]);
Return Codes
0
8
Normal completion.
The requested data set was empty or no members matched the specified
pattern.
Chapter 2. ISPF Service Syntax with Return Codes
51
MEMLIST service
10
12
16
20
No data set is associated with the given data ID. LMINIT has not been
completed.
One of the following:
v Data set not partitioned.
v Parameter value not valid.
v Invocation syntax not valid.
A truncation or translation error occurred in accessing dialog variables.
Severe error.
PQUERY – Obtain Panel Information
Command Invocation Format
ISPEXEC PQUERY PANEL(panel-name) AREANAME(area-name)
[AREATYPE(area-type-name)]
[WIDTH(area-width-name)]
[DEPTH(area-depth-name)]
[ROW(row-number-name)]
[COLUMN(column-number-name)]
Call Invocation Format
CALL ISPEXEC (buf-len, buffer);
OR
CALL ISPLINK
(’PQUERY ’, panel-name, area-name
[,area-type-name]
[,area-width-name]
[,area-depth-name]
[,row-number-name]
[,column-number-name]);
Return Codes
0
8
12
16
20
Normal completion.
The panel does not contain the specified area.
The specified panel cannot be found.
Not all values are returned because insufficient space was provided.
Severe error.
QBASELIB – Query Base Library Information
Command Invocation Format
ISPEXEC QBASELIB dd-name [ID(id-var)]
Call Invocation Format
CALL ISPEXEC (buf-len, buffer);
OR
CALL ISPLINK (’QBASELIB’,dd-name,[,id-var)]);
Return Codes
0
4
16
20
52
A DDNAME for the specified ddname exists and the requested
information, if any, has been successfully returned.
The specified dd-name is not valid.
A dialog variable translation or truncation error has occurred.
A severe error has occurred.
z/OS V1R7.0 ISPF Reference Summary
QLIBDEF service
QLIBDEF – Query LIBDEF Definition Information
Command Invocation Format
ISPEXEC QLIBDEF lib-type [TYPE(type-var)] [ID(id-var)]
Call Invocation Format
CALL ISPEXEC (buf-len, buffer);
OR
CALL ISPLINK (’QLIBDEF ’,lib-type,[,type-var][,id-var]);
Return Codes
0
4
12
16
20
A LIBDEF definition for the specified lib-type exists and the requested
information, if any, has been successfully returned.
The specified lib-type does not have an active LIBDEF definition.
An invalid lib-type value of ISPPROF has been specified.
A dialog variable translation or truncation error has occurred.
A severe error has occurred.
QTABOPEN – Query Open ISPF Tables
Command Invocation Format
ISPEXEC QTABOPEN LIST(list-var)
Call Invocation Format
CALL ISPLINK (’QTABOPEN ’,list-var);
Return codes
The following return codes are possible:
0
Normal completion.
4
List incomplete. There was insufficient space to contruct a valid variable
name.
12
Prefix too long. List-var must be 7 characters or less.
20
Severe error.
QUERYENQ – Query System ENQ Data
Command Invocation Format
ISPEXEC QUERYENQ TABLE(table-name)
QNAME(qname)
RNAME(rname)
REQ(pattern)
WAIT
LIMIT(limit)
SAVE(list-id)
XSYS
Call Invocation Format
CALL ISPLINK (’QUERYENQ’
,table-name
,qname
,rname
,pattern
,[’WAIT ’]
,limit
Chapter 2. ISPF Service Syntax with Return Codes
53
QUERYENQ service
,list-id
,[’XSYS ’]);
OR
CALL ISPEXEC (buf-len, buffer);
Variables Returned in Each Row of the Table
Name
Size
Description
ZENJOB
8
Job or address space name holding or requesting the ENQ
ZENQNAME
8
Qname portion of the ENQ
ZENRNAME
255
Rname portion of the ENQ
ZENDISP
5
SHARE or EXCLU
ZENHOLD
4
OWN or WAIT
ZENSCOPE
7
SYSTEM or SYSTEMS
ZENSTEP
7
STEP or blank
ZENGLOBL
6
GLOBAL or blank
ZENSYST
8
System name
Return Codes
0
2
4
8
10
12
14
20
Table returned or data set written, but XSYS parameter was not specified and
the system is running in STAR mode. The data returned may not reflect all
ENQs on all systems.
Table returned or data set written.
Table returned but truncated due to limit.
No ENQs satisfy the request.
No ENQs satisfy the request, but XSYS parameter was not specified and the
system is running in STAR mode. The data returned may not reflect all ENQs
on all systems.
Table creation error, parameter or other termination error. See messages for
more detail. This includes services not available due to configuration table
restrictions.
The SAVE data set is in use by another user.
Severe error, including TBADD error or data set creation errors.
REMPOP – Remove a Pop-Up Window
Command Invocation Format
ISPEXEC REMPOP [ ALL ]
Call Invocation Format
CALL ISPEXEC (buf-len, buffer);
OR
CALL ISPLINK (’REMPOP ’ [,’ALL
’]);
Return codes
0
16
20
54
Normal completion.
A pop-up window does not exist at this select level.
Severe error.
z/OS V1R7.0 ISPF Reference Summary
SELECT service
SELECT – Select a Panel or Function
Command Invocation Format
ISPEXEC SELECT {
{
{
{
{
{
{
{
{
{
{
{
{
{
{
{
{
{
{
PANEL(panel-name) [OPT(option)] [ADDPOP] }
}
CMD(command)
[LANG(APL|CREX)]
}
[MODE(LINE|FSCR)]
}
[BARRIER]
}
[NEST]
}
}
PGM(program-name) [PARM(parameters)]
}
[MODE(LINE|FSCR)]
}
WSCMD(workstation-command)
}
[MODAL|MODELESS]
}
[WSDIR(DIR)]
}
[MAX|MIN]
}
[VIS|INVIS]
}
WSCMDV(var_name)
}
[MODAL|MODELESS]
}
[WSDIR(DIR)]
}
[MAX|MIN]
}
[VIS|INVIS]
}
[NEWAPPL [(application-id)][PASSLIB]]|[NEWPOOL] [SUSPEND]
[SCRNAME(screen-name)]
Call Invocation Format
CALL ISPEXEC (buf-len, buffer);
OR
CALL ISPLINK (’SELECT ’, length, keywords);
Note: parameters that can appear in keywords are:
{
{
{
{
{
{
{
{
{
{
{
{
{
{
{
{
{
{
{
PANEL(panel-name) [OPT(option)] [ADDPOP] }
}
CMD(command) [LANG(APL|CREX)]
}
[MODE(LINE|FSCR)]
}
[BARRIER]
}
[NEST]
}
}
PGM(program-name) [PARM(parameters)]
}
[MODE(LINE|FSCR)]
}
WSCMD(workstation-command)
}
[MODAL|MODELESS]
}
[WSDIR(DIR)]
}
[MAX|MIN]
}
[VIS|INVIS]
}
WSCMDV(var_name)
}
[MODAL|MODELESS]
}
[WSDIR(DIR)]
}
[MAX|MIN]
}
[VIS|INVIS]
}
[NEWAPPL [(application-id)][PASSLIB]]|[NEWPOOL] [SUSPEND]
[SCRNAME(screen-name)]
Return Codes
The following return codes are possible if a panel is specified:
0
Normal completion. The END command was entered from the selected
menu.
Chapter 2. ISPF Service Syntax with Return Codes
55
SELECT service
4
12
16
20
Normal completion. The RETURN command was entered or the EXIT
option was specified from the selected menu or from some lower-level
menu.
The specified panel could not be found.
Truncation error in storing the ZCMD or ZSEL variable.
Severe error.
Notes:
1. A return code of 0 is returned when the SELECT service has been coded with
no other parameters.
2. If a command or program is invoked by using SELECT, the return code from
the command or program is passed to the function that invoked SELECT.
The following return codes are possible from a MODAL workstation command:
20
Parameter or syntax on SELECT service (all SELECTs) is not valid.
41
A null command was passed to the workstation.
42
ISPF was not able to start the command at the workstation.
43
Remote execution of commands was not allowed by the user.
OTHER
The return code from the workstation command + 100 if the return code
from the workstation command was > 0.
SETMSG – Set Next Message
Command Invocation Format
ISPEXEC SETMSG MSG(message-id)
[COND]
[MSGLOC(message-field-name)]
Call Invocation Format
CALL ISPEXEC (buf-len, buffer);
OR
CALL ISPLINK (’SETMSG ’, message-id [,’COND
’]
[,message-field-name]);
Return Codes
0
4
12
20
Normal completion.
SETMSG with COND parameter issued and a SETMSG request was
pending.
The specified message field name or message could not be found.
Severe error.
TBADD – Add a Row to a Table
Command Invocation Format
ISPEXEC TBADD table-name
[SAVE(name-list)]
[ORDER]
[MULT(number-of-rows)]
Call Invocation Format
CALL ISPEXEC (buf-len, buffer);
OR
56
z/OS V1R7.0 ISPF Reference Summary
TBADD service
CALL ISPLINK (’TBADD
’, table-name
[,name-list]
[,’ORDER ’]
[,number-of-rows]);
Return Codes
0
4
8
12
16
20
Normal completion.
The number-of-rows parameter was specified but storage was obtained for
only a single row.
A row with the same key already exists; CRP set to TOP (zero). Returned
only for tables with keys.
Table is not open.
Numeric convert error; see numeric restrictions for TBSORT. Returned only
for sorted tables.
Severe error.
TBBOTTOM – Set the Row Pointer to Bottom
Command Invocation Format
ISPEXEC TBBOTTOM table-name [SAVENAME(var-name)]
[ROWID(rowid-name)]
[NOREAD]
[POSITION(crp-name)]
Call Invocation Format
CALL ISPEXEC (buf-len, buffer);
OR
CALL ISPLINK (’TBBOTTOM’, table-name [,var-name]
[,rowid-name]
[,’NOREAD ’]
[,crp-name]);
Return Codes
0
8
12
16
20
Normal completion.
Table is empty; CRP set to TOP (zero).
Table is not open.
Variable value has been truncated, or insufficient space was provided to
return all extension variable names.
Severe error.
TBCLOSE – Close and Save a Table
Command Invocation Format
ISPEXEC TBCLOSE table-name [NEWCOPY|REPLCOPY]
[NAME(alt-name)]
[PAD(percentage)]
[LIBRARY(library)]
Call Invocation Format
CALL ISPEXEC (buf-len, buffer);
OR
Chapter 2. ISPF Service Syntax with Return Codes
57
TBCLOSE service
CALL ISPLINK (’TBCLOSE ’, table-name [,’NEWCOPY ’|’REPLCOPY’]
[,alt-name]
[,percentage]
[,library]);
Return Codes
0
12
16
20
Normal completion.
Table is not open.
Alternate table output library was not allocated.
Severe error.
TBCREATE – Create a New Table
Command Invocation Format
ISPEXEC TBCREATE table-name [KEYS(key-name-list)]
[NAMES(name-list)]
[WRITE|NOWRITE]
[REPLACE]
[LIBRARY(library)]
[SHARE]
Call Invocation Format
CALL ISPEXEC (buf-len, buffer);
OR
CALL ISPLINK (’TBCREATE’, table-name [,key-name-list]
[,name-list]
[,’WRITE ’|’NOWRITE ’]
[,’REPLACE ’]
[,library]
[,’SHARE ’]);
Return Codes
0
4
8
12
16
20
Normal completion.
Normal completion—a duplicate table exists but REPLACE was specified.
Either the table already exists and REPLACE was not specified, or
REPLACE was specified and the table is in SHARE mode.
Table in use; ENQ failed.
WRITE mode specified and alternate table input library not allocated.
TBCREATE checks the input library to determine if a duplicate table exists.
See return code 8.
Severe error.
TBDELETE – Delete a Row from a Table
Command Invocation Format
ISPEXEC TBDELETE table-name
Call Invocation Format
CALL ISPEXEC (buf-len, buffer);
OR
CALL ISPLINK (’TBDELETE’, table-name);
58
z/OS V1R7.0 ISPF Reference Summary
TBDELETE service
Return Codes
0
8
12
20
Normal completion.
Keyed tables: the row specified by the value in key variables does not
exist; CRP set to TOP (zero). Non-keyed tables: CRP was at TOP (zero) and
remains at TOP.
Table is not open.
Severe error.
TBDISPL – Display Table Information
Command Invocation Format
ISPEXEC TBDISPL table-name [PANEL(panel-name)]
[MSG(message-id)]
[CURSOR(field-name)]
[CSRROW(table-row-number)]
[CSRPOS(cursor-position)]
[AUTOSEL(YES|NO)]
[POSITION(crp-name)]
[ROWID(rowid-name)]
[MSGLOC(message-field-name)]
Call Invocation Format
CALL ISPEXEC (buf-len, buffer);
CALL ISPLINK (’TBDISPL ’, table-name [,panel-name]
[,message-id]
[,field-name]
[,table-row-number]
[,cursor-position]
[,’YES
’|’NO
’]
[,crp-name]
[,rowid-name]
[,message-field-name]);
Return Codes
0
If the panel definition contains neither a )REINIT nor a )PROC section, the
Enter key was pressed, or a scroll command was entered. Any of the
following occurred:
v One row was selected in the scrollable part of the display. The CRP is set
to point to that table row and the row is retrieved. The input fields from
the selected model set on the display are then stored in the function
pool.
v The user entered information into the fixed portion of the display.
v All of the following:
– A scroll return to function has been specified (ZTDRET defined to UP,
DOWN, or VERTICAL).
– More rows are needed to fill a scroll request.
– No selected rows remain to be processed.
If the panel definition contains a )REINIT or )PROC section, there is the
additional possibility that the user entered no information and just pressed
Enter.
4
The Enter key was pressed or a scroll command was entered. The first or
both of the following occurred:
Chapter 2. ISPF Service Syntax with Return Codes
59
TBDISPL service
v Two or more rows in the scrollable part of the display were selected. The
CRP is set to the first selected row and the row is retrieved. The input
fields from the selected model set on the display are then stored in the
function pool.
v The user entered information into the fixed portion of the display.
v If scroll return to function has been specified, and two or more rows are
selected for processing, TBDISPL returns a return code 4 until all
selected rows are processed. You process the request for more rows to be
added to the table only after all selected rows have been processed; that
is, only when ZTDSELS has a value of 0.
For subsequent TBDISPL requests with no panel name and no message ID,
return code 4 is issued for each request until one selected row remains to
be accessed. For this last row, a return code of zero is issued by TBDISPL,
still specified with no panel name and no message ID. The variable
ZTDSELS will have a value of one.
8
The END or RETURN command was entered. For panels created by the
tag conversion utility, CANCEL and EXIT commands also give a return
code of 8. If CANCEL and EXIT are requested from a panel displayed
using TBDISPL service calls and the panel was defined with dialog tag
language (DTL), the dialog manager returns the command in ZVERB and
sets a return code of 8 from the display screen. The CRP is set to the first
of any selected rows in the scrollable part of the display. The input fields
from the selected model set on the display are then stored in the function
pool. If no rows were selected, the CRP is at the top (zero). To process all
selected rows when END or RETURN was entered, continue to issue
TBDISPL requests with no panel name or message ID specified until
ZTDSELS is one.
If the user enters the END command on a table display panel, a
subsequent redisplay will result in a return code of 8.
The user may have entered information into the fixed portion of the
display.
12
The specified panel, message, cursor field, or message location field could
not be found.
16
Truncation or translation error in storing defined variables.
20
Severe error.
TBEND – Close a Table without Saving
Command Invocation Format
ISPEXEC TBEND table-name
Call Invocation Format
CALL ISPEXEC (buf-len, buffer);
OR
CALL ISPLINK (’TBEND
’, table-name);
Return Codes
0
12
60
Normal completion.
Table is not open.
z/OS V1R7.0 ISPF Reference Summary
TBEND service
20
Severe error.
TBERASE – Erase a Table
Command Invocation Format
ISPEXEC TBERASE table-name [LIBRARY(library)]
Call Invocation Format
CALL ISPEXEC (buf-len, buffer);
OR
CALL ISPLINK (’TBERASE ’, table-name [,library]);
Return Codes
0
8
12
16
20
Normal completion.
Table does not exist in the output library.
Table in use; ENQ failed.
Table output library not allocated.
Severe error.
TBEXIST – Determine Whether a Row Exists in a Table
Command Invocation Format
ISPEXEC TBEXIST table-name
Call Invocation Format
CALL ISPEXEC (buf-len, buffer);
OR
CALL ISPLINK (’TBEXIST ’, table-name);
Return Codes
0
8
12
20
Normal completion; the CRP is positioned to the specified row.
Keyed tables: the specified row does not exist; the CRP is set to TOP (zero).
Non-keyed tables: service not possible; the CRP is set to TOP.
Table is not open.
Severe error.
TBGET – Retrieve a Row from a Table
Command Invocation Format
ISPEXEC TBGET table-name [SAVENAME(var-name)]
[ROWID(rowid-name)]
[NOREAD]
[POSITION(crp-name)]
Call Invocation Format
CALL ISPEXEC (buf-len, buffer);
OR
CALL ISPLINK (’TBGET
’, table-name [,var-name]
Chapter 2. ISPF Service Syntax with Return Codes
61
TBGET service
[,rowid-name]
[,’NOREAD ’]
[,crp-name]);
Return Codes
0
8
12
16
20
Normal completion.
Keyed tables: The row specified by the value in the key variables does not
exist; the CRP is set to TOP (zero). Non-keyed tables: the CRP was at TOP
and remains at TOP.
Table is not open.
Variable value has been truncated, or insufficient space was provided to
return all extension variable names.
Severe error.
TBMOD – Modify a Row in a Table
Command Invocation Format
ISPEXEC TBMOD table-name [SAVE(name-list)]
[ORDER]
Call Invocation Format
CALL ISPEXEC (buf-len, buffer);
OR
CALL ISPLINK (’TBMOD
’, table-name [,name-list]
[’ORDER ’]);
Return Codes
0
8
12
16
20
Normal completion. Keyed tables: Existing row was updated. Non-keyed
tables: New row was added to table.
Keys did not match; new row was added to the table. Returned only for
tables with keys.
Table is not open.
Numeric conversion error; see numeric restrictions for TBSORT. Returned
only for sorted tables.
Severe error.
TBOPEN – Open a Table
Command Invocation Format
ISPEXEC TBOPEN table-name [WRITE|NOWRITE]
[LIBRARY(library)]
[SHARE]
Call Invocation Format
CALL ISPEXEC (buf-len, buffer);
OR
CALL ISPLINK (’TBOPEN ’, table-name [,’WRITE ’|’NOWRITE ’]
[,library]
[,’SHARE ’]);
62
z/OS V1R7.0 ISPF Reference Summary
TBOPEN service
Return Codes
0
8
12
16
20
Normal completion.
Table does not exist.
ENQ failed; table was in use by another user or the current user.
Table input library was not allocated.
Severe error.
TBPUT – Update a Row in a Table
Command Invocation Format
ISPEXEC TBPUT table-name [SAVE(name-list)]
[ORDER]
Call Invocation Format
CALL ISPEXEC (buf-len, buffer);
OR
CALL ISPLINK (’TBPUT
’, table-name [,name-list]
[,’ORDER ’]);
Return Codes
0
8
12
16
20
Normal completion.
Keyed tables: the key does not match that of the current row; CRP set to
TOP (zero). Non-keyed tables: CRP was at TOP and remains at TOP.
Table is not open.
For sorted tables: numeric conversion error; see numeric restrictions for
TBSORT.
Severe error.
TBQUERY – Obtain Table Information
Command Invocation Format
ISPEXEC TBQUERY table-name [KEYS(key-name)]
[NAMES(var-name)]
[ROWNUM(rownum-name)]
[KEYNUM(keynum-name)]
[NAMENUM(namenum-name)]
[POSITION(crp-name)]
[SORTFLDS(srt-name)]
[SARGLIST(lst-name)]
[SARGCOND(cond-name)]
[SARGDIR(dir-name)]
Call Invocation Format
CALL ISPEXEC (buf-len, buffer);
OR
CALL ISPLINK (’TBQUERY ’, table-name [,key-name]
[,var-name]
[,rownum-name]
[,keynum-name]
[,namenum-name]
[,crp-name]
[,srt-name]
Chapter 2. ISPF Service Syntax with Return Codes
63
TBQUERY service
[,lst-name]
[,cond-name]
[,dir-name]);
Return Codes
0
12
16
20
Normal completion.
Table is not open.
Not all keys or names were returned because insufficient space was
provided.
Severe error.
TBSARG – Define a Search Argument
Command Invocation Format
ISPEXEC TBSARG table-name [ARGLIST(name-list)]
[NEXT|PREVIOUS]
[NAMECOND(name-cond-pairs)]
Call Invocation Format
CALL ISPEXEC (buf-len, buffer);
OR
CALL ISPLINK (’TBSARG ’, table-name
[,name-list]
[,’NEXT
’|’PREVIOUS’]
[,name-cond-pairs]);
Return Codes
0
8
12
20
Normal completion.
All column variables are null and the name-list parameter was not
specified; no argument is established.
Table is not open.
Severe error.
TBSAVE – Save a Table
Command Invocation Format
ISPEXEC TBSAVE table-name [NEWCOPY|REPLCOPY]
[NAME(alt-name)]
[PAD(percentage)]
[LIBRARY(library)]
Call Invocation Format
CALL ISPEXEC (buf-len, buffer);
OR
CALL ISPLINK (’TBSAVE ’, table-name, [,’NEWCOPY ’|’REPLCOPY’]
[,alt-name]
[,percentage]
[,library]);
Return Codes
0
64
Normal completion.
z/OS V1R7.0 ISPF Reference Summary
TBSAVE service
12
16
20
Table is not open.
Alternate table output library was not allocated.
Severe error.
TBSCAN – Search a Table
Command Invocation Format
ISPEXEC TBSCAN table-name [ARGLIST(name-list)]
[SAVENAME(var-name)]
[ROWID(rowid-name)]
[NEXT|PREVIOUS]
[NOREAD]
[POSITION(crp-name)]
[CONDLIST(condition-value-list)]
Call Invocation Format
CALL ISPEXEC (buf-len, buffer);
OR
CALL ISPLINK (’TBSCAN ’, table-name [,name-list]
[,var-name]
[,rowid-name]
[,’NEXT
’|’PREVIOUS’]
[,’NOREAD ’]
[,crp-name]
[,condition-value-list]);
Return Codes
0
8
12
16
20
Normal completion.
Row does not exist, no match was found; CRP is set to TOP (zero). The
row ID remains unchanged.
Table is not open.
Variable value has been truncated, or insufficient space is provided to
return all extension variable names.
Severe error.
TBSKIP – Move the Row Pointer
Command Invocation Format
ISPEXEC TBSKIP table-name [NUMBER(number)]
[SAVENAME(var-name)]
[ROWID(rowid-name)]
[ROW(rowid)]
[NOREAD]
[POSITION(crp-name)]
Call Invocation Format
CALL ISPEXEC (buf-len, buffer);
OR
CALL ISPLINK (’TBSKIP ’, table-name [,number]
[,var-name]
[,rowid-name]
[,rowid]
[,’NOREAD ’]
[,crp-name]);
0
Normal completion.
Chapter 2. ISPF Service Syntax with Return Codes
65
TBSKIP service
8
12
16
20
CRP would have gone beyond the number of rows in the table. This
includes a table empty condition, with CRP set to TOP (zero). The row ID
remains unchanged.
Table is not open.
Variable value has been truncated, or insufficient space is provided to
return all extension variable names.
Severe error.
TBSORT – Sort a Table
Command Invocation Format
ISPEXEC TBSORT table-name FIELDS(sort-list)
Call Invocation Format
CALL ISPEXEC (buf-len, buffer);
OR
CALL ISPLINK (’TBSORT ’, table-name, sort-list);
Return Codes
0
12
16
20
Normal completion.
Table is not open.
Numeric convert error.
Severe error.
TBSTATS – Retrieve Table Statistics
Command Invocation Format
ISPEXEC TBSTATS table-name [CDATE(date-created-name)]
[CTIME(time-created-name)]
[UDATE(date-updated-name)]
[UTIME(time-updated-name)]
[USER(user-name)]
[ROWCREAT(row-created-name)]
[ROWCURR(rownum-name)]
[ROWUPD(row-updated-name)]
[TABLEUPD(table-updated-name)]
[SERVICE(service-name)]
[RETCODE(return-code-name)]
[STATUS1(status1-name)]
[STATUS2(status2-name)]
[STATUS3(status3-name)]
[LIBRARY(library)]
[VIRTSIZE(virtual-storage-size-name)]
[CDATE4D(date-created-name-4-digit)]
[UDATE4D(date-updated-name-4-digit)]
|
Call Invocation Format
CALL ISPEXEC (buf-len, buffer);
OR
CALL ISPLINK (’TBSTATS ’, table-name [,date-created-name]
[,time-created-name]
[,date-updated-name]
[,time-updated-name]
[,user-name]
[,row-created-name]
66
z/OS V1R7.0 ISPF Reference Summary
TBSTATS service
[,rownum-name]
[,row-updated-name]
[,table-updated-name]
[,service-name]
[,return-code-name]
[,status1-name]
[,status2-name]
[,status3-name]
[,library]
[,virtual-storage-size-name]
[,date-created-name-4-digit]
[,date-updated-name-4-digit]);
|
Return Codes
0
16
20
Normal completion (returned even if the table does not exist).
Variable value has been truncated.
Severe error.
TBTOP – Set the Row Pointer to the Top
Command Invocation Format
ISPEXEC TBTOP table-name
Call Invocation Format
CALL ISPEXEC (buf-len, buffer);
OR
CALL ISPLINK (’TBTOP
’, table-name);
Return Codes
0
12
20
Normal completion.
Table is not open.
Severe error.
TBVCLEAR – Clear Table Variables
Command Invocation Format
ISPEXEC TBVCLEAR table-name
Call Invocation Format
CALL ISPEXEC (buf-len, buffer);
OR
CALL ISPLINK (’TBVCLEAR’, table-name);
Return Codes
0
12
20
Normal completion.
Table is not open.
Severe error.
Chapter 2. ISPF Service Syntax with Return Codes
67
TRANS service
TRANS – Translate Data from One Coded Character Set
Identifier (CCSID) to Another
Command Invocation Format
ISPEXEC TRANS FRMCCSID(from-ccsid-number)
TOCCSID(to-ccsid-number)
FROMVAR(from-variable-name)
[TOVAR(to-variable-name)]
[LENGTH(data-length)]
Call Invocation Format
CALL ISPEXEC (buf-len, buffer)
OR
CALL ISPLINK (’TRANS
’,from-ccsid-number,to-ccsid-number,
from-variable-name
[,to-variable-name]
[,data-length]);
Return Codes
0
4
8
16
20
Normal completion.
Translation tables do not support the requested ‘to/from’ combination.
From variable not found.
Variable services indicated a translation error or truncation occurred
storing the translated data.
Severe error.
VCOPY – Create a Copy of a Variable
Command Invocation Format
ISPEXEC *This service does not apply to APL2 or command
procedures*
Call Invocation Format
CALL ISPEXEC *This service cannot be used with this interface*
OR
CALL ISPLINK (’VCOPY ’, name-list, length-array, value-array
[,’LOCATE ’|’MOVE
’] );
Return Codes
0
8
12
16
20
Normal completion.
One or more variables do not exist.
Validation failed.
Truncation has occurred during data movement (move mode only).
Severe error.
VDEFINE – Define Function Variables
Command Invocation Format
ISPEXEC *This service does not apply to APL2 or command
procedures*
Call Invocation Format
CALL ISPEXEC *This service cannot be used with this interface*
OR
68
z/OS V1R7.0 ISPF Reference Summary
VDEFINE service
CALL ISPLINK (’VDEFINE ’, name-list, variable, format, length
[,options-list]
[,user-data]);
Return Codes
0
8
16
20
Normal completion.
Variable not found.
Data truncation occurred.
Severe error.
VDELETE – Remove a Definition of Function Variables
Command Invocation Format
ISPEXEC *This service does not apply to APL2 or
command procedures*
Call Invocation Format
CALL ISPEXEC *This service cannot be used with this interface*
OR
CALL ISPLINK (’VDELETE ’, name-list|’*
’);
Return Codes
0
8
20
Normal completion.
At least one variable not found.
Severe error.
VERASE – Remove Variables from Shared and/or Profile Pool
Command Invocation Format
ISPEXEC VERASE name-list
[ASIS|SHARED|PROFILE|BOTH]
Call Invocation Format
CALL ISPEXEC (buf-len, buffer);
OR
CALL ISPLINK (’VERASE ’, name-list
[,’ASIS
’|SHARED ’|’PROFILE ’|’BOTH
’] );
Return Codes
0
8
20
Normal completion.
At least one variable not found.
Severe error.
VGET – Retrieve Variables from a Pool or Profile
Command Invocation Format
ISPEXEC VGET name-list [ASIS|SHARED|PROFILE]
Call Invocation Format
CALL ISPEXEC (buf-len, buffer);
OR
Chapter 2. ISPF Service Syntax with Return Codes
69
VGET service
CALL ISPLINK (’VGET
’, name-list
[,’ASIS
’|’SHARED ’|’PROFILE ’] );
Return Codes
0
8
12
16
20
Normal completion.
Variable not found.
Validation failed.
Translation error or truncation occurred during data movement.
Severe error.
VIEW – View a Data Set
Command Invocation Format
ISPEXEC VIEW DATASET(dsname)
[VOLUME(serial)]
[PASSWORD(pswd-value)]
[PANEL(panel-name)]
[MACRO(macro-name)]
[PROFILE(profile-name)]
[FORMAT(format-name)]
[MIXED(YES|NO)]
[CONFIRM(YES|NO)]
[WS(YES|NO)]
[CHGWARN(YES|NO)]
[PARM(parm-var)]
OR
ISPEXEC VIEW DATAID(data-id)
[MEMBER(member-name)]
[PANEL(panel-name)]
[MACRO(macro-name)]
[PROFILE(profile-name)]
[FORMAT(format-name)]
[MIXED(YES|NO)]
[CONFIRM(YES|NO)]
[WS(YES|NO)]
[CHGWARN(YES|NO)]
[PARM(parm-var)]
OR
ISPEXEC VIEW WSFN(ws-filename) [PANEL(panel-name)]
[MACRO(macro-name)]
[PROFILE(profile-name)]
[FORMAT(format-name)]
[MIXED(YES|NO)]
[CONFIRM(YES|NO)]
[WS(YES|NO)]
[CHGWARN(YES|NO)]
[PARM(parm-var)]
Call Invocation Format
CALL ISPLINK (’VIEW
70
z/OS V1R7.0 ISPF Reference Summary
’, {dsname} ,[serial]
,[pswd-value]
,[panel-name]
,[macro-name]
,[profile-name]
,{data-id}
,[member-name]
,[format-name]
,[’YES
’|’NO
’]
,[’YES
’|’NO
’)]
,{ws-filename-buffer-name}
,[’YES’|’NO’]
VIEW service
,[’YES’|’NO’]
,[parm-var]);
OR
CALL ISPEXEC (buf-len, buffer);
Return Codes
0
12
14
16
18
20
Normal completion
Note: Data can only be saved using the CREATE or REPLACE primary
commands.
VIEW has been disabled through the ISPF configuration table.
Member or sequential data set in use.
One of the following:
v No members matched the specified pattern.
v No members in the partitioned data set.
A VSAM data set was specified but the ISPF Configuration Table does not
allow VSAM processing.
Severe error; unable to continue.
VIIF – View Interface
Command Invocation Format
Command procedures cannot be used to invoke this service.
Call Invocation Format
CALL ISPLINK (’VIIF
’,[data-name] ,profile-name
,rec-format ,rec-len
,read-routine,
,[cmd-routine] ,[dialog-data]
,[edit-len] ,[panel-name]
,[macro-name] ,[format-name]
,[’YES
’|’NO
’]
,[’YES
’|’NO
’]);
OR
CALL ISPLINK (’VIIF
’,[data-name] ,’ ’
,[rec-format] ,[rec-len]
,read-routine ,
,[cmd-routine] ,[dialog-data]
,’ ’ ,’ ’ ,’ ’ ,’ ’ ,’ ’
,’YES
’);
Return Codes
Read Routine:
0
Normal completion.
8
End of data records (no data record returned).
16
Read error. If a read error is encountered when building the initial view
display, the VIIF service terminates with a return code of 20. Otherwise,
the edit data is redisplayed.
20
Severe error. (VIIF service terminates immediately with a return code of
20.)
Command Routine Return Codes:
0
Normal completion.
Chapter 2. ISPF Service Syntax with Return Codes
71
VIIF service
4
12
20
The PDF component should process the requested function.
Command deferred; retain the command on the Command line. View data
is redisplayed.
Severe error. (VIIF service terminates immediately with a return code of
20.)
VIIF Return Codes:
0
Normal completion, data saved.
4
Normal completion, data not saved.
12
View has been disabled through the ISPF Configuration table.
16
Unexpected return code received from a dialog-supplied routine. When an
unexpected return code is received, the EDIF service terminates
immediately with a return code of 16.
20
Severe error; unable to continue.
VMASK – Associate an Edit Mask with a Dialog Variable
Command Invocation Format
ISPEXEC *This service does not apply to APL2 or command
procedures*
Call Invocation Format
CALL ISPLINK (’VMASK
’,name-list{,’FORMAT ’{,’IDATE ’}
{
{,’STDDATE ’}
{
{,’ITIME ’}
{
{,’STDTIME ’}
{
{,’JDATE ’}
{
{,’JSTD
’}
{,’USER
’,’mask’,masklen)
}
}
}
}
}
}
}
Return Codes
0
8
20
Normal completion.
Variable not found.
Severe error.
VPUT – Update Variables in the Shared or Profile Pool
Command Invocation Format
ISPEXEC VPUT name-list [ASIS|SHARED|PROFILE]
Call Invocation Format
CALL ISPEXEC (buf-len, buffer);
OR
CALL ISPLINK (’VPUT
’, name-list
[,’ASIS
’|’SHARED ’|’PROFILE ’] );
Return Codes
0
8
16
20
72
Normal completion.
Variable not found.
Truncation occurred while copying variables to the application profile pool.
Severe error.
z/OS V1R7.0 ISPF Reference Summary
VREPLACE service
VREPLACE – Replace a Variable
Command Invocation Format
ISPEXEC *This service does not apply to
APL2 or command procedures*
Call Invocation Format
CALL ISPEXEC *This service cannot be used with this interface*
OR
CALL ISPLINK (’VREPLACE’, name-list, lengths, values);
Return Codes
0
16
20
Normal completion.
Truncation has occurred during data movement.
Severe error.
VRESET – Reset Function Variables
Command Invocation Format
ISPEXEC *This service does not apply to
APL or command procedures*
Call Invocation Format
CALL ISPEXEC *This service cannot be used with this interface*
OR
CALL ISPLINK (’VRESET ’);
Return Codes
0
20
Normal completion.
Severe error.
WSCON — Connect to a Workstation
Command Invocation Format
ISPEXEC WSCON [IP(ip_var_name)]
[LU(lu_var_name)]
[FI
]
[TITLE(title_var_name)]
[FRAME(STD | FIX | DLG)]
[BKGRND(STD | DLG)]
[CODEPAGE(codepage)]
[CHARSET(character_set)]
[NOGUIDSP]
[PANEL(YES | NO | ONERROR)]
Call Invocation Format
CALL ISPLINK (’WSCON ’
,[ip_var_name]
,[lu_var_name]
,[FI]
,[title_var_name]
,[STD | FIX | DLG]
,[STD | DLG]
,[codepage]
Chapter 2. ISPF Service Syntax with Return Codes
73
WSCON service
,[character_set]
,[NOGUIDSP]
,[YES | NO | ONERROR]);
OR
CALL ISPEXEC (buf-len, buffer);
Return Codes
0
8
12
14
16
20
Normal completion. Connection established.
The user pressed End, Exit, or Cancel from the Initiate Workstation
Connection panel without making a connection.
Already in GUI mode. Recursive error.
Connecting in GUI mode is not supported when in partition mode or split
screen.
Cannot connect to workstation.
Parameters not valid or syntax conflict. For example, both IP and LU were
specified.
WSDISCON — Connect to a Workstation
Command Invocation Format
ISPEXEC WSDISCON
Call Invocation Format
CALL ISPLINK (’WSDISCON’);
OR
CALL ISPEXEC (buf-len, buffer);
Return Codes
0
8
10
12
14
74
Normal completion. User disconnected from workstation.
User trying to disconnect from workstation, but there is no current
connection.
User trying to disconnect from GUI mode, but is connected with GUISCRD
or GUISCRW values that are different than the host emulator session. User
is not disconnected.
User trying to disconnect from a GUI display when running BATCH GUI
mode. User is not disconnected.
User trying to disconnect from workstation while running the Workstation
Tool Integration Configuration program. User is not disconnected.
z/OS V1R7.0 ISPF Reference Summary
Chapter 3. Edit Macro Commands
This chapter contains the syntax and return codes for the ISPF Edit macros. For a
complete description of the Edit macros see z/OS ISPF Edit and Edit Macros.
AUTOLIST - Set or Query Autolist Mode
Macro Command Syntax
ISREDIT AUTOLIST [ON | OFF]
Assignment Statement Syntax
ISREDIT (varname) = AUTOLIST
ISREDIT AUTOLIST = [ON | OFF]
Return Codes
0
20
Normal completion.
Severe error.
AUTONUM - Set or Query Autonum Mode
Macro Command Syntax
ISREDIT AUTONUM [ON | OFF]
Assignment Statement Syntax
ISREDIT (varname) = AUTONUM
ISREDIT AUTONUM = [ON | OFF]
Return Codes
0
20
Normal completion.
Severe error.
AUTOSAVE - Set or Query Autosave Mode
Macro Command Syntax
ISREDIT AUTOSAVE [ON
]
[OFF PROMPT ]
[OFF NOPROMPT]
Assignment Statement Syntax
ISREDIT (var1,var2) = AUTOSAVE
ISREDIT AUTOSAVE = [ON
]
[OFF PROMPT ]
[OFF NOPROMPT]
© Copyright IBM Corp. 1989, 2005
75
AUTOSAVE edit macro
Return Codes
0
4
20
Normal completion.
OFF NOPROMPT specified.
Severe error.
BLKSIZE - Query the Block Size
Assignment Statement Syntax
ISREDIT (varname) = BLKSIZE
Return Codes
0
12
20
Normal completion.
Syntax error.
Severe error.
BOUNDS - Set or Query the Edit Boundaries
Macro Command Syntax
ISREDIT BOUNDS [left-col right-col]
Assignment Statement Syntax
ISREDIT (var1,var2) = BOUNDS
ISREDIT BOUNDS = [left-col right-col]
Return Codes
0
4
12
20
Normal completion.
Right boundary greater than default; default right boundary used.
Invalid boundaries specified.
Severe error.
BROWSE - Browse from within an Edit Session
Macro Command Syntax
ISREDIT BROWSE member
Return Codes
0
12
20
Normal completion
Your error (invalid member name, recovery pending)
Severe error.
BUILTIN - Process a Built-In Command
Macro Command Syntax
ISREDIT BUILTIN cmdname
76
z/OS V1R7.0 ISPF Reference Summary
BUILTIN edit macro
Return Codes
n
20
Return code from the built-in command.
Severe error.
CANCEL - Cancel Edit Changes
Macro Command Syntax
ISREDIT CANCEL
Return Codes
0
20
Normal completion.
Severe error.
CAPS - Set or Query Caps Mode
Macro Command Syntax
ISREDIT CAPS [ON | OFF]
Assignment Statement Syntax
ISREDIT (varname) = CAPS
ISREDIT CAPS = [ON | OFF]
Return Codes
0
20
Normal completion.
Severe error.
CHANGE - Change a Search String
Macro Command Syntax
ISREDIT CHANGE string-1 string-2 [label-range] [NEXT ]
[ALL ]
[FIRST]
[LAST ]
[PREV ]
[CHARS ] [X ] [col-1 [col-2]]
[PREFIX] [NX]
[SUFFIX]
[WORD ]
Return Codes
0
4
8
12
20
Normal completion.
String not found.
Change error. String-2 is longer than string-1 and substitution was not
performed on at least one change.
Inconsistent parameters. The string to be found will not fit between the
specified columns.
Severe error.
Chapter 3. Edit Macro Commands
77
CHANGE_COUNTS edit macro
CHANGE_COUNTS - Query Change Counts
Assignment Statement Syntax
ISREDIT (var1,var2) = CHANGE_COUNTS
Return Codes
0
20
Normal completion.
Severe error.
COMPARE - Compare Data Set
Macro Command Syntax
ISREDIT COMPARE dsname [NEXT ] [SAVE] [SYSIN] [EXCLUDE]
Return Codes
0
8
12
20
Normal completion
Member or data set not found, or an error opening the member or data set
occurred.
No parameters specified, or another parameter error such as not valid
NEXT or member specification.
Severe error. SuperC, allocation, or delta file error occurred.
COPY - Copy Data
Macro Command Syntax
ISREDIT COPY member {AFTER } lptr [linenum-range]
{BEFORE}
(member)
data set name
Return Codes
0
8
12
16
20
Normal completion.
End of data reached before last record read.
Invalid line pointer (lptr); member not found or BLDL error.
End of data reached before first record of specified range was reached.
Syntax error (invalid name, incomplete range,), or I/0 error.
CREATE - Create a Data Set Member
Macro Command Syntax
ISREDIT CREATE member lptr-range
(member) {range}
dataset(member) {range}
Return Codes
0
8
78
Normal completion.
Member already exists, member not created.
z/OS V1R7.0 ISPF Reference Summary
CREATE edit macro
12
20
Invalid line pointer (lptr). The referenced line does not exist in the file.
Syntax error (invalid name or incomplete lptr range), or I/O error.
CTL_LIBRARY - Query Controlled Library Status
Assignment Statement Syntax
ISREDIT (var1,var2) = CTL_LIBRARY
Return Codes
0
20
Normal completion.
Severe error.
CURSOR - Set or Query the Cursor Position
Assignment Statement Syntax
ISREDIT (var1,var2) = CURSOR
ISREDIT CURSOR = lptr [col]
Return Codes
0
4
12
20
Normal completion.
Column number beyond data, line number incremented.
Invalid line number.
Severe error.
Note: To set the cursor to the command line, exit your macro with a return code of
1.
CUT — Cut and Save Lines
Assignment Statement Syntax
ISREDIT CUT [lptr-range] [DEFAULT | clipboardname]
[REPLACE | APPEND]
Return Codes
0
12
20
Normal completion.
Parameter error. Insufficient storage, or no more clipboards available.
Severe error.
DATA_CHANGED - Query the Data Changed Status
Assignment Statement Syntax
ISREDIT (varname) = DATA_CHANGED
Return Codes
0
20
Normal completion.
Severe error.
Chapter 3. Edit Macro Commands
79
DATA_WIDTH edit macro
DATA_WIDTH - Query Data Width
Assignment Statement Syntax
ISREDIT (varname) = DATA_WIDTH
Return Codes
0
12
20
Normal completion.
Invalid command format.
Severe error.
DATAID - Query Data ID
Assignment Statement Syntax
ISREDIT (varname) = DATAID
Return Codes
0
4
8
20
The data ID returned was passed to the editor.
Data ID was generated by and will be freed by the editor.
A previously generated data ID was returned.
Severe error.
DATASET - Query the Current Data Set Name
Assignment Statement Syntax
ISREDIT (varname) = DATASET
Return Codes
0
20
Normal completion.
Severe error.
DEFINE - Define a Name
Macro Command Syntax
ISREDIT DEFINE name {MACRO CMD }
{MACRO PGM }
{ALIAS name-2}
{NOP
}
{RESET
}
{DISABLED
}
Return Codes
0
8
12
20
80
Normal completion.
RESET was attempted for a name not currently defined, or DEFINE name
ALIAS name-2 requested and name-2 is a NOP.
DEFINE was attempted for a name not currently defined.
Severe error (unknown command).
z/OS V1R7.0 ISPF Reference Summary
DELETE edit macro
DELETE - Delete Lines
Macro Command Syntax
ISREDIT DELETE { ALL X | NX [lptr-range]}
{[ALL] X | NX lptr-range }
{lptr
}
{lptr-range
}
Return Codes
0
4
8
12
20
Normal (lines deleted successfully).
No lines deleted.
No standard records exist.
Invalid line number.
Severe error.
DISPLAY_COLS - Query Display Columns
Assignment Statement Syntax
ISREDIT (var1,var2) = DISPLAY_COLS
Return Codes
0
12
20
Normal completion.
Invalid command format.
Severe error.
DISPLAY_LINES - Query Display Lines
Assignment Statement Syntax
ISREDIT (var1,var2) = DISPLAY_LINES
Return Codes
0
4
8
12
20
Normal completion.
No visible data lines.
No existing data lines.
Invalid command format.
Severe error.
DOWN - Scroll Down
Macro Command Syntax
ISREDIT DOWN amt
Return Codes
0
2
4
8
Normal completion.
No more data DOWN.
No visible lines.
No data to display.
Chapter 3. Edit Macro Commands
81
DOWN edit macro
12
20
Amount not specified.
Severe error.
EDIT - Edit from Within an Edit Session
Macro Command Syntax
ISREDIT EDIT member
Return Codes
0
4
12
14
20
28
Normal completion. Data was saved.
Normal completion. Data was not saved.
Your error (invalid member name, recovery pending).
Member in use.
Severe error.
No ISREDIT MACRO statement preceded this call, or BROWSE was
substituted because of the size of the member being edited.
END - End the Edit Session
Macro Command Syntax
ISREDIT END
Return Codes
0
4
12
20
Normal completion.
New member saved.
END not done, AUTOSAVE OFF PROMPT set, or Data not saved
(insufficient space).
Severe error.
EXCLUDE - Exclude Lines from the Panel
Macro Command Syntax
ISREDIT EXCLUDE string [label-range] [NEXT ]
[ALL ]
[FIRST]
[LAST ]
[PREV ]
Return Codes
0
4
8
12
20
82
Normal completion.
String not found.
Line(s) not excluded.
Inconsistent parameters
Severe error.
z/OS V1R7.0 ISPF Reference Summary
[CHARS ] [col-1 [col-2]]
[PREFIX]
[SUFFIX]
[WORD ]
EXCLUDE_COUNTS edit macro
EXCLUDE_COUNTS - Query Exclude Counts
Assignment Statement Syntax
ISREDIT (var1,var2) = EXCLUDE_COUNTS
Return Codes
0
12
20
Normal completion.
Invalid command format.
Severe error.
FIND - Find a Search String
Macro Command Syntax
ISREDIT FIND string [label-range] [NEXT ]
[ALL ]
[FIRST]
[LAST ]
[PREV ]
[CHARS ] [X ] [col-1 [col-2]]
[PREFIX] [NX]
[SUFFIX]
[WORD ]
Return Codes
0
4
12
20
Normal completion.
String not found.
Syntax error.
Severe error.
FIND_COUNTS - Query Find Counts
Assignment Statement Syntax
ISREDIT (var1,var2) = FIND_COUNTS
Return Codes
0
12
20
Normal completion.
Invalid command format.
Severe error.
FLIP - Reverse Excluded Status of Lines
Macro Command Syntax
ISREDIT FLIP [label-range]
Return Codes
0
20
Successful completion. The excluded status of the requested lines was
reversed.
Severe error.
Chapter 3. Edit Macro Commands
83
FLOW_COUNTS edit macro
FLOW_COUNTS - Query Flow Counts
Assignment Statement Syntax
ISREDIT (var1,var2) = FLOW_COUNTS
Return Codes
0
20
Normal completion.
Severe error.
HEX - Set or Query Hexadecimal Mode
Macro Command Syntax
ISREDIT HEX [ON DATA]
[ON VERT]
[OFF
]
Assignment Statement Syntax
ISREDIT (var1,var2) = HEX
ISREDIT HEX = [ON DATA]
[ON VERT]
[OFF
]
Return Codes
0
20
Normal completion.
Severe error.
HIDE - Hide Excluded Lines Message
Macro Command Syntax
ISREDIT HIDE X
Return Codes
0
20
Normal completion.
Severe error.
HILITE - Enhanced Edit Coloring
Macro Command Syntax
ISREDIT HILITE [ON
]
[OFF
]
[LOGIC ]
[IFLOGIC]
[DOLOGIC]
[NOLOGIC]
|
84
z/OS V1R7.0 ISPF Reference Summary
[AUTO
] [RESET] [PAREN] [FIND] [CURSOR] [SEARCH] [DISABLED]
[DEFAULT]
[OTHER ]
[ASM
]
[BOOK
]
[C
]
[COBOL ]
[DTL
]
[HTML
]
[JCL
]
[PANEL ]
[PASCAL ]
HILITE edit macro
[PLI
[REXX
[SKEL
[IDL
[SUPERC
[XML
|
]
]
]
]
]
]
Return Codes
0
8
12
20
Normal completion.
One of the following conditions:
v LOGIC or SEARCH not supported in the current environment
v Invalid language
v HILITE unavailable.
One of the following conditions:
v HILITE dialog is invalid from an edit macro
v HILITE not available because of the installation defaults
v HILITE not available because the edit panel in use is not enabled for
enhanced color
v Other error encountered.
Severe error. Possibly extra parameters.
IMACRO - Set or Query an Initial Macro
Macro Command Syntax
ISREDIT IMACRO {name | NONE}
Assignment Statement Syntax
ISREDIT (varname) = IMACRO
ISREDIT IMACRO = name
Return Codes
0
4
12
20
Normal completion.
IMACRO set not accepted; profile is locked.
Invalid name specified.
Severe error.
INSERT - Prepare Display for Data Insertion
Macro Command Syntax
ISREDIT INSERT lptr [numlines]
Return Codes
0
12
20
Normal completion.
Invalid line number.
Severe error.
Chapter 3. Edit Macro Commands
85
LABEL edit macro
LABEL - Set or Query a Line Label
Assignment Statement Syntax
ISREDIT (var1,var2) = LABEL lptr
ISREDIT LABEL lptr = labelname [level]
Return Codes
0
4
8
12
20
Normal completion.
Label name not returned, specified line has no label.
Label set, but an existing label at the same level was deleted.
Line number specified is beyond the end of data.
Severe error.
LEFT - Scroll Left
Macro Command Syntax
ISREDIT LEFT amt
Return Codes
0
4
8
12
20
Normal completion.
No visible lines.
No data to display.
Amount not specified.
Severe error.
LEVEL - Set or Query the Mod Level Number
Macro Command Syntax
ISREDIT LEVEL num
Assignment Statement Syntax
ISREDIT (varname) = LEVEL
ISREDIT LEVEL = num
Return Codes
0
4
12
20
86
Normal completion.
Statistics mode is off; the command is ignored.
Invalid value specified.
Severe error.
z/OS V1R7.0 ISPF Reference Summary
LINE edit macro
LINE - Set or Query a Line from the Data Set
Assignment Statement Syntax
ISREDIT (varname) = LINE lptr
ISREDIT LINE lptr = data
Return Codes
0
4
8
12
16
20
Normal completion.
Data truncated (line shorter than data supplied).
Variable not found.
Invalid line number.
Variable data truncated.
Severe error.
LINE_AFTER - Add a Line to the Current Data Set
Assignment Statement Syntax
ISREDIT LINE_AFTER lptr = [DATALINE] data
[INFOLINE]
[MSGLINE ]
[NOTELINE]
Return Codes
0
4
12
20
Normal completion.
Data truncated.
Invalid line number.
Severe error.
LINE_BEFORE - Add a Line to the Current Data Set
Assignment Statement Syntax
ISREDIT LINE_BEFORE lptr = [DATALINE] data
[INFOLINE]
[MSGLINE ]
[NOTELINE]
Return Codes
0
4
12
20
Normal completion.
Data truncated.
Invalid line number.
Severe error.
LINE_STATUS - Query Source and Change Information for a Line in a
Data Set
Assignment Statement Syntax
ISREDIT (varname) = LINE_STATUS lptr
Chapter 3. Edit Macro Commands
87
LINE_STATUS edit macro
Return Codes
0
12
20
Normal completion.
Line number not valid.
Severe error.
LINENUM - Query the Line Number of a Labeled Line
Assignment Statement Syntax
ISREDIT (varname) = LINENUM label
Return Codes
0
4
8
12
20
Normal completion.
Line 0 specified.
Label specified, but not found (variable set to 0).
Invalid line number.
Severe error.
LOCATE - Locate a Line
Specific Locate Syntax
ISREDIT LOCATE lptr
Generic Locate Syntax
ISREDIT LOCATE [FIRST]
[LAST ]
[NEXT ]
[PREV ]
{CHANGE } [lptr-range]
{COMMAND }
{ERROR }
{EXCLUDED}
{LABEL }
{SPECIAL }
{INFOLINE}
{MSGLINE}
{NOTELINE}
Return Codes
0
4
8
20
Normal completion.
Line not located.
Empty member or data set.
Severe error.
LRECL - Query the Logical Record Length
Assignment Statement Syntax
ISREDIT (varname) = LRECL
Return Codes
0
12
20
88
Normal completion.
Invalid command format.
Severe error.
z/OS V1R7.0 ISPF Reference Summary
MACRO edit macro
MACRO - Identify an Edit Macro
Macro Command Syntax
ISREDIT MACRO [(var1 [,var2,...])] [PROCESS ]
[NOPROCESS]
Return Codes
0
8
12
20
Normal completion.
No parameters are permitted for this processing.
Syntax error.
Severe error.
MACRO_LEVEL - Query the Macro Nesting Level
Assignment Statement Syntax
ISREDIT (varname) = MACRO_LEVEL
Return Codes
0
12
20
Normal completion.
Invalid command format.
Severe error.
MASKLINE - Set or Query the Mask Line
Assignment Statement Syntax
ISREDIT (varname) = MASKLINE
ISREDIT MASKLINE = data
Return Codes
0
4
16
20
Normal completion.
Data truncated.
Variable data truncated.
Severe error.
MEMBER - Query the Current Member Name
Assignment Statement Syntax
ISREDIT (varname) = MEMBER
Return Codes
0
12
20
Normal completion.
Invalid command format.
Severe error.
Chapter 3. Edit Macro Commands
89
MEND edit macro
MEND - End a Macro in the Batch Environment
Macro Command Syntax
ISREDIT MEND
Return Codes
0
20
Normal completion.
Severe error.
Note: Only required in the MVS/370 environment.
MODEL - Copy a Model into the Current Data Set
Macro Command Model Name Syntax
ISREDIT MODEL model-name [qualifier] {AFTER } lptr [NOTES ]
{BEFORE}
[NONOTES]
Macro Command Class Name Syntax
ISREDIT MODEL CLASS class-name
Return Codes
0
4
12
20
Normal completion.
Data truncated (the model exceeded the right-hand margin of the data
being edited).
Invalid line pointer.
Severe error.
MOVE - Move a Data Set Member
Macro Command Syntax
ISREDIT MOVE member {AFTER } lptr
{BEFORE}
(member)
data set name
data.set.name(member)
Return Codes
0
8
12
16
20
Normal completion.
End of data before last record read, or the specified data set is in use.
Invalid line pointer (lptr); member not found or BLDL error.
End of data before first record read.
Syntax error (invalid name, incomplete range), or I/O error.
NONUMBER - Turn Off Number Mode
Syntax
ISREDIT NONUMBER
90
z/OS V1R7.0 ISPF Reference Summary
NONUMBER edit macro
Return Codes
0
20
Normal completion.
Severe error.
NOTES - Set or Query Note Mode
Macro Command Syntax
ISREDIT NOTES [ON | OFF ]
Assignment Statement Syntax
ISREDIT (varname) = NOTES
ISREDIT NOTES = [ON | OFF]
Return Codes
0
20
Normal completion.
Severe error.
NULLS - Set or Query Nulls Mode
Macro Command Syntax
ISREDIT NULLS [ON STD]
[ON ALL]
[OFF ]
Assignment Statement Syntax
ISREDIT (var1,var2) = NULLS
ISREDIT NULLS = [ON STD]
[ON ALL]
[OFF ]
Return Codes
0
20
Normal completion.
Severe error.
NUMBER - Set or Query Number Mode
Macro Command Syntax
ISREDIT NUMBER [ON ] [STD
] [DISPLAY]
[OFF] [COBOL
]
[STD COBOL]
[NOSTD]
[NOCOBOL]
[NOSTD NOCOBOL]
Assignment Statement Syntax
ISREDIT (var1,var2) = NUMBER
ISREDIT NUMBER = [ON ] [STD
[OFF] [COBOL
] [DISPLAY]
]
Chapter 3. Edit Macro Commands
91
NUMBER edit macro
[STD COBOL]
[NOSTD]
[NOCOBOL]
[NOSTD NOCOBOL]
Return Codes
0
20
Normal completion.
Severe error.
PACK - Set or Query Pack Mode
Macro Command Syntax
ISREDIT PACK [ON | OFF]
Assignment Statement Syntax
ISREDIT (varname) = PACK
ISREDIT PACK = [ON | OFF]
Return Codes
0
20
Normal completion.
Severe error.
PASTE — Move or Copy Lines from Clipboard
Macro Command Syntax
ISREDIT PASTE [AFTER] lptr [clipboardname]
[BEFORE] [KEEP]
Return Codes
0
12
20
Normal completion.
Parameter error. Clipboard empty or does not exist.
Severe error.
PRESERVE - Enable Saving of Trailing Blanks
Macro Command Syntax
ISREDIT PRESERVE [ON | OFF]
Assignment Statement Syntax
ISREDIT (varname) = PRESERVE
ISREDIT PRESERVE = [ON | OFF]
Return Codes
0
6
16
20
92
Normal completion.
Record format is not variable.
Error setting variable.
Severe error.
z/OS V1R7.0 ISPF Reference Summary
PROCESS edit macro
PROCESS - Process the Panel
Macro Command Syntax
ISREDIT PROCESS [DEST] [RANGE cmd1 [cmd2]]
Return Codes
0
4
8
12
16
20
Normal completion.
A RANGE was expected by the macro, but one was not specified; default
values set.
A DEST (destination) was expected by the macro, but one was not
specified; default values set.
Both a RANGE and a DEST (destination) were expected by the macro, but
were not specified; default values set.
You entered incomplete or conflicting line commands.
Severe error.
Note: ISPF does not consider a return code of 12 from the PROCESS edit macro
command an error. A macro that receives a return code of 12 from the
PROCESS edit macro does not terminate.
PROFILE - Set or Query the Current Profile
Macro Command Profile Control Syntax
ISREDIT PROFILE [name] [number]
Macro Command Profile Lock Syntax
ISREDIT PROFILE {LOCK | UNLOCK}
Macro Command Profile Reset Syntax
ISREDIT PROFILE RESET
Assignment Statement Syntax
ISREDIT (var1,var2) = PROFILE
Return Codes
0
20
Normal completion.
Severe error.
RANGE_CMD - Query a Command That You Entered
Assignment Statement Syntax
ISREDIT (varname) = RANGE_CMD
Return Codes
0
4
8
Normal completion.
Line command not set.
Line command setting not acceptable.
Chapter 3. Edit Macro Commands
93
RANGE_CMD edit macro
20
Severe error.
RCHANGE - Repeat a Change
Macro Command Syntax
ISREDIT RCHANGE
Return Codes
0
4
8
12
20
Normal completion.
String not found.
Change error (string-2 longer than string-1 and substitution was not
performed on at least one change).
Syntax error.
Severe error.
RECFM - Query the Record Format
Assignment Statement Syntax
ISREDIT (varname) = RECFM
Return Codes
0
20
Normal completion.
Severe error.
RECOVERY - Set or Query Recovery Mode
Macro Command Syntax
ISREDIT RECOVERY [ON [SUSP]]
[OFF [WARN]]
[OFF NOWARN]
Assignment Statement Syntax
ISREDIT (var1, var2) = RECOVERY
ISREDIT RECOVERY = [ON [SUSP]]
[OFF [WARN]]
[OFF NOWARN]
Return Codes
0
20
Normal completion.
Severe error.
RENUM - Renumber Data Set Lines
Macro Command Syntax
ISREDIT RENUM [ON ] [STD
] [DISPLAY]
[OFF] [COBOL
]
[STD COBOL]
94
z/OS V1R7.0 ISPF Reference Summary
RENUM edit macro
Return Codes
0
20
Normal completion.
Severe error.
REPLACE - Replace a Data Set or Data Set Member
Macro Command Syntax
ISREDIT
ISREDIT
ISREDIT
ISREDIT
REPLACE
REPLACE
REPLACE
REPLACE
member lptr-range
(member) lptr-range
dataset lptr-range
dataset(member) lptr-range
Return Codes
0
8
12
20
Normal completion.
Member in use.
Invalid line pointer; member not found or BLDL error.
Syntax error (invalid name, incomplete line pointer value), or I/O error.
RESET - Reset the Data Display
Macro Command Syntax
ISREDIT RESET [CHANGE ] [lptr-range]
[COMMAND ]
[ERROR ]
[EXCLUDED]
[HIDE
]
[LABEL ]
[SPECIAL ]
Return Codes
0
20
Normal completion.
Severe error.
RFIND - Repeat Find
Macro Command Syntax
ISREDIT RFIND
Return Codes
0
4
12
20
Normal completion.
String not found.
Syntax error.
Severe error (string not defined).
RIGHT - Scroll Right
Macro Command Syntax
ISREDIT RIGHT amt
Chapter 3. Edit Macro Commands
95
RIGHT edit macro
Return Codes
0
4
8
12
20
Normal completion.
No visible lines.
No data to display.
Amount not specified.
Severe error.
RMACRO - Set or Query the Recovery Macro
Macro Command Syntax
ISREDIT RMACRO {name | NONE}
Assignment Statement Syntax
ISREDIT (varname) = RMACRO
ISREDIT RMACRO = {name | NONE}
Return Codes
0
12
20
Normal completion.
Invalid name specified.
Severe error.
SAVE - Save the Current Data
Macro Command Syntax
ISREDIT SAVE
Return Codes
0
4
12
20
Normal completion.
New member saved.
Data not saved; not enough PDS space or directory space.
Severe error.
SAVE_LENGTH - Set or Query Length for Variable Length Data
Macro Command Syntax
ISREDIT (variable) = SAVE_LENGTH .lptr
ISREDIT SAVE_LENGTH .lptr = value
Return Codes
0
4
6
16
20
96
Normal completion.
Value supplied on set call was out of range. If the supplied length was too
great, it is adjusted to equal the maximum record length. Otherwise, the
length is adjusted to the length of the nonblank data portion of the record.
Record format is not variable. Any value of an assigned request is ignored.
Error setting variable.
Severe error.
z/OS V1R7.0 ISPF Reference Summary
SCAN edit macro
SCAN - Set Command Scan Mode
Macro Command Syntax
ISREDIT SCAN [ON | OFF]
Assignment Statement Syntax
ISREDIT (varname) = SCAN
ISREDIT SCAN = [ON | OFF]
Return Codes
0
20
Normal completion.
Severe error.
SEEK - Seek a Data String, Positioning the Cursor
Macro Command Syntax
ISREDIT SEEK string [label-range] [NEXT ]
[ALL ]
[FIRST]
[LAST ]
[PREV ]
[CHARS ] [X ] [col-1 [col-2]]
[PREFIX] [NX]
[SUFFIX]
[WORD ]
Return Codes
0
4
12
20
Normal completion.
String not found.
Syntax error.
Severe error.
SEEK_COUNTS - Query Seek Counts
Assignment Statement Syntax
ISREDIT (var1,var2) = SEEK_COUNTS
Return Codes
0
20
Normal completion.
Severe error.
SESSION — Identify Type of Session
Assignment Statement Syntax
ISREDIT (var1,var2) = SESSION
Return Codes
0
20
Normal completion.
Severe error.
Chapter 3. Edit Macro Commands
97
SETUNDO edit macro
SETUNDO - Set UNDO Mode
Macro Command Syntax
ISREDIT SETUNDO [STORAGE]
[RECOVER]
[ON]
[OFF]
Assignment Statement Syntax
ISREDIT (varname) = SETUNDO
ISREDIT SETUNDO = [STORAGE]
[RECOVER]
[ON]
[OFF]
Return Codes
0
20
Successful completion. SETUNDO was turned on or off, or status remains
unchanged because UNDO was already on or off.
Severe error. Probably a parameter error (something other than STG, REC,
or OFF was specified).
SHIFT ( - Shift Columns Left
Macro Command Syntax
ISREDIT SHIFT ( lptr [n | 2]
Return Codes
0
12
20
Normal completion.
Invalid line number.
Severe error.
SHIFT ) - Shift Columns Right
Macro Command Syntax
ISREDIT SHIFT ) lptr [n | 2]
Return Codes
0
12
20
Normal completion.
Invalid line number.
Severe error.
SHIFT < - Shift Data Left
Macro Command Syntax
ISREDIT SHIFT < lptr [n | 2]
98
z/OS V1R7.0 ISPF Reference Summary
SHIFT < edit macro
Return Codes
0
12
20
Normal completion.
Invalid line number.
Severe error.
SHIFT > - Shift Data Right
Macro Command Syntax
ISREDIT SHIFT > lptr [n | 2]
Return Codes
0
12
20
Normal completion.
Invalid line number.
Severe error.
SORT - Sort Data
Macro Command Syntax
ISREDIT SORT [label-range] [X ] [sort-field1 ... sort-field5]
[NX]
Return Codes
0
4
8
16
20
Normal completion.
Lines were already in sort order.
No records to sort.
Not enough storage to perform sort.
Severe error.
STATS - Set or Query Stats Mode
Macro Command Syntax
ISREDIT STATS [ON | OFF]
Assignment Statement Syntax
ISREDIT (varname) = STATS
ISREDIT STATS = [ON | OFF]
Return Codes
0
20
Normal completion.
Severe error.
SUBMIT - Submit Data for Batch Processing
Macro Command Syntax
ISREDIT SUBMIT [lptr-range]
Chapter 3. Edit Macro Commands
99
SUBMIT edit macro
Return Codes
0
20
Normal completion.
Severe error (submit failed).
TABS - Set or Query Tabs Mode
Macro Command Syntax
ISREDIT TABS [ON] [STD]
[ALL]
[tab-character]
[OFF]
Assignment Statement Syntax
ISREDIT (var1,var2) = TABS
ISREDIT TABS = [ON] [STD]
[ALL]
[tab-character]
[OFF]
Return Codes
0
20
Normal completion.
Severe error.
TABSLINE - Set or Query Tabs Line
Assignment Statement Syntax
ISREDIT (varname) = TABSLINE
ISREDIT TABSLINE = data
Return Codes
0
4
8
20
Normal completion.
Data truncated.
Invalid data detected and ignored.
Severe error (invalid input).
TENTER - Set Up Panel for Text Entry
Macro Command Syntax
ISREDIT TENTER lptr [numlines]
Return Codes
0
12
20
100
Normal completion.
Invalid line number.
Severe error.
z/OS V1R7.0 ISPF Reference Summary
TFLOW edit macro
TFLOW - Text Flow a Paragraph
Macro Command Syntax
ISREDIT TFLOW lptr [col]
Return Codes
0
12
20
Normal completion.
Invalid line number.
Severe error.
TSPLIT - Text Split a Line
Macro Command Syntax
ISREDIT TSPLIT [lptr col]
Return Codes
0
12
20
Normal completion.
Invalid line number.
Severe error.
UNNUMBER - Remove Sequence Numbers
Macro Command Syntax
ISREDIT UNNUMBER
Return Codes
0
12
20
Normal completion.
Number mode not on.
Severe error.
UP - Scroll Up
Macro Command Syntax
ISREDIT UP amt
Return Codes
0
2
4
8
12
20
Normal completion.
No more data UP.
No visible lines.
No data to display.
Amount not specified.
Severe error.
Chapter 3. Edit Macro Commands
101
USER_STATE edit macro
USER_STATE - Save or Restore User State
Assignment Statement Syntax
ISREDIT (varname) = USER_STATE
ISREDIT USER_STATE = (varname)
Return Codes
0
20
Normal completion.
Severe error.
VERSION - Set or Query Version Number
Macro Command Syntax
ISREDIT VERSION num
Assignment Statement Syntax
ISREDIT (varname) = VERSION
ISREDIT VERSION = num
Return Codes
0
4
12
20
Normal completion.
Stats mode is off, the command is ignored.
Invalid value specified (the version must be 1 to 99).
Severe error.
VIEW - View from within an Edit Session
Macro Command Syntax
ISREDIT VIEW member
Return Codes
0
12
20
Normal completion
Your error (invalid member name, recovery pending)
Severe error.
VOLUME — Query Volume Information
Assignment Statement Syntax
ISREDIT (var1,var2,var3) = VOLUME
Return Codes
0
4
102
Normal completion.
The data set is a multivolume data set and the shared pool variable
ZEDMVOL is set to contain all the volume serial numbers of the data set.
ZEDMVOL has the length of the number of volumes times six.
z/OS V1R7.0 ISPF Reference Summary
VOLUME edit macro
20
Severe error.
XSTATUS - Set or Query Exclude Status of a Line
Assignment Statement Syntax
ISREDIT (varname) = XSTATUS lptr
ISREDIT XSTATUS lptr = X | NX
Return Codes
0
8
12
20
Normal completion.
An attempt to set a line status to NX could not be performed. The line has
a pending line command on it. For example, if an excluded line contains
an M line command in the line command field, then the MOVE/COPY IS
PENDING message is displayed and the lines cannot be shown. The reset
command can be used to remove your line commands from the line
command field.
Line number is not an existing line.
Severe error.
Chapter 3. Edit Macro Commands
103
XSTATUS edit macro
104
z/OS V1R7.0 ISPF Reference Summary
Chapter 4. SCLM Services and Macros
This chapter contains the syntax conventions and return codes for the SCLM
services as well as the syntax conventions for the SCLM macros. For a complete
description of the services and macros see the z/OS ISPF Software Configuration and
Library Manager Reference.
SCLM Services
ACCTINFO - Retrieve Accounting Information
Command Invocation Format
FLMCMD ACCTINFO,project
,[prj_def]
,group
,type
,member
,[user_info_table]
,[include_table]
,[change_code_table]
,[ada_cu_table]
,[SEARCH|FORWARD|MATCH]
,[dd_msgs]
Call Invocation Format
lastrc := FLMLNK(’ACCTINFO ’,sclm_id,
,group
,type
,member
,user_info_table
,include_table
,change_code_table
,ada_cu_table
,SEARCH|FORWARD|MATCH
,$msg_array);
Return Codes
0
8
12
20
24
32
34
© Copyright IBM Corp. 1989, 2005
Normal completion. An account record exactly matching the specified
criteria was found and the information was stored successfully.
Error completion. No account record was found for the specified member.
v If FORWARD was specified then there are no accounting records for the
group which match or follow the specified type and member name.
v If MATCH was specified then there is not an account record with the
specified group, type and member name.
v If SEARCH was specified then there are no matching account records
found when searching up the hierarchy starting from the specified
group.
Error completion. Refer to the messages for more information.
Severe error condition. SCLM does not produce messages because the
SCLM ID is invalid.
Severe error condition. SCLM does not produce messages because SCLM
services have not been initialized.
Severe error condition. An invalid parameter list was passed to the
requested service.
Severe error condition. An invalid service was requested.
105
ACCTINFO Service
36
Severe error condition. The version of the FLMLNK subroutine does not
match the version of the SCLM services module.
AUTHCODE - Set or Retrieve an AUTHCODE
Command Invocation Format
FLMCMD AUTHCODE,project
,[prj_def]
,group
,type
,member
,[from_authcode]
,[to_authcode]
,[C|U]
,[dd_authmsgs]
,[dd_authrept]
Call Invocation Format
lastrc := FLMLNK(’AUTHCODE’,sclm_id,
,group
,type
,member
,from_authcode
,to_authcode
,C|U
,dd_authmsgs
,dd_authrept);
Return Codes
0
2
4
8
12
16
20
24
32
106
Normal completion. Authcode changed or reported successfully.
Normal completion. Authcode not changed. One of the following occurred:
v To_authcode = existing authcode (no change needed)
v From_authcode requested does not equal existing authcode (no change
wanted)
v Member is not editable.
Warning condition. Segment exists at a lower level with an authcode not
equal to the ″to_authcode″ which could overlay the current segment.
Error condition. Invalid type, member, or mode parameter. See the
dd_authmsgs for details.
Severe error condition. Accounting record not found or severe error.
Severe error condition. One of the following occurred:
v Not authorized to update ″to_authcode″, access_key mismatch, or not
authorized to update data set.
v Verification failed.
v Error updating accounting record.
v Invalid group.
SCLM might not produce messages because there was an error invoking
the AUTHCODE module.
Severe error condition. SCLM does not produce messages because the
SCLM ID is not valid.
Severe error condition. SCLM does not produce messages because SCLM
services have not been initialized.
Severe error condition. SCLM does not produce messages for one of the
following reasons:
v You requested an invalid service.
v You supplied an invalid parameter list for the requested service.
v The version of the FLMLNK subroutine does not match the version of
the SCLM services module.
z/OS V1R7.0 ISPF Reference Summary
BUILD service
BUILD - Build a Member
Command Invocation Format
FLMCMD BUILD,project
,[prj_def]
,group
,type
,member
,[userid]
,[E|L|N|S]
,[C|F|R|U]
,[Y|N]
,[Y|N]
,[prefix_userid]
,[dd_bldmsgs]
,[dd_bldrept]
,[dd_bldlist]
,[dd_bldexit]
Call Invocation Format
lastrc := FLMLNK(’BUILD
’,sclm_id
,group
,type
,member
,{userid|’ ’}
,{E|L|N|S}
,{C|F|R|U}
,{Y|N}
,{Y|N}
,{prefix_userid | ’ ’}
,dd_bldmsgs
,dd_bldrept
,dd_bldlist
,dd_bldexit);
Return Codes
0
4
8
12
16
20
24
32
34
36
Normal completion.
Warning condition.
Error condition.
Severe error condition. Messages are not produced. Error invoking the
Build module.
Severe error condition. Messages are not produced. Unable to retrieve
SCLM ID information.
Severe error condition. Messages are not produced. Invalid SCLM ID.
Severe error condition. Messages are not produced. SCLM services have
not been initialized.
Severe error condition. Messages are not produced for one of the following
reasons:
v Invalid service requested
v Invalid parameter list for the requested service
v The version of the FLMLNK subroutines does not match the version of
the SCLM services module.
Severe error condition. An invalid service was requested.
Severe error condition. The version of the FLMLNK subroutine does not
match the version of the SCLM services module.
Chapter 4. SCLM Services and Macros
107
DBACCT service
DBACCT - Retrieve Accounting Records for a Member
Command Invocation Format
You cannot use command procedures to call this service.
Call Invocation Format
lastrc := FLMLNK(’DBACCT ’,sclm_id
,group
,type
,member
,found_group
,$acct_info
,$list_info
,$msg_array);
Return Codes
0
4
8
20
24
32
34
36
Normal completion.
Warning condition. The accounting record could not be found.
Error condition. See the $msg_array parameter above for more details.
Severe error condition. Messages are not produced. Invalid SCLM ID.
Severe error condition. Messages are not produced. SCLM services have
not been initialized.
Severe error condition. Messages are not produced for one of the following
reasons:
v Invalid service requested
v Invalid parameter list for the requested service
v The version of the FLMLNK subroutines does not match the version of
the SCLM services module.
Severe error condition. An invalid service was requested.
Severe error condition. The version of the FLMLNK subroutine does not
match the version of the SCLM services module.
DBUTIL - Generate a Tailored Data Set and Report
Command Invocation Format
FLMCMD DBUTIL,project
,[prj_def]
,[acct_group1|*],[acct_group2]
,[acct_group3],[acct_group4]
,[acct_group5],[acct_group6]
,[acct_type|*],[acct_member|*]
,[authcode|*],[change_code|*]
,[change_group|*],[change_userid|*]
,[language|*],[YES|NO]
,[ACCT|BMAP|*]
,[IN|OUT|*]
,[arch_group],[arch_type],[arch_member]
,[EXTENDED|NORMAL|SUBUNIT]
,[YES|NO]
,[YES|NO]
,[report_name],[dd_msgs]
,[dd_rept],[dd_tailor]
,[report_line]
Call Invocation Format
You cannot use call procedures to start this service.
Return Codes
0
108
Normal completion.
z/OS V1R7.0 ISPF Reference Summary
DBUTIL service
4
8
>8
Warning condition.
Error condition.
Severe error condition. Messages are not produced.
DELETE - Delete Database Components
Command Invocation Format
FLMCMD DELETE,project
,[prj_def]
,group
,type
,member
,access_key
,[ACCT|BMAP|TEXT]
Call Invocation Format
lastrc := FLMLNK(’DELETE ’,sclm_id
,group
,type
,member
,access_key
,{ACCT|BMAP|TEXT}
,$msg_array);
Return Codes
0
4
8
20
24
32
34
36
Normal completion.
Warning condition. The member, accounting record, or build map were not
found.
Error condition.
Severe error condition. Messages are not produced. Invalid SCLM ID.
Severe error condition. Messages are not produced. SCLM services have
not been initialized.
Severe error condition. Messages are not produced for one of the following
reasons:
v Invalid service requested
v Invalid parameter list for the requested service
v The version of the FLMLNK subroutines does not match the version of
the SCLM services module.
Severe error condition. An invalid service was requested.
Severe error condition. The version of the FLMLNK subroutine does not
match the version of the SCLM services module.
DELGROUP - Delete Database Components from Group
Command Invocation Format
FLMCMD DELGROUP,project
,[prj_def]
,{group|*}
,{type|*}
,{member|*}
,{ACCT|BMAP|TEXT|OUTPUT}
,[EXECUTE|REPORT]
,[dd_list]
,[dd_msgs]
,[dd_rept]
,[dd_exit]
,[pack_del]
,[pack_days]
Chapter 4. SCLM Services and Macros
109
DELGROUP service
Call Invocation Format
lastrc := FLMLNK(’DELGROUP’,sclm_id
,{group|*}
,{type|*}
,{member|*}
,{ACCT|BMAP|TEXT|OUTPUT}
,{EXECUTE|REPORT}
,dd_list
,dd_msgs
,dd_rept
,dd_exit
,{Y|N}
,pack_days);
Return Codes
0
4
8
12
16
20
24
32
34
36
Normal completion.
Warning condition.
Error condition.
Severe error condition. SCLM does not produce messages because there
was an error invoking the DELGROUP module.
Severe error condition. SCLM does not produce messages because it was
unable to retrieve SCLM ID information.
Severe error condition. SCLM does not produce messages because the
SCLM ID is invalid.
Severe error condition. SCLM does not produce messages because SCLM
services have not been initialized.
Severe error condition. SCLM does not produce messages for one of the
following reasons:
v You requested an invalid service.
v You supplied an invalid parameter list for the requested service.
v The version of the FLMLNK subroutine does not match the version of
the SCLM services module (for future use).
Severe error condition. An invalid service was requested.
Severe error condition. The version of the FLMLNK subroutine does not
match the version of the SCLM services module.
DSALLOC—Allocate Data Sets for Group/Type
Command Invocation Format
FLMCMD DSALLOC,project
,[prj_def]
,first_group
,[A|P]
,total_groups
,type
,ddname
Call Invocation Format
lastrc := FLMLNK(’DSALLOC ’,sclm_id
,first_group
,{A|P}
,total_groups
,type
,ddname
,$msg_array);
Return Codes
0
110
Normal completion.
z/OS V1R7.0 ISPF Reference Summary
DSALLOC service
4
Warning condition. The $msg_array parameter contains the warning
message associated with this condition. A warning occurs if the number of
data sets allocated to ddname is less than the number requested in the
total_groups parameter.
8
Error condition. The $msg_array parameter contains the error message
associated with this condition.
20
Severe error condition. SCLM does not produce messages because the
SCLM ID (sclm_id parameter) is invalid.
24
Severe error condition. SCLM does not produce messages because SCLM
services were not initialized.
32
Severe error condition. SCLM does not produce messages for one of the
following reasons:
v Invalid service requested
v Invalid parameter list for the requested service
v The version of the FLMLNK subroutines does not match the version of
the SCLM services module.
34
Severe error condition. An invalid service was requested.
36
Severe error condition. The version of the FLMLNK subroutine does not
match the version of the SCLM services module.
EDIT— Edit a Member of a Controlled Library
Command Invocation Format
FLMCMD EDIT,project
,(prj_def)
,group1
,(group2)
,(group3)
,(group4)
,type
,member
,(Y|N)
,(imac)
(prof),
,(Y|N)
,(Y|N)
,(Y|N)
,(Y|N)
,(authcode)
,(chgcode)
,(volser)
,(dd_editmsgs)
Chapter 4. SCLM Services and Macros
111
EDIT service
Call Invocation Format
lastrc := FLMLNK(’EDIT’, sclm_id
,group1
,(group2)
,(group3)
,(group4)
,type
,member
,(Y|N)
,(imac)
,(prof)
,(Y|N)
,(Y|N)
,(Y|N)
,(Y|N)
,(authcode)
,(chgcode)
,(volser)
,(dd_editmsgs));
Return Codes
Possible return codes are:
0
Normal completion.
8
Error condition. See the dd_editmsgs for details.
12
Severe error condition. SCLM does not produce messages because there
was an error invoking the edit module.
20
Severe error condition. SCLM does not produce messages because the
SCLM ID is invalid.
24
Severe error condition. SCLM does not produce messages because SCLM
services have not been initialized. See the z/OS ISPF Software Configuration
and Library Manager Reference for information on initializing an SCLM
services session.
32
Severe error condition. SCLM does not produce messages for one of the
following reasons:
v You requested an invalid service.
v You supplied an invalid parameter list for the requested service.
v The version of FLMLNK subroutine does not match the version of the
SCLM services module.
END - End an SCLM Services Session
Command Invocation Format
You cannot use command procedures to call this service.
Call Invocation Format
lastrc := FLMLNK(’END
’,appl_id
,msg_line);
Return Codes
0
4
8
112
Normal completion.
Warning condition. Unable to free an SCLM ID associated with the
application ID.
Error condition.
z/OS V1R7.0 ISPF Reference Summary
END service
24
32
34
36
Severe error condition. Messages are not produced. SCLM services have
not been initialized.
Severe error condition. SCLM does not produce messages for one of the
following reasons:
v Invalid service requested
v Invalid parameter list for the requested service
v The version of the FLMLNK subroutines does not match the version of
the SCLM services module.
Severe error condition. An invalid service was requested.
Severe error condition. The version of the FLMLNK subroutine does not
match the version of the SCLM services module.
EXPORT - Extract SCLM Accounting Information for a Group
Command Invocation Format
FLMCMD EXPORT,project
,[prj_def]
,group
,[Y|N]
,[dd_msgs]
,[dd_rept]
Call Invocation Format
lastrc := FLMLNK(’EXPORT ’,sclm_id
,group
,{Y|N}
,dd_msgs
,dd_rept);
Return Codes
0
4
8
12
16
20
24
32
34
36
Normal completion.
Warning condition.
Error condition.
Severe error condition. SCLM does not produce messages because there
was an error invoking the IMPORT module.
Severe error condition. SCLM does not produce messages because it was
unable to retrieve SCLM ID information.
Severe error condition. SCLM does not produced messages because the
SCLM ID is invalid.
Severe error condition. SCLM does not produce messages because SCLM
services have not been initialized.
Severe error condition. SCLM does not produce messages for one of the
following reasons:
v You requested an invalid service.
v You supplied an invalid parameter list for the requested service.
v The version of the FLMLNK subroutine does not match the version of
the SCLM services module (for future use).
Severe error condition. An invalid service was requested.
Severe error condition. The version of the FLMLNK subroutine does not
match the version of the SCLM services module.
FREE - Free Database from its Association with SCLM ID
Command Invocation Format
You cannot use command procedures to call this service.
Chapter 4. SCLM Services and Macros
113
FREE service
Call Invocation Format
lastrc := FLMLNK(’FREE
’,sclm_id
,msg_line);
Return Codes
0
8
24
32
34
36
Normal completion.
Error condition.
Severe error condition. Messages are not produced. SCLM services have
not been initialized.
Severe error condition. Messages are not produced. One of the following is
true:
v You requested an invalid service.
v You supplied an invalid parameter list for the requested service.
v The version of the FLMLNK subroutine does not match the version of
the SCLM services module.
Severe error condition. An invalid service was requested.
Severe error condition. The version of the FLMLNK subroutine does not
match the version of the SCLM services module.
GETBLDMP—Retrieve Build Map Information
Command Invocation Format
FLMCMD GETBLDMP,project
,[prj_def]
,group
,type
,member
,bmap_table
,[dd_msgs]
Call Invocation Format
lastrc := FLMLNK(’GETBLDMP’,sclm_id
,group
,type
,member
,bmap_table
,$msg_array);
Return Codes
0
4
8
12
Normal completion. A build map record was found that exactly matched
the specified criteria and the information was stored successfully.
Normal completion. A build map record was found at a higher level. The
information was stored successfully.
Error completion. No account record was found for the specified member.
Error completion. Refer to the messages for more information.
IMPORT - Import SCLM Accounting Information to Current
Project
Command Invocation Format
FLMCMD IMPORT,project
,[prj_def]
,group
,[authcode|’ ’]
,[change_code|’ ’]
114
z/OS V1R7.0 ISPF Reference Summary
IMPORT service
,[userid|’ ’]
,[C|U|R]
,[dd_msgs]
,[dd_rept]
Call Invocation Format
lastrc := FLMLNK(’IMPORT ’,sclm_id
,group
,{authcode}
,{change_code}
,{userid}
,{C|U|R}
,dd_msgs
,dd_rept);
Return Codes
0
4
8
12
16
20
24
32
34
36
Normal completion.
Warning condition.
Error condition.
Severe error condition. SCLM does not produce messages because there
was an error invoking the IMPORT module.
Severe error condition. SCLM does not produce messages because it was
unable to retrieve SCLM ID information.
Severe error condition. SCLM does not produced messages because the
SCLM ID is invalid.
Severe error condition. SCLM does not produce messages because SCLM
services have not been initialized.
Severe error condition. SCLM does not produce messages for one of the
following reasons:
v You requested an invalid service.
v You supplied an invalid parameter list for the requested service.
v The version of the FLMLNK subroutine does not match the version of
the SCLM services module (for future use).
Severe error condition. An invalid service was requested.
Severe error condition. The version of the FLMLNK subroutine does not
match the version of the SCLM services module.
INIT - Generate an SCLM ID for a Database
Command Invocation Format
You cannot use command procedures to call this service.
Call Invocation Format
lastrc := FLMLNK(’INIT
’,appl_id
,project
,prj_def
,sclm_id
,msg_line);
Return Codes
0
8
24
32
Normal completion.
Error condition.
Severe error condition. Messages are not produced. SCLM services have
not been initialized.
Severe error condition. Messages are not produced. One of the following is
true:
v You requested an invalid service.
Chapter 4. SCLM Services and Macros
115
INIT service
34
36
v You supplied an invalid parameter list for the requested service.
v The version of the FLMLNK subroutine does not match the version of
the SCLM services module.
Severe error condition. An invalid service was requested.
Severe error condition. The version of the FLMLNK subroutine does not
match the version of the SCLM services module.
LOCK - Lock a Member or Assign an Access Key
Command Invocation Format
FLMCMD LOCK,project
,[prj_def]
,group
,type
,member
,[authcode]
,[access_key]
,[userid]
Call Invocation Format
lastrc := FLMLNK(’LOCK
’,sclm_id
,group
,type
,member
,{authcode|’ ’}
,{access_key|’ ’}
,{userid|’ ’}
,found_group
,max_prom_group
,$acct_info
,$list_info
,$msg_array);
Return Codes
0
8
20
24
32
34
36
Normal completion.
Error condition.
Severe error condition. Messages are not produced. Invalid SCLM ID.
Severe error condition. Messages are not produced. SCLM services have
not been initialized.
Severe error condition. Messages are not produced. One of the following is
true:
v You requested an invalid service.
v You supplied an invalid parameter list for the requested service.
v The version of the FLMLNK subroutine does not match the version of
the SCLM services module.
Severe error condition. An invalid service was requested.
Severe error condition. The version of the FLMLNK subroutine does not
match the version of the SCLM services module.
MIGRATE - Create Accounting Information for Selected
Members
Command Invocation Format
FLMCMD MIGRATE,project
,[prj_def]
,group,type,member
,[authcode]
,[language]
116
z/OS V1R7.0 ISPF Reference Summary
MIGRATE service
,[change_code]
,[C|U|F]
,[dd_migmsgs]
,[dd_miglist]
,[dd_migrept]
,[date]
,[time]
Call Invocation Format
lastrc:=FLMLNK(’MIGRATE ’,sclm_id
,group
,type
,member
,authcode
,language
,change_code
,C|U|F
,[dd_migmsgs]
,[dd_miglist]
,[dd_migrept]
,[date]
,[time]);
Return Codes
0
4
8
20
24
32
Normal completion.
Warning condition. See the SCLM messages for more information.
Error condition. See the SCLM messages for more information.
Severe error condition. SCLM does not produce messages because the
SCLM ID is invalid.
Severe error condition. SCLM does not produce messages because SCLM
services have not been initialized.
Severe error condition. SCLM does not produce messages for one of the
following reasons:
v You requested an invalid service.
v You supplied an invalid parameter list for the requested service.
NEXTGRP - Find the Next Group in a Hierarchy
Command Invocation Format
FLMCMD NEXTGRP,project
,[prj_def]
,group
,[dd_msgs]
Call Invocation Format
lastrc := FLMLNK(’NEXTGRP ’,sclm_id
,group
,dd_msgs);
Return Codes
0
4
8
12
20
Normal completion. NEXTGRP completed successfully. Variables are set.
Warning condition. The group is already the top group. No variables are
set.
Error condition. Invalid project, prj_def, or group name.
Severe error condition. SCLM might not produce messages because there
was an error invoking the NEXTGRP module. For certain conditions
messages are available.
Severe error condition. Messages are not produced. Invalid SCLM ID.
Chapter 4. SCLM Services and Macros
117
NEXTGRP service
24
32
Severe error condition. Messages are not produced. SCLM services have
not been initialized.
Severe error condition. Messages are not produced. One of the following is
true:
v You requested an invalid service.
v You supplied an invalid parameter list for the requested service.
v The version of the FLMLNK subroutine does not match the version of
the SCLM services module.
PARSE - Parse a Member for Statistical and Dependency
Information
Command Invocation Format
You cannot use command procedures to call this service.
Call Invocation Format
lastrc := FLMLNK(’PARSE
’,sclm_id
,group
,type
,member
,language
,{Y|N}
,ddname
,$stats_info
,$list_info
,$msg_array);
Return Codes
0
4
8
20
24
32
34
36
Normal completion.
Warning condition. A parser error occurred.
Error condition.
Severe error condition. Messages are not produced. Invalid SCLM ID.
Severe error condition. Messages are not produced. SCLM services have
not been initialized.
Severe error condition. Messages are not produced. One of the following is
true:
v You requested an invalid service.
v You supplied an invalid parameter list for the requested service.
v The version of the FLMLNK subroutine does not match the version of
the SCLM services module.
Severe error condition. An invalid service was requested.
Severe error condition. The version of the FLMLNK subroutine does not
match the version of the SCLM services module.
PROMOTE - Promote a Member from One Library to Another
Command Invocation Format
FLMCMD PROMOTE,project
,[prj_def]
,group
,type
,member
,[userid]
,[E|N|S]
,[C|U|R]
118
z/OS V1R7.0 ISPF Reference Summary
PROMOTE service
,[dd_prommsgs]
,[dd_promrept]
,[dd_promexit]
,[dd_copyerr]
Call Invocation Format
lastrc := FLMLNK(’PROMOTE ’,sclm_id
,group,type,member
,{userid|’ ’}
,{E|N|S}
,{C|U|R}
,dd_prommsgs,dd_promrept
,dd_promexit,dd_copyerr);
Return Codes
0
4
8
12
16
20
24
32
34
36
Normal completion.
Warning condition.
Error condition.
Severe error condition. Messages are not produced. Error invoking the
Promote module.
Severe error condition. Messages are not produced. Unable to retrieve
SCLM ID information.
Severe error condition. Messages are not produced. Invalid SCLM ID.
Severe error condition. Messages are not produced. SCLM services have
not been initialized.
Severe error condition. Messages are not produced. One of the following is
true:
v You requested an invalid service.
v You supplied an invalid parameter list for the requested service.
v The version of the FLMLNK subroutine does not match the version of
the SCLM services module.
Severe error condition. An invalid service was requested.
Severe error condition. The version of the FLMLNK subroutine does not
match the version of the SCLM services module.
RPTARCH - Generate an SCLM Architecture Report
Command Invocation Format
FLMCMD RPTARCH,project,[prj_def]
,group
,type
,member
,[HL|LEC|CC|GEN|TOP SOURCE|NONE]
,dd_rptmsgs
,dd_rptrept
Call Invocation Format
You cannot use call procedures to start this service.
Return Codes
0
4
8
16
Normal completion.
Warning condition.
Error condition.
Error condition. Unable to retrieve the SCLM table.
Chapter 4. SCLM Services and Macros
119
SAVE service
SAVE - Lock, Parse, and Store a Member
Command Invocation Format
FLMCMD SAVE,project,[prj_def]
,group,type,member
,[authcode],[access_key]
,[userid],[language]
,[Y|N]
,[ddname],[C|U]
,[C|U]
,[change_code]
Call Invocation Format
lastrc := FLMLNK(’SAVE
’,sclm_id
,group,type,member
,authcode,access_key
,{userid|’ ’},language
,{Y|N}
,ddname
,{C|U}
,{C|U}
,{Y|N}
,$list_info
,max_prom_group
,$msg_array);
Return Codes
0
4
8
20
24
32
34
36
Normal completion.
Warning condition.
Error condition.
Severe error condition. Messages are not produced. Invalid SCLM ID.
Severe error condition. Messages are not produced. SCLM services have
not been initialized.
Severe error condition. Messages are not produced. One of the following is
true:
v You requested an invalid service.
v You supplied an invalid parameter list for the requested service.
v The version of the FLMLNK subroutine does not match the version of
the SCLM services module.
Severe error condition. An invalid service was requested.
Severe error condition. The version of the FLMLNK subroutine does not
match the version of the SCLM services module.
SCLMINFO - Return Project Information
Command Invocation Format
FLMCMD SCLMINFO,project
,[prj_def]
Call invocation format
lastrc := FLMLNK(’SCLMINFO’,sclm_id);
Return Codes
0
12
120
Normal completion.
Error condition.
z/OS V1R7.0 ISPF Reference Summary
START service
START - Generate an Application ID for a Service Session
Command Invocation Format
You cannot use command procedures to call this service.
Call Invocation Format
lastrc := FLMLNK(’START
’,appl_id);
Return Codes
0
12
16
20
24
28
32
34
36
Normal completion.
Severe error condition. The maximum application ID limit was exceeded.
Severe error condition. An invalid version of the SCLM table was loaded.
Severe error condition. An invalid version of the NLS table was loaded.
Severe error condition. Unable to load the SCLM table.
Severe error condition. Unable to load the NLS table or the SCLM I/O load
module.
Severe error condition. Messages are not produced. One of the following is
true:
v You requested an invalid service.
v You supplied an invalid parameter list for the requested service.
v The version of the FLMLNK subroutine does not match the version of
the SCLM services module.
Severe error condition. An invalid service was requested.
Severe error condition. The version of the FLMLNK subroutine does not
match the version of the SCLM services module.
STORE - Store Member Information in an Accounting Record
Command Invocation Format
You cannot use command procedures to call this service.
Call Invocation Format
lastrc := FLMLNK(’STORE
’,sclm_id
,group,type,member
,access_key
,language
,{userid|’ ’}
,{C|U}
,{Y|N}
,$stats_info,$list_info
,$msg_array);
Return Codes
0
4
8
20
24
32
34
Normal completion.
Warning condition.
Error condition.
Severe error condition. Messages are not produced. Invalid SCLM ID.
Severe error condition. Messages are not produced. SCLM services have
not been initialized.
Severe error condition. Messages are not produced. One of the following is
true:
v You requested an invalid service.
v You supplied an invalid parameter list for the requested service.
v The version of the FLMLNK subroutine does not match the version of
the SCLM services module.
Severe error condition. An invalid service was requested.
Chapter 4. SCLM Services and Macros
121
STORE service
36
Severe error condition. The version of the FLMLNK subroutine does not
match the version of the SCLM services module.
UNLOCK - Unlock a Member in a Development Library
Command Invocation Format
FLMCMD UNLOCK,project
,[prj_def]
,group
,type
,member
,[access_key]
Call Invocation Format
lastrc := FLMLNK(’UNLOCK ’,sclm_id
,group
,type
,member
,{access_key|’ ’}
,$msg_array);
Return Codes
0
4
8
20
24
32
34
36
Normal completion.
Warning condition.
Error condition.
Severe error condition. Messages are not produced. Invalid SCLM ID.
Severe error condition. Messages are not produced. SCLM services have
not been initialized.
Severe error condition. Messages are not produced. One of the following is
true:
v You requested an invalid service.
v You supplied an invalid parameter list for the requested service.
v The version of the FLMLNK subroutine does not match the version of
the SCLM services module.
Severe error condition. An invalid service was requested.
Severe error condition. The version of the FLMLNK subroutine does not
match the version of the SCLM services module.
VERDEL—Delete Version Information
Command Invocation Format
FLMCMD VERDEL,project
,[prj_def]
,group
,type
,member
,date
,time
,[dd_msgs]
,[longdate]
Call Invocation Format
lastrc := FLMLNK(’VERDEL ’,sclm_id,
,group
,type
,member
,date
122
z/OS V1R7.0 ISPF Reference Summary
VERDEL Service
,time
,$msg_array
,[longdate]);
Return Codes
0
8
12
20
24
32
34
36
Normal completion. The audit and version information were deleted.
Error completion. No audit and version information was deleted. No audit
record was found that matches the specified criteria.
Error completion. Refer to the messages for more information.
Severe error condition. SCLM does not produce messages because the
SCLM ID is invalid.
Severe error condition. SCLM does not produce messages because SCLM
services have not been initialized.
Severe error condition. An invalid parameter list was passed to the
requested service.
Severe error condition. An invalid service was requested.
Severe error condition. The version of the FLMLNK subroutine does not
match the version of the SCLM services module.
VERINFO - Retrieve Version Information
Command Invocation Format
FLMCMD VERINFO,project
,[prj_def]
,group
,type
,member
,[date]
,[time]
,[user_info_table]
,[include_table]
,[change_code_table]
,[ada_cu_table]
,[FORWARD|BACKWARD|MATCH]
,[dd_msgs]
,[longdate]
Call Invocation Format
lastrc := FLMLNK(’VERINFO ’,sclm_id,
,group
,type
,member
,date
,time
,user_info_table
,include_table
,change_code_table
,ada_cu_table
,FORWARD|BACKWARD|MATCH
,$msg_array
,[longdate]);
Return Codes
0
8
Normal completion. An audit record exactly matching the specified criteria
was found and the information was stored successfully.
Error completion. No audit record was found for the specified member.
v If FORWARD was specified then there are no audit records for the group
which match or follow the specified type, member, date and time.
Chapter 4. SCLM Services and Macros
123
VERINFO Service
12
20
24
32
34
36
v If BACKWARD was specified then there are no audit records for the
group which match or precede the specified type, member, date and
time.
v If MATCH was specified then there is not an audit record with the
specified group, type and member name.
Error completion. Refer to the messages for more information.
Severe error condition. SCLM does not produce messages because the
SCLM ID is invalid.
Severe error condition. SCLM does not produce messages because SCLM
services have not been initialized.
Severe error condition. An invalid parameter list was passed to the
requested service.
Severe error condition. An invalid service was requested.
Severe error condition. The version of the FLMLNK subroutine does not
match the version of the SCLM services module.
VERRECOV - Recover A Version
Command Invocation Format
FLMCMD VERRECOV,project
,[prj_def]
,group
,type
,member
,date
,time
,[to_dataset]
,[to_group]
,[to_type]
,[authcode]
,[dd_msgs]
,[longdate]
Call Invocation Format
lastrc := FLMLNK(’VERRECOV’,sclm_id,
,group
,type
,member
,date
,time
,to_dataset
,to_group
,to_type
,authcode
,$msg_array
,[longdate]);
Return Codes
0
8
10
12
20
24
124
Normal completion. The audit and version information were recovered.
Error completion. No audit and version information was recovered. No
audit record was found that matches the specified criteria.
Error completion. No audit and version information was recovered. The
member could not be locked with the specified authorization code.
Error completion. Refer to the messages for more information.
Severe error condition. SCLM does not produce messages because the
SCLM ID is invalid.
Severe error condition. SCLM does not produce messages because SCLM
services have not been initialized.
z/OS V1R7.0 ISPF Reference Summary
VERRECOV Service
32
34
36
Severe error condition. An invalid parameter list was passed to the
requested service.
Severe error condition. An invalid service was requested.
Severe error condition. The version of the FLMLNK subroutine does not
match the version of the SCLM services module.
SCLM Macros
FLMABEG - Define the Project Name of the Project Definition
Macro Format
name FLMABEG
FLMAEND - Last Macro in the Project Definition
Macro Format
FLMAEND
FLMAGRP - Define a Group of Authorization Codes
Macro Format
name FLMAGRP AC=(code1,code2,...)
FLMALLOC - Define Each DDname in the DDname
Substitution List for a Translator
Macro Format
FLMALLOC IOTYPE={A|I|L|N|O|P|S|U|W}
[,BLKSIZE=block_size]
[,CATLG=N|Y]
[,DDNAME=ddname]
[,DINIT=N|Y]
[,DIRBLKS=directory_blocks]
[,DISP=OLD|SHR|MOD|NEW]
[,DFLTMEM=default_member]
[,DFLTTYP=default_type]
[,KEYREF=keyword_reference]
[,LANG=language]
[,MALLOC=N|Y]
[,ALLCDEL=N|Y]
[,LRECL=record_length]
[,MEMBER=member_name]
[,NOSAVRC=no_save_rc]
[,PRINT=N|Y|I]
[,RECFM=record_format]
[,RECNUM=number_of_records]
[,INCLS=include_set_name]
FLMALTC - Specify Alternate Control Information
Macro Format
name FLMALTC
ACCT=primary_accounting_data_set
[,ACCT2=secondary_accounting_data_set]
[,DSNAME=dataset_name]
Chapter 4. SCLM Services and Macros
125
FLMALTC macro
[,EXPACCT=export_account_data_set]
[,VERS=primary_audit_control_data_set]
[,VERS2=secondary_audit_control_data_set]
[,VERPDS=version_pds_name]
FLMATVER - Enable the Audit and Version Utility
Macro Format
FLMATVER
GROUP=group|*
,TYPE=type|*
,SEQNUM=STANDARD|STD|COBOL|NONE
[,VERSION=YES|NO]
[,VERCOUNT=number_to_retain]
FLMCMPLB - Define a Set of Data Sets for a Language
Containing Project Compool Dependencies
Macro Format
[language] FLMCMPLB dataset_name
FLMCNTRL - Specify Project-Specific Control Options
Macro Format
FLMCNTRL
[ACCT=primary_account_data_set|project.ACCOUNT.FILE]
[,ACCT2=secondary_account_data_set]
[,EXPACCT=export_account_data_set]
[,VERS=primary_audit_control_data_set]
[,VERS2=secondary_audit_control_data_set]
[,VSAMRLS=NO|YES]
[,VERPDS=version_pds_name]
[,VERCOUNT=number_to_retain]
[,DSNAME=dataset_name_pattern]
[,DASDUNIT=DASD_unit_name|SYSALLDA]
[,VIOUNIT=VIO_unit_name|VIO]
[,MAXLINE=max_line_count|60]
[,MAXVIO=max_vio_count|5000]
[,OPTOVER=N|Y]
[,VERCC=change_code_routine]
[,VERCCDS=change_code_dataset]
[,VERCCCM=LINK|ATTACH|TSOLNK|ISPLNK]
[,VERCCOP=change_code_options]
[,CCVFY=initial_change_code_exit_routine]
[,CCVFYDS=initial_change_code_exit_dataset]
[,CCVFYCM=LINK|ATTACH|TSOLNK|ISPLNK]
[,CCVFYOP=initial_change_code_exit_options]
[,CCSAVE=save_change_code_exit_routine]
[,CCSAVDS=save_change_code_exit_dataset]
[,CCSAVCM=LINK|ATTACH|TSOLNK|ISPLNK]
[,CCSAVOP=save_change_code_exit_options]
[,AVDVFY=verify_audit_version_delete_exit_routine]
[,AVDVFYDS=verify_audit_version_delete_exit_dataset]
[,AVDVFYCM=LINK|ATTACH|TSOLNK|ISPLNK]
[,AVDVFYOP=verify_audit_version_delete_exit_options]
[,AVDNTF=notify_audit_version_delete_exit_routine]
[,AVDNTFDS=notify_audit_version_delete_exit_dataset]
[,AVDNTFCM=LINK|ATTACH|TSOLNK|ISPLNK]
126
z/OS V1R7.0 ISPF Reference Summary
FLMCNTRL macro
[,AVDNTFOP=notify_audit_version_delete_exit_options]
[,BLDINIT=build_initial_user_exit_routine]
[,BLDINIDS=build_initial_user_exit_dataset]
[,BLDINICM=LINK|ATTACH|TSOLNK|ISPLNK]
[,BLDINIOP=build_initial_user_exit_options]
[,BLDNTF=build_notify_user_exit_routine]
[,BLDNTFDS=build_notify_user_exit_dataset]
[,BLDNTFCM=LINK|ATTACH|TSOLNK|ISPLNK]
[,BLDNTFOP=build_notify_user_exit_options]
[,PRMINIT=promote_initial_user_exit_routine]
[,PRMINIDS=promote_initial_user_exit_dataset]
[,PRMINICM=LINK|ATTACH|TSOLNK|ISPLNK]
[,PRMINIOP=promote_initial_user_exit_options]
[,PRMVFY=promote_verify_user_exit_routine]
[,PRMVFYDS=promote_verify_user_exit_dataset]
[,PRMVFYCM=LINK|ATTACH|TSOLNK|ISPLNK]
[,PRMVFYOP=promote_verify_user_exit_options]
[,PRMCOPY=promote_copy_user_exit_routine]
[,PRMCPYDS=promote_copy_user_exit_dataset]
[,PRMCPYCM=LINK|ATTACH|TSOLNK|ISPLNK]
[,PRMCPYOP=promote_copy_user_exit_options]
[,PRMPURGE=promote_purge_user_exit_routine]
[,PRMPRGDS=promote_purge_user_exit_dataset]
[,PRMPRGCM=LINK|ATTACH|TSOLNK|ISPLNK]
[,PRMPRGOP=promote_purge_user_exit_options]
[,DELINIT=initial_delete_exit_routine]
[,DELINIDS=initial_delete_exit_dataset]
[,DELINICM=LINK|ATTACH|TSOLNK|ISPLNK]
[,DELINIOP=initial_delete_exit_options]
[,DELVFY=verify_delete_exit_routine]
[,DELVFYDS=verify_delete_exit_dataset]
[,DELVFYCM=LINK|ATTACH|TSOLNK|ISPLNK]
[,DELVFYOP=verify_delete_exit_options]
[,DELNTF=notify_delete_exit_routine]
[,DELNTFDS=notify_delete_exit_dataset]
[,DELNTFCM=LINK|ATTACH|TSOLNK|ISPLNK]
[,DELNTFOP=notify_delete_exit_options]
FLMCPYLB - Identify Additional Data Sets to Be Concatenated
to a DDname
Macro Format
FLMCPYLB dataset_name|NULLFILE
FLMGROUP - Define One Group in the Project Definition
Macro Format
name FLMGROUP
[AC=(code1,code2,...)]
[,ALTC=group_control_options]
[,KEY=N|Y]
[,PROMOTE=next_group]
Chapter 4. SCLM Services and Macros
127
FLMINCLS macro
FLMINCLS - Associate Include-Sets with Types in the Project
Hierarchy
Macro Format
name FLMINCLS
[SAMEAS=flmincls_name_ | Types=(list_of_types)]
[CROSLANG=Y|N]
FLMLANGL - Define a Language to SCLM
Macro Format
FLMLANGL LANG=language
[,ALCSYSLIB=N|Y]
[,ARCH=N|Y]
[,BUFSIZE=buffer_size|100]
[,CANEDIT=Y|N]
[,CHKSYSLB=PARSE|BUILD|IGNORE]
[,COMPOOL=N|Y]
[,DEPPRCS=Y|N]
[,DFLTCRF=default_CREF_reference]
[,DFLTSRF=default_source_reference]
[,SCOPE=LIMITED|NORMAL|SUBUNIT|EXTENDED]
[,VERSION=language_version]
[,MBRLMT=0]
FLMSYSLB - Define a Set of Data Sets for a Language
Containing Project Macros or Included Members
Macro Format
[language] FLMSYSLB dataset_name
[,INCLS=include_set_name]
FLMTCOND - Select Build Translators Based on Group and
Return Codes
Macro Format
FLMTCOND
[ GROUP=group_list|NOTGROUP=group_list]
[,WHEN=relations_list]
[,ACTION=RUN|SKIP]
FLMTOPTS - Select the Options Based on Group
Macro Format
FLMTOPTS OPTIONS=options_list
[,GROUP=group_list|NOTGROUP=group_list]
[,ACTION=APPEND|REPLACE]
FLMTRNSL - Define Once for Each Translator to Be Invoked
for a Language
Macro Format
[translator label] FLMTRNSL CALLNAM=’call_name’
[,FUNCTN=PARSE|VERIFY|BUILD|COPY|PURGE]
,COMPILE=translator_name
[,DSNAME=translator_dataset_name]
[,GOODRC=good_return_code|0]
128
z/OS V1R7.0 ISPF Reference Summary
FLMTRNSL macro
[,NOSVEXT=no_save_external_rc|0]
[,OPTFLAG=N|Y]
[,OPTIONS=option_list]
[,PARMKWD=parameter_keyword]
[,PDSDATA=Y|N]
[,PORDER=0|1|2|3]
[,VERSION=translator_version]
[,CALLMETH=ATTACH|LINK|TSOLNK|ISPLINK]
[,TASKLIB=translator_ddname]
[,INPLIST=N|Y]
[,MBRRC=maximum_good_return_code]
Note: Refer to the z/OS ISPF Software Configuration and Library Manager Reference
for information about the two translators FLMTPRE and FLMTPST.
FLMTYPE - Define One FLMTYPE in the Project Definition
Macro Format
name FLMTYPE [EXTEND=extended_type]
Chapter 4. SCLM Services and Macros
129
FLMTYPE macro
130
z/OS V1R7.0 ISPF Reference Summary
Chapter 5. System Variables
The system variables are described with type and pool information in the
following tables. The variables are also discussed with the ISPF service to which
they apply.
Commonly used system variables that a dialog can access are listed below. They
are grouped by topic.
The first column gives the name of the variable. The second column indicates in
which pool the variable resides. The following abbreviations are used:
func
Function pool
shr
Shared pool
prof
Profile pool
any
Any pool.
The third column indicates the variable’s type. The following abbreviations are
used:
in
Input variable, set by a dialog to provide information to ISPF
out
Output variable, set by ISPF to provide information to dialogs
non
Non-modifiable output variable
i/o
Both an input and an output variable.
The fourth column gives the length of the variable.
The fifth column gives a brief description of the variable.
Numeric system variables set by ISPF are right-justified and padded with zeros on
the left, if necessary. If a program function uses the VCOPY service to access the
variable, the value will be in character string format rather than in fixed binary
format.
© Copyright IBM Corp. 1989, 2005
131
System Variables
Configuration Utility
Name
Pool
Type
Len
Description
ZCFGCMPD
shr
non
10
Current Configuration module compile date. ZCFGCMPD contains the
national language delimiter and contains the date in the format
YYYY/MM/DD. For countries that use a delimiter other than a slash (/),
that delimiter replaces the slash in the date representation.
ZCFGCMPT
shr
non
ZCFGKSRC
shr
non
ZCFGLVL
shr
non
8
Current Configuration module level.
ZCFGMOD
shr
non
8
Current Configuration module name.
5
54
Current Configuration module compile time. ZCFGCMPT contains the
national language delimiter and contains the time in the format HH:MM.
For countries that use a delimiter other than a colon (:), that delimiter
replaces the colon in the time representation.
Note: This field will be blank for a configuration module compiled with
a previous version of ISPF.
Keyword source data set and member for the current configuration
module.
Note: This field will be blank for a configuration module compiled with
a previous version of ISPF.
Time and Date
Name
Pool
Type
Len
Description
ZDATE
shr
non
8
Current date. The format of ZDATE depends on the current national
language (see ZDATEF and ZDATEFD).
ZDATEF
shr
non
8
Current national language date format using the characters DD for day,
MM for month, and YY for year. ZDATEF contains the national language
delimiter. For example, DD/MM/YY, YY/MM/DD, MM.DD.YY. For
countries that use a delimiter other than a slash (/), that delimiter
replaces the slash in the date representation.
ZDATEFD
shr
non
8
The date format as described under ZDATEF but with the national
language convention instead of DD, MM, and YY.
ZDATESTD
shr
non
8
Current date with a 4–digit year (YYYY/MM/DD). The format of
ZDATESTD depends on the current national language (see ZDATEF and
ZDATEFD).
ZDAYOFWK
shr
non
8
The name of the day of the week.
ZDAY
shr
non
2
Day of month (2 characters)
ZJDATE
shr
non
6
Day-of-year date (format yy.ddd)
ZJ4DATE
shr
non
8
Day-of-year date (format yyyy.ddd)
ZMONTH
shr
non
2
Month of year (2 characters)
ZSTDYEAR
shr
non
4
All 4 digits of the current year (4 characters).
ZTIME
shr
non
5
Time of day (format hh:mm)
ZTIMEL
shr
non
ZYEAR
shr
non
Time of day (format hh:mm:ss:TQ —where T is tenths of a second, and Q
is hundredths)
2
Year (2 characters)
The current date is displayed in the appropriate format for the session language,
where DD=DAY, MM=MONTH, and YY=YEAR. For countries that use a delimiter
other than a slash (/), that delimiter replaces the slash in the date representation.
132
z/OS V1R7.0 ISPF Reference Summary
System Variables
General
Name
Pool
Type
Len
Z
shr
non
0
ZACCTNUM
shr
non
40
The MVS account number specified at logon time.
ZAPLCNT
shr
non
4
Number of times APL invoked for a logical screen
ZAPPLID
shr
non
8
Application identifier
ZAPPTTL
any
in
ZBDMAX
shr
i/o
9
Maximum number of displays that can occur within a batch mode
session. This value is obtained from the BDISPMAX keyword on the
ISPSTART command.
ZBDMXCNT
shr
non
9
Count of current number of displays in a batch mode session
ZCS
shr
non
5
NLS currency symbol
ZCSDLL
shr
non
8
File name of the DLL required for this level of code for the Client/Server
ZDECS
shr
non
1
NLS decimal separator character
ZDEL
shr
i/o
1
The delimiter is used to separate stacked commands. The default
delimiter is a semicolon (;).
ZENTKTXT
any
in
12
When you are running in GUI mode, the name that appears on the Enter
key push button. If this variable is not found, “Enter” appears on the
push button.
ZENVIR
shr
non
32
Environment description:
v Characters 1 to 8 contain the product name and sequence number, in
the form ISPF x.y. The sequence number x.y indicates the following:
5.7 means ISPF for z/OS Version 1 Release 7.0
5.6 means ISPF for z/OS Version 1 Release 6.0
5.5 means ISPF for z/OS Version 1 Release 5.0
5.2 means ISPF for z/OS Version 1 Release 2.0
5.0 means ISPF for z/OS Version 1 Release 1.0
OR
5.0 means ISPF for OS/390 Version 2 Release 10.0
4.8 means ISPF for OS/390 Version 2 Release 8.0
N/A
|
|
|
Description
Null Variable
When running in GUI mode, the title to be displayed in the window
frame.
Note: If the panel is to be displayed in a pop-up window, the value
specified in ZWINTTL will be used instead of ZAPPTTL.
Note: See also the system variables ZISPFOS and ZOS390RL.
v Characters 9 to 16 contain the generic operating system name (MVS).
v Characters 17 to 24 contain the operating system environment (TSO or
BATCH).
v Characters 25 to 32 contain blanks and are reserved.
ZEURO
shr
non
1
ZGUI
shr
non
68
Workstation address or name (in character format) if ISPSTART is issued
with the GUI parameter or if specified on the Settings GUI invocation
panel. ZGUI will be set to blank if ISPSTART is issued without the GUI
parameter or if GUI is not invoked from the Settings panel.
ZISPFOS
shr
non
30
The level of ISPF code that is running as part of z/OS on your system.
This level might or might not match the z/OS level found in ZOS390RL.
ZISPFRC
shr
in
8
The EURO currency symbol.
Return code from ISPSTART-selected dialog to invoking application.
Chapter 5. System Variables
133
System Variables
Name
Pool
Type
ZKEYHELP
any
in
8
Keys help panel identifier. If a keys help panel is not specified on the
referenced keylist, the application can provide the keys help panel name
in this variable. If the help panel name is present as part of the
referenced keylist definition, it takes precedence over the ZKEYHELP
value. This system variable must be redefined each time the keys help
panel is to change.
ZLANG
prof
non
8
Session language
ZLOGO
shr
non
3
Indicates whether the user has requested bypass of LOGO panel. NO
indicates that the user has specified the NOLOGO keyword at the time
ISPF was called, thus, requesting that the LOGO panel be bypassed.
Otherwise, the value of the variable will be YES.
ZLOGON
shr
non
8
Stepname of TSO logon procedure
ZOS390RL
shr
non
16
ZPANELID
shr
non
8
The name of the currently displayed panel.
ZPFKEY
shr
non
4
The name of the PF key (PFxx) in effect when the user exits the panel. If
ZPFKEY = PF00 then no PF key is in effect.
ZPLACE
prof
i/o
7
Command line placement (ASIS or BOTTOM)
ZPREFIX
shr
non
8
TSO user prefix
ZPROFAPP
prof
in
8
Name of application profile pool extension table
ZSCRCUR
shr
non
4
Displays the number of logical screens currently in use.
ZSCREENC
shr
non
5
Cursor position within the logical screen data.
ZSCREENI
shr
non
?
Logical screen data. Size depends upon your screen size.
ZSCRNAME
shr
in
8
Screen name set by dialog. The screen name is in effect only for the select
level in which it was defined. Option 7.3 can alter ZSCRNAME, but this
will have no impact.
ZSCRMAX
shr
non
4
Displays the number of logical screens allowed by the installation.
ZSCTPREF
shr
non
4
First site command table prefix
ZSCTPRE2
shr
non
4
Second site command table prefix
ZSCTPRE3
shr
non
4
Third site command table prefix
ZSCTSRCH
shr
non
1
Search order for site command tables relative to system command table.
Set to either B (Before ISP) or A (After ISP).
ZSM
shr
i/o
3
Indicates whether session manager panels will be used for ISPF options 4
and 6. This variable is initialized from the ISPF configuration table
keyword USE_SESSION_MANAGER at startup and stored in the shared
variable pool. Once initialized it can only be changed with Option 0 Settings or by use of the RESET_USE_SESSION_MANAGER
configuration option.
ZSYSICON
shr
non
8
The 8-character variable that contains the command to be executed when
the system icon is double-clicked or close is selected.
ZSYSID
shr
non
8
The 8-character SYSNAME obtained from the SYS1.PARMLIB member
IEASYSxx which is read at IPL time. NONAME is the default value of
SYSNAME. The operator can change this value at IPL time. See the z/OS
MVS Initialization and Tuning Reference for more information.
134
Len
z/OS V1R7.0 ISPF Reference Summary
Description
Indicates the z/OS release running on your system.
System Variables
Name
Pool
Type
Len
Description
ZSYSNODE
shr
non
12
The network node name of your installation’s JES. This name identifies
the local JES in a network of systems or system complexes being used for
network job entry (NJE) tasks. The node name returned in ZSYSNODE
derives from the NODE initialization statement of JES.
If the system finds that the subsystem is not active, the ZSYSNODE
variable contains the string —INACTIVE— (note the string delimiters).
If the system finds that the subsystem is neither JES2 4.3 or later, nor
JES3 5.1.1 or later, the ZSYSNODE variable contains the string ’
—DOWNLEVEL—’ (note the string delimiters).
The value in ZSYSNODE remains the same throughout the ISPF session.
Note: If, for instance, the JES subsystem is taken down during an ISPF
session and the node name is changed, the value in ZSYSNODE will still
contain the value as determined at ISPF initialization.
ZSYSPLEX
shr
non
8
The MVS sysplex name as found in the COUPLExx or LOADxx member
of SYS1.PARMLIB. If no sysplex name is specified in SYS1.PARMLIB,
ZSYSPLEX contains blanks.
ZSYSPROC
shr
non
8
TSO Logon Procedure name. In foreground, will have the name of the
current logon procedure; in batch, will have the value ’INIT’; a Started
Task will have the Started Task procedure name.
ZTEMPF
shr
non
44
ZTEMPN
shr
non
8
DDNAME of temporary data set for file tailoring output
ZTERMCID
shr
non
5
CCSID coded character set identifier of the terminal. Set by ISPF based
on the code page and character set of the terminal. If the terminal code
page and character set cannot be queried or if they are not supported by
ISPF, this variable will be blank.
ZTERMCP
shr
non
4
CECP support 4-digit code page.
Note: ZTERMCS is defined as character length 4. It cannot handle
5–character Character Sets. For example, the Character Set 65535 is
displayed in ZTERMCS as ″5535″. This does not mean that ISPF has
defined Character Set 5535 (X’159F’). Two other Z variables, ZTERMCS5
and ZTERMCP5, for Character Set and Code Page respectively, were
created to handle 5–character Character Sets and Code Pages. For
example, the Character Set 65535 is displayed in ZTERMCP5 as 65535.
ZTERMCP5
shr
non
5
CECP support 5-digit code page
ZTERMCS5
shr
non
5
CECP support 5-character set
ZTERMCS
shr
non
4
CECP support 4-digit character set
ZTHS
shr
non
1
NLS thousands separator character
ZTS
shr
non
1
NLS time separator character
ZTSICMD
shr
non
32767
The entire initial invocation command string which invoked the ISPF
environment. If storage cannot be obtained at startup, only the first 50
characters will be saved. The maximum length is 32767.
ZTSSCMD
shr
non
32767
SELECT portion of the initial invocation command. The maximum length
is 32767.
ZUCTPREF
shr
non
4
First user command table name
ZUCTPRE2
shr
non
4
Second user command table name
ZUCTPRE3
shr
non
4
Third user command table name
ZUSER
shr
non
8
User ID
ZVERB
shr
out
8
Command verb after a SETVERB command table action
Name of temporary data set for file tailoring output
Chapter 5. System Variables
135
System Variables
Name
Pool
Type
Len
Description
ZWINTTL
any
in
N/A
Title to be displayed in pop-up window frame
ZWSCDPG
shr
non
4
ZWSCON
shr
non
68
TCP/IP or APPC address when ISPF session is connected to a
workstation.
ZWSOPSYS
shr
non
16
Operating system of workstation to which the session is connected. The
first 10 characters are the operating system name, followed by a blank,
followed by two 2-digit numbers separated by a blank. These numbers
are returned to ISPF from the operating system and change by version
and release.
When running in GUI mode, the code page of the workstation. When not
running in GUI mode, value will be blank.
Terminal and Function Keys
Name
Pool
Type
Len
Description
ZCOLORS
shr
non
4
Number of colors supported by the terminal type (either 1 or 7)
ZDBCS
shr
non
3
DBCS terminal capability (YES or NO)
ZFKA
prof
non
8
Current state of the function key area form (LONG, SHORT, OFF (no
display))
ZGE
shr
non
3
Terminal support for graphic escape order:
v YES — graphic escape is supported
v NO — graphic escape is not supported.
Note: If you are running in GUI mode, ZGE will be set to Off.
ZHILITE
shr
non
3
Extended highlighting availability (YES or NO)
ZKEYS
prof
out
4
Number of Function keys
ZKLAPPL
shr
non
4
If KEYLIST is ON and it is a panel with the )PANEL statement, this
contains the application id where the current keylist came from.
ZKLNAME
shr
non
8
If KEYLIST is ON and it is a panel with the )PANEL statement, this
contains the name of the current keylist.
ZKLTYPE
shr
non
1
If KEYLIST is ON and it is a panel with the )PANEL statement, this
contains either P (for Private) or S (for Shared) for the current keylist.
ZKLUSE
prof
i/o
1
If KEYLIST is ON this contains Y, if it is OFF, it contains an N.
ZPFCTL
prof
i/o
5
User authorization to use PFSHOW command
v USER—User controls function key display with PFSHOW command
v ON—Display function key definitions on all panels
v OFF—Do not display function key definitions
ZPFFMT
prof
i/o
4
Number of Function key definitions displayed per line
v SIX—Always display six keys per line
v MAX—Display as many keys as will fit on each line
ZPFSET
prof
i/o
4
Function key definition set displayed
v PRI—Primary set (1–12)
v ALT—Alternate set (13–24)
v ALL—All keys (1–24)
ZPFSHOW
prof
out
4
PFSHOW command status
136
z/OS V1R7.0 ISPF Reference Summary
System Variables
Name
Pool
Type
Len
Description
ZPFxx
prof
i/o
255
Setting for Function keys:
ZPF13-ZPF24 contain settings for the primary keys (for 12-key terminals:
physical keys 1-12; for 24-key terminals: physical keys 13-24)
ZPF01-ZPF12 contain settings for the alternate keys (for 24-key terminals
only: physical keys 1-12)
The maximum length is 255.
ZPFLxx
prof
i/o
8
Setting for Function key labels:
ZPFL13-ZPFL24 contain labels for the primary keys
ZPFL01-ZPFL12 contain labels for the alternate keys
ZPRIKEYS
prof
i/o
4
Indicates the set of Function keys that will be the primary keys
v LOW—1 to 12 are primary keys
v UPP—13 to 24 are primary keys
ZSCREEN
shr
non
1
Logical screen number up to 32 screens (1–9, A–W)
ZSCREEND
shr
non
4
Screen depth available for dialog use. In batch mode, this variable is set
by the value specified for BATSCRD on the ISPSTART call.
ZSCREENW
shr
non
4
Screen width available for dialog use. In batch mode this variable is set
by the value specified for BATSCRW on the ISPSTART call.
ZSCREEND and ZSCREENW are generally the dimensions of the
physical display screen. There are two exceptions:
1. On a 3290, if a dialog is executing on a display with a width of 160
characters and the user does a vertical split, then ZSCREENW is 80.
2. On a 3278 model 5, if a user has specified SCREEN FORMAT IS STD,
then ZSCREENW is 80 and ZSCREEND is 24, rather than the
maximum physical size of 132 by 27.
ZSCRMAXD
shr
non
4
Maximum screen depth available for dialog use. In batch mode, this
variable is set by the value specified for BATSCRD on the ISPSTART call.
ZSCRMAXW
shr
non
4
Maximum screen width available for dialog use. In batch mode, this
variable is set by the value specified for BATSCRW on the ISPSTART call.
ZSCRMAXD and ZSCRMAXW are identical to ZSCREEND and
ZSCREENW, except for terminals on which an alternate size is available.
In that case, ZSCRMAXD and ZSCRMAXW contain the screen
configuration size that produces the largest screen.
For the 3290, these variables contain sizes of the hardware partition on
which ISPF is operating.
ZSPLIT
shr
non
3
Split-screen mode in effect (YES or NO)
ZTERM
prof
out
8
Terminal type as defined by option 0
Name
Pool
Type
ZAMT
prof
i/o
4
Scroll amount for functions such as Dialog Test, the Keylist Utility, the
Command Table Utility, and the LIBDEF Utility
ZSCBR
prof
i/o
4
Scroll amount for the BROWSE service
ZSCED
prof
i/o
4
Scroll amount for the EDIT service
Scrolling
Len
Description
Chapter 5. System Variables
137
System Variables
Name
Pool
Type
Len
Description
ZSCML
prof
i/o
4
Scroll amount for member lists
ZSCRML
shr
non
1
Specifies if ISPF should scroll to the first member selected in the member
list after processing or disable the member list from automatic scrolling
and instead place the cursor in front of the last member selected.
ZSCROLLA
shr
out
4
Value from scroll amount field (PAGE, MAX, number)
ZSCROLLD
any
in
4
Value to be used as default scroll value for scrollable dynamic areas and
table display
ZSCROLLN
shr
out
4
Scroll number as computed from the value in the scroll amount field
ZXSMAX
shr
non
4
Maximum scroll amount allowed to be used in any scroll operation.
ZXSMIN
shr
non
4
Minimum scroll amount allowed to be used in any scroll operation.
ZUSC
prof
i/o
4
Scroll amount for the Data Set List Utility
PRINTG Command
Name
Pool
Type
Len
Description
ZASPECT
func
in
4
Aspect ratio of printed output from PRINTG
ZDEVNAM
func
in
8
Device name for PRINTG
ZFAMPRT
func
non
4
Family printer type for PRINTG
Table Display Service
Name
Pool
Type
Len
Description
ZTDADD
func
out
3
More rows needed to satisfy scroll request (YES|NO)
ZTDAMT
func
out
4
Number of rows that the dialog should add to satisfy scroll
ZTDLROWS
func
in
6
Number of rows in the logical table (dynamic table expansion)
ZTDLTOP
func
in
6
Maps current top row in physical table to its position in logical table.
ZTDMARK
any
in
See
note
User-defined text for table display Bottom-of-Data marker
Note: Value can be any length that is not more than the screen width.
ZTDMSG
any
in
8
User-defined message ID for table display top-row-displayed indicator
ZTDRET
func
in
8
Defines whether dialog wants to use scroll return feature.
ZTDROWS
func
out
6
Number of table rows upon return from table display
ZTDSCRP
func
in/out
6
CRP of top row to be displayed after the scroll
ZTDSELS
func
out
4
Number of selected table rows upon return from each table display
ZTDSIZE
func
out
4
Size (number of model sets) of the table display scrollable section
ZTDSRID
func
out
6
Rowid of the row pointed to by ZTDSCRP
ZTDTOP
func
out
6
Row number (CRP) of top row displayed during most recent table
display
LIST Service
Name
Pool
Type
Len
ZLSTLPP
shr
non
4
138
z/OS V1R7.0 ISPF Reference Summary
Description
Number of lines per page in list data set
System Variables
Name
Pool
Type
Len
Description
ZLSTNUML
shr
non
4
Number of lines written to current list data set page
ZLSTTRUN
shr
non
4
List data set record length truncation value
LOG and LIST Data Sets
Name
Pool
Type
Len
Description
ZLOGNAME
shr
non
44
Contains the fully qualified data set name of the log data set.
ZLSTNAME
shr
non
44
Contains the fully qualified data set name of the list data set.
Len
Dialog Error
Name
Pool
Type
Description
ZERRALRM
func
out
3
Message alarm indicator (YES or NO)
ZERRHM
func
out
8
Name of help panel associated with error message
ZERRLM
func
out
512
ZERRMSG
func
out
8
ZERRSM
func
out
24
ZERRTYPE
func
out
8
Error message type
ZERRWIND
func
out
6
Error message window type
Long error message text
Error message-id
Short error message text
Tutorial Panels
Name
Description
ZCONT
Name of next continuation panel
ZHINDEX
Name of first index panel
ZHTOP
Name of top panel
ZIND
YES specifies an index page
ZUP
Name of parent panel
Selection Panels
Name
Description
ZCMD
Command input field
ZPARENT
Parent menu name (when in explicit chain mode)
ZPRIM
YES specifies panel is a primary option menu
ZSEL
Command input field truncated at first period
Chapter 5. System Variables
139
System Variables
DTL Panels or Panels Containing a )PANEL Section
Name
Pool
Type
Len
Description
ZCURFLD
func
out
8
Name of field (or list column) containing the cursor when the user exits
the panel.
ZCURINX
func
out
8
For table display panels, the current row number of the table row
containing the cursor. The value ZCURINX is in character format. If the
cursor is not within a table row, this value will be 0.
ZCURPOS
func
out
4
Position of the cursor within the field specified by ZCURFLD when the
user exits the panel. The value in ZCURPOS is in character format. If the
cursor is not within a field, ZCURPOS will contain a 1.
Note: These variables will contain the values that would result if they were set to
.CURSOR, .CSRPOS, and .CSRROW, as the first statements in the panel’s
)PROC section.
140
z/OS V1R7.0 ISPF Reference Summary
Chapter 6. Dialog Variables
This appendix describes the ISPF dialog variables.
The following table lists the dialog function pool variables that are both read from
and written to by several of the PDF library access services. For details of function
pool variables written by other services, refer to the z/OS ISPF Services Guide.
The variables are listed in alphabetical order. The first column lists the variable
name. The second column indicates the variable’s type, which corresponds to the
format parameter of the ISPF VDEFINE service. The third column specifies the
variable’s length, which corresponds to the length parameter of the VDEFINE
service.
The fourth column lists the PDF services that either read from or write to the
variable. An R in parentheses (R) after a service name indicates that the service,
when called, reads from the given variable. A W in parentheses (W) after a service
name indicates that the service, when called, writes to the given variable. All
variables are available to a dialog unless otherwise indicated.
The last column contains a brief description of the contents of the variable and any
restrictions on the value of the variable.
© Copyright IBM Corp. 1989, 2005
141
Dialog Variables
Variable Name Format
|
|
Length
Service (Access)
Description
ZCMD
Char
256
LMMDISP(W)
Primary Command field from member list panel if the
command is not a valid ISPF or PDF primary
command.
ZDLBLKSZ
Char
5
LMDLIST(W)
Block size.
ZDLCATNM
Char
44
LMDDISP(R),
LMDLIST(W)
Name of the catalog in which the data set was
located.
ZDLCDATE
Char
10
LMDLIST(W)
Creation date.
ZDLDEV
Char
8
LMDLIST(W)
Device type.
ZDLDSNTP
Char
8
LMDLIST(W)
DS name type (‘PDS’, ‘LIBRARY’, or ‘ ’).
ZDLDSORG
Char
4
LMDLIST(W)
Data set organization.
ZDLEDATE
Char
10
LMDLIST(W)
Expiration date.
ZDLEXT
Char
3
LMDLIST(W)
Number of extents used.
ZDLEXTX
Char
5
LMDLIST(W)
Number of extents used (long format).
ZDLLRECL
Char
5
LMDLIST(W)
Logical record length.
ZDLMIGR
Char
3
LMDLIST(W)
Whether the data set is migrated (‘YES’ or ‘NO’).
ZDLRDATE
Char
10
LMDLIST(W)
Date last referenced.
ZDLRECFM
Char
5
LMDLIST(W)
Record format.
ZDLSIZE
Char
6
LMDLIST(W)
Data set size in tracks.
ZDLSIZEX
Char
12
LMDLIST(W)
Data set size in tracks (long format).
ZDLSPACU
Char
10
LMDLIST(W)
Space units, one of the following: CYLINDERS,
MEGABYTES, KILOBYTES, BYTES, BLOCKS or
TRACKS.
ZDLUSED
Char
3
LMDLIST(W)
Percentage of used tracks or pages (PDSE).
ZDLVOL
Char
6
LMDLIST(W)
Volume serial.
ZDSN
Char
44
LMMDISP(W)
Name of the first or only data set in the concatenation
of the member list being displayed. This variable is
only available for member list panels.
ZDST
Char
54
BRIF (W) EDIF (W) Title line data name for EDIF and BRIF.
ZEDBDSN
Char
44
EDIT (R)
EDREC(W)
Backup data set name for standard edit recovery.
ZEDITCMD
Char
8
Any EDIT macro
The last primary command entered in Edit.
ZEDROW
Fixed
4
EDIT (R)
EDREC(W)
Row number of entry in standard edit recovery table.
ZEDSAVE
Char
8
Data_changed EDIT END command will save data (SAVE or NOSAVE).
macro command
ZEDTDSN
Char
44
EDIT (R)
EDREC(W)
Target data set name for standard edit recovery.
ZEDTMCMD
Char
8
Any Edit macro
The edit command entered that caused an edit macro
to run. Can be the macro name or other name is the
edit DEFINE command was used to define an alias.
ZEDTMEM
Char
8
EDIT (R)
EDREC(W)
Target member name (if applicable) for standard edit
recovery.
ZEDTRD
Char
6
EDIT (R)
EDREC(W)
Volume serial of target data set for standard edit
recovery.
ZEDUSER
Char
1
EDIT (R)
EDREC(W)
User data table extension for standard edit recovery.
142
z/OS V1R7.0 ISPF Reference Summary
Dialog Variables
Variable Name Format
Length
Service (Access)
Description
ZEIBSDN
Char
54
EDIF (R)
EDIREC(W)
Backup data name for EDIF edit recovery.
ZEIROW
Fixed
4
EDIF (R)
EDIREC(W)
Row number of entry in EDIF edit recovery table.
ZEITDSN
Char
54
EDIF (R)
EDIREC(W)
Target data name for EDIF edit recovery.
ZEIUSER
Char
1
EDIF (R)
EDIREC(W)
User data table extension variable for EDIF edit
recovery.
ZERRALRM
Char
3
ALL(W)
The value YES if an alarm was specified in the
message definition; otherwise, the value NO. Set when
ISPF services issue a return code of 8 or greater.
ZERRHM
Char
8
ALL(W)
The name of a Help panel, if one was specified in the
message definition. Set when ISPF services issue a
return code of 8 or greater.
ZERRLM
Char
512
ALL(W)
Long-message text in which variables have been
resolved. Set when ISPF services issue a return code of
8 or greater.
ZERRMSG
Char
8
ALL(W)
Message ID. Set when ISPF services issue a return
code of 8 or greater.
ZERRSM
Char
24
ALL(W)
Short-message text in which variables have been
resolved. Set when ISPF services issue a return code of
8 or greater.
ZGRPLVL
Char
8
LMHIER (W)
ISPF table variable that contains the level of this ISPF
library in the controlled hierarchy.
ZGRPNME
Char
8
LMHIER (W)
ISPF table variable that contains the ISPF library
group name.
ZLAC
Char
2
LMMDISP(W)
LMMFIND(W)
LMMLIST(W)
Authorization code of the member.
ZLALIAS
Char
8
LMMDISP(W)
LMMFIND(W)
LMMLIST(W)
Name of the real member of which this member is an
alias.
ZLAMODE
Char
3
LMMDISP(W)
LMMFIND(W)
LMMLIST(W)
AMODE of the member.
ZLATTR
Char
20
LMMDISP(W)
LMMFIND(W)
LMMLIST(W)
Load module attributes. Refer to the ISPF Services
Guide.
ZLCDATE
Char
8
LMMADD(R)
LMMDISP(W)
LMMFIND(W)
LMMLIST(W)
LMMREP(R)
Date on which the specified member was created. A
character string in the national format. For example,
yy/mm/dd or mm/dd/yy. If no value exists for this
variable, the PDF component will set the value to
blanks.
ZLC4DATE
Char
10
LMMADD(R)
LMMDISP(W)
LMMFIND(W)
LMMLIST(W)
LMMREP(W)
Date on which the specified member was created, in
4-character year format. A character string in the
national format. For example, yyyy/mm/dd or
mm/dd/yyyy. If no value exists for this variable, the
PDF component will set the value to blanks.
Chapter 6. Dialog Variables
143
Dialog Variables
Variable Name Format
Length
Service (Access)
Description
ZLCNORC
Fixed
4
LMMADD(R)
LMMDISP(W)
LMMFIND(W)
LMMLIST(W)
LMMREP(R)
Current number of records in the specified member. A
number from 0 to 65 535. If no value exists for this
variable, the PDF component will set the value to
blanks.
ZLINORC
Fixed
4
LMMADD(R)
LMMDISP(W)
LMMFIND(W)
LMMLIST(W)
LMMREP(R)
Number of records in the specified member when it
was first created. A number from 0 to 65 535.
ZLLIB
Fixed
4
LMMDISP(W)
LMMFIND(W)
LMMLIST(W)
Position of the specified member in the concatenated
data sets. A number from 1 to 4.
ZLMDATE
Char
8
LMMADD(R)
LMMDISP(W)
LMMFIND(W)
LMMLIST(W)
LMMREP(R)
Date on which the specified member was last
modified. A character string in the national format.
(For example, yy/mm/dd or mm/dd/yy.) If no value
exists for this variable, the PDF component will set
the value to blanks.
ZLM4DATE
Char
10
LMMADD(R)
LMMDISP(W)
LMMFIND(W)
LMMLIST(W)
LMMREP(W)
Date on which the specified member was last
modified, in 4-character year format. A character
string in the national format. (For example,
yyyy/mm/dd or mm/dd/yyyy.) If no value exists for this
variable, the PDF component will set the value to
blanks.
ZLMEMBER
Char
8
LMMDISP(W)
Name of the current selected member.
ZLMNORC
Fixed
4
LMMADD(R)
LMMDISP(W)
LMMFIND(W)
LMMLIST(W)
LMMREP(R)
The number of records that have been modified in the
specified member. A number from 0 to 65 535.
ZLMOD
Fixed
4
LMMADD(R)
LMMDISP(W)
LMMFIND(W)
LMMLIST(W)
LMMREP(R)
Modification level of the specified member. A number
from 0 to 99.
ZLMTIME
Char
5
LMMADD(R)
LMMDISP(W)
LMMFIND(W)
LMMLIST(W)
LMMREP(R)
Time when the specified member was last modified. A
character string in the form hh:mm.
ZLMSEC
Char
2
LMMADD(R)
LMMDISP(W)
LMMFIND(W)
LMMLIST(W)
LMMREP(R)
Seconds value of last modified time.
ZLSSI
Char
8
LMMDISP(W)
LMMFIND(W)
LMMLIST(W)
SSI (System Status Index) of the load module.
ZLPDSUDA
Char
62
LMMDISP(W)
A character string containing the contents of the user
data area in the PDS directory entry of the specified
member if the member’s statistics are not in PDF
format.
144
z/OS V1R7.0 ISPF Reference Summary
Dialog Variables
Variable Name Format
Length
Service (Access)
Description
ZLRMODE
Char
3
LMMDISP(W)
LMMFIND(W)
LMMLIST(W)
RMODE of the member.
ZLSIZE
Char
8
LMMDISP(W)
LMMFIND(W)
LMMLIST(W)
Load module size (in Hex).
ZLTTR
Char
6
LMMDISP(W)
LMMFIND(W)
LMMLIST(W)
TTR of the member.
ZLUSER
Char
7
LMMADD(R)
LMMDISP(W)
LMMFIND(W)
LMMLIST(W)
LMMREP(R)
User ID of user who last modified the specified
member.
ZLVERS
Fixed
4
LMMADD(R)
LMMDISP(W)
LMMFIND(W)
LMMLIST(W)
LMMREP(R)
Version number of the specified member. A number
from 1 to 99. If no value exists for this variable, the
PDF component will set the value to blanks.
ZMEMCNT
Char
8
LMMLIST(W)
Number of members in the member list.
ZMLCOLS
Char
80
LMMDISP(W)
A character string that contains the member statistics
column headings that appear on the member list
panel display. This variable is only available for
member list panels.
ZMLCR
Fixed
4
LMMDISP(W)
The relative number in the member list of the member
that appears at the top of the member list display. Its
range is from 1–99 999. This variable is only available
for member list panels.
ZMLTR
Fixed
4
LMMDISP(W)
Number of members in the member list. Its range is
from 1–99 999. This variable is only available for
member list panels.
ZMSRTFLD
Char
8
ALL(W)
Contains the field name used to sort a member list.
Field name corresponds to the title line used in
member list panels, with the exceptions of the ’VV
MM’ field which is returned as VVMM, and the
attributes field which is returned as ATTRIBUT.
ZSCALIAS
Char
1
LMINIT(W)
Data set name is an alias (’Y’ or ’N’).
ZSCLM
Char
1
LMMDISP(W)
LMMFIND(W)
LMMLIST(W)
Last updater of member. ’Y’ indicates SCLM was last
updater. ’N’ indicates PDF.
ZSCMVOL
Char
1
LMINIT(W)
Data set name is multivolume (’Y’ or ’N’).
ZUSERMAC
Char
9
EDIT(R) EDIF(R)
VIEW(R) VIIF(R)
Application-wide edit macro.
1. Length limited only by ISPF restrictions on the length of table extension variables.
Chapter 6. Dialog Variables
145
Dialog Variables
PDF Non-Modifiable Variables
The following read-only variables are available to PDF component dialogs:
Variable Name Format
Length
Service (Access)
Description
ZCUNIT
Char
8
none
Unit name to be used for temporary allocations. This
variable comes from ISPF configuration table keyword
PDF_DEFAULT_UNIT.
ZCUSIZE
Fixed
4
none
Number of kilobytes available for use by the edit
UNDO command when running in SETUNDO
STORAGE mode. This variable comes from ISPF
configuration table Keyword UNDO_STORAGE_SIZE.
See z/OS ISPF Edit and Edit Macros for further
information.
ZICFPRT
Char
3
none
ICF indicator. ’YES’ - All foreground print requests
will be processed using ICF. ’NO’ - ICF will not be
used. This variable comes from ISPF configuration
table keyword PRINT_USING_ICF.
ZPDFREL
Char
8
none
PDF version number in the form ″PDF x.y ″. The x.y
is a sequence number. If x.y:
v <= 4.2 means the x.y version.release of PDF
v = 4.3 means ISPF for OS/390 Release 2
v = 4.4 means PDF 4.2.1 and ISPF OS/390 Release 3
ZSESS
Char
8
none
This variable contains either ’Y’ or ’N’ and comes
from the ISPF configuration table keyword
USE_SESSION_MANAGER. See the description of the
general system variable ZSM for additional
information.
ZSWIND
Char
4
none
Sliding window value used by PDF for determining
the century of 2–character years. This variable comes
from ISPF configuration table keyword
YEAR_2000_SLIDING_RULE. Dates less than or equal
to this value are 20xx. Dates greater than this value
are 19xx.
146
z/OS V1R7.0 ISPF Reference Summary
Chapter 7. Dialog Tag Language (DTL) Tags
Tag Summary
The following table is an alphabetic summary of the supported Dialog Tag
Language (DTL) tags for z/OS V1R7.0 ISPF. The table shows the tag, tells whether
an end tag is required (Yes) or optional (No), and lists the tag’s attributes (if any)
and the tag content (if any) in italics. The table also lists which tags you can nest
within the tag, as well as which tags you can code the tag within.
Table 1. Tag summary
Tag
End tag Attributes
Nested tags
Used within
AB
Yes
MNEMGEN=YES | NO
ABSEPSTR=ab-separator-string
ABSEPCHAR=ab-separator-character
ABC
PANEL
ABC
No
HELP=NO | YES | help-panel-name |
*help-message-id | %varname | *%varname
PDCVAR=pdc-variable-name
choice-description-text
COMMENT
M
PDC
PDSEP
SOURCE
AB
ACTION
No
RUN=internal-command-name | %varname
PARM=parameters | %varname
APPLCMD=NO | YES
TYPE=CMD | PGM | PANEL | WSCMD
| WSCMDV | EXIT
NEWAPPL | NEWAPPL=application-id
NEWWINDOW
PASSLIB
NEWPOOL
SUSPEND
SCRNAME=screen-name
NOCHECK
ADDPOP
OPT=option | %varname
MODE=LINE | FSCR
LANG=APL | CREX
BARRIER
NEST
WSDIR=ws-directory
WSINVOKE=MODELESS | MODAL
WSSIZE=MAX | MIN
WSVIEW=VIS | INVIS
SETVAR=variable-name
VALUE=1 | string | %varname
TOGVAR=variable-name
VALUE1=0 | string | %varname
VALUE2=1 | string | %varname
© Copyright IBM Corp. 1989, 2005
CHOICE
PDC
147
Summary of DTL Tags
Table 1. Tag summary (continued)
Tag
End tag Attributes
AREA
Yes
MARGINW=1 | n
MARGIND=0
INDENT=n
DEPTH=n | *
EXTEND=OFF | ON | FORCE
DIV=NONE | BLANK | SOLID | DASH | TEXT
DIVWIDTH=MAX | MIN
FORMAT=START | CENTER | END
TEXT=divider-text
WIDTH=n
DIR=VERT | HORIZ
Nested tags
Used within
COMMENT
DA
DIVIDER
DTACOL
DTAFLD
GA
GENERATE
GRPHDR
INFO
LSTFLD
PNLINST
REGION
SELFLD
SOURCE
HELP
PANEL
ASSIGNI
No
VALUE=test-value
RESULT=assigned-value
ASSIGNL
Yes
DESTVAR=destination-variable-name
ASSIGNI
DTAFLD
ATTENTION
Yes
text
DL
FIG
HP
LINES
NOTE
NOTEL
NT
OL
P
PARML
PS
RP
SL
UL
XMP
LI
LP
P
ATTR
No
ATTRCHAR=code
TYPE=DATAIN | DATAOUT | CHAR
INTENS=HIGH | LOW | NON | %varname
CAPS=OFF | ON | IN | OUT | %varname
JUST=ASIS | LEFT | RIGHT | %varname
PAD=NULLS | USER | char | %varname
PADC=NULLS | USER | char | %varname
SKIP=OFF | ON | %varname
GE=OFF | ON | %varname
COLOR=WHITE | RED | BLUE | GREEN |
PINK | YELLOW | TURQ | %varname
HILITE=USCORE | BLINK | REVERSE | %varname
NUMERIC=OFF | ON | %varname
FORMAT=EBCDIC | DBCS | MIX | %varname
OUTLINE=NONE | L | R | O | U | BOX |
%varname
PAS=OFF | ON | %varname
CKBOX=OFF | ON | %varname
CUADYN=CEF | EE | LEF | NEF | VOI | LID
| LI | CH | CT | DT | ET | FP | NT | PIN
| PT | SAC | SI | SUC | WASL | WT
| %varname
CSRGRP=NO | YES | n
ATTN=OFF | ON | %varname
148
z/OS V1R7.0 ISPF Reference Summary
ASSIGNL
DA
Summary of DTL Tags
Table 1. Tag summary (continued)
Tag
End tag Attributes
Nested tags
Used within
BOTINST
No
COMPACT
instruction-text
HP
PS
RP
PANEL
CAUTION
Yes
text
DL
FIG
HP
LINES
NOTE
NOTEL
NT
OL
P
PARML
PS
RP
SL
UL
XMP
LI
LP
P
CHDIV
No
TYPE=NONE | SOLID | DASH | TEXT
GUTTER=1 | n
FORMAT=START | CENTER | END
divider-text
HP
SELFLD
CHOICE
Chapter 7. Dialog Tag Language (DTL) Tags
149
Summary of DTL Tags
Table 1. Tag summary (continued)
Tag
End tag Attributes
CHECKI
150
No
TYPE=
RANGE
PARM1=low-bound | %varname
PARM2=high-bound | %varname
ALPHA
CHARS
PARM1=EQ
PARM2=character-set
VALUES
PARM1=EQ
PARM2=value-list
VALUESX
PARM1=NE
PARM2=value-list
BIT
NAME
NAMEF
PICT
PARM1=EQ
PARM2=pictstring
PICTCN
PARM1=mask-character
PARM2=field-mask
PARM3=string
NUM
DBCS
LISTV
PARM1=EQ
PARM2=%varlist
LISTVX
PARM1=NE
PARM2=%varlist
ALPHAB
LEN
PARM1=operator | %varname
PARM2=length | %varname
EBCDIC
ENUM
DSNAME
DSNAMEF
DSNAMEFM
DSNAMEPQ
DSNAMEQ
MIX
HEX
FILEID
INCLUDE
PARM1=IMBLK
PARM2=ALPHA | ALPHAB | NUM
PARM3=ALPHA | ALPHAB | NUM
IDATE
STDDATE
JDATE
JSTD
ITIME
STDTIME
IPADDR4
z/OS V1R7.0 ISPF Reference Summary
Nested tags
Used within
CHECKL
Summary of DTL Tags
Table 1. Tag summary (continued)
Tag
End tag Attributes
Nested tags
Used within
CHECKL
Yes
MSG=message-identifier
CHECKI
VARCLASS
CHOFLD
No
DATAVAR=field-data
VARCLASS=variable-class-name
HELP=NO | YES | help-panel-name |
*help-message-id | %varname | *%varname
USAGE=BOTH | IN | OUT
REQUIRED=NO | YES
MSG=message-identifier
AUTOTAB=NO | YES
ENTWIDTH=n
FLDSPACE=n
ALIGN=START | CENTER | END
DISPLAY=YES | NO
NOENDATTR
PAD=NULLS | USER | char | %varname
PADC=NULLS | USER | char | %varname
OUTLINE=NONE | L | R | O | U | BOX |
%varname
PSVAR=point-and-shoot-variable | %varname
PSVAL=point-and-shoot-value | %varname
PAS=%varname
EXPAND
ATTRCHANGE=NO | YES | NEW
INIT=initial-value
IMAPNAME=image-name | %varname
IMAPNAMEP=image-namep | %varname
PLACE=ABOVE | BELOW | LEFT | RIGHT
| %varname
ATTRCHAR=code
CAPS=OFF | ON
choice-description-text
ACTION
COMMENT
HP
PS
RP
SOURCE
CHOICE
CHOICE
No
NAME=choice-name
HELP=NO | YES | help-panel-name |
*help-message-id | %varname | *%varname
CHECKVAR=variable-name
MATCH=1 | string
NOMATCH=0 | string
AUTOTAB=YES | NO
SELCHAR=’char(s),n’
PAD=NULLS | USER | char | %varname
PADC=NULLS | USER | char | %varname
OUTLINE=NONE | L | R | O | U | BOX |
%varname
HIDE
HIDEX
UNAVAIL=variable-name
UNAVAILMAT=1 | string
TRUNC=n
AUTOSEL=YES | NO
choice-description-text
ACTION
CHOFLD
COMMENT
HP
PS
RP
SOURCE
SELFLD
CMD
No
NAME=internal-command-name
ALTDESCR=command-description
external-command-name
CMDACT
T
CMDTBL
Chapter 7. Dialog Tag Language (DTL) Tags
151
Summary of DTL Tags
Table 1. Tag summary (continued)
Tag
End tag Attributes
Nested tags
CMDACT
No
ACTION=
’SELECT=select-parameters’
’ALIAS=internal-command-name parameters’
PASSTHRU
SETVERB
BACKWARD
CANCEL
EXIT
EXHELP
FKA
FORWARD
HELP
PANELID
RETRIEVE
%varname
application-command
ASIS
CMDAREA
No
HELP=NO | YES | help-panel-name |
*help-message-id | %varname | *%varname
PMTLOC=BEFORE
NOINIT
PAD=NULLS | USER | char | %varname
PADC=NULLS | USER | char | %varname
OUTLINE=NONE | L | R | O | U | BOX |
%varname
NAME=cmdarea-variable-name
ENTWIDTH=n
PMTTEXT=YES | NO
CMDLOC=DEFAULT | ASIS
CMDLEN=DEFAULT | MAX
AUTOTAB=NO | YES
SCROLLVAR=scroll-variable
SCRVHELP=NO | YES | scroll-help-panel-name
|*scroll-help-message-id | %varname
| *%varname
SCROLLTAB=NO | YES
SCRCAPS=OFF | ON
PSBUTTON=cmd-pb-text
PSVAR=point-and-shoot-variable | %varname
PSVAL=point-and-shoot-value | %varname
IMAPNAME=image-name | %varname
IMAPNAMEP=image-namep | %varname
PLACE=ABOVE | BELOW | LEFT
| RIGHT | %varname
CAPS=OFF | ON
NOJUMP=OFF | ON
VARDCL=YES | NO
command-prompt-text
HP
CMDTBL
Yes
APPLID=application-identifier
SORT=NO | YES
CMD
152
z/OS V1R7.0 ISPF Reference Summary
Used within
CMD
PANEL
Summary of DTL Tags
Table 1. Tag summary (continued)
Tag
End tag Attributes
Nested tags
COMMENT
No
TYPE=END | CCSID | PANEL | ATTR | ABCINIT |
ABCPROC | INIT | REINIT | PROC | HELP |
PNTS | LIST
comment-text
COMPOPT
No
REPLACE | NOREPLACE
SCREEN | DISK
NODBCS | DBCS
NOKANA | KANA
KEYLAPPL=xxxx
NOPANEL | PANEL
NOMSGSUPP | MSGSUPP
NOCUASUPP | CUASUPP
PREP | NOPREP
CUAATTR | NOCUAATTR
NOLSTVIEW | LSTVIEW
STATS | NOSTATS
NOSCRIPT | SCRIPT
NOLISTING | LISTING
NOFORMAT | FORMAT
NOMSGEXPAND | MSGEXPAND
LOGREPL | NOLOGREPL
LISTREPL | NOLISTREPL
ACTBAR | NOACTBAR
GUI | NOGUI
VERSION | NOVERSION
NOMERGESAREA | MERGESAREA
NODISPLAY | DISPLAY
NODISPLAYW | DISPLAYW
DSNCHK | NODSNCHK
GRAPHIC | NOGRAPHIC
ZVARS | NOZVARS
NODBALIGN | DBALIGN
NOMCOMMENT | MCOMMENT
NOVPADC | PADC
ADD
RESET
national-language
COPYR
No
copyright-text
Used within
ABC
AREA
CHOICE
DA
DTACOL
DTAFLD
HELP
LSTCOL
LSTFLD
LSTGRP
MSGMBR
PANEL
PDC
REGION
SELFLD
None
Chapter 7. Dialog Tag Language (DTL) Tags
153
Summary of DTL Tags
Table 1. Tag summary (continued)
Tag
End tag Attributes
Nested tags
Used within
DA
Yes
NAME=varname
EXTEND=OFF | ON | FORCE
LVLINE=variable-name
SCROLL=OFF | ON | CMDLINE
USERMOD=usermod-code | %varname
DATAMOD=datamod-code | %varname
DEPTH=n | *
WIDTH=n
SHADOW=shadow-name
DIV=NONE | BLANK | SOLID | DASH | TEXT
FORMAT=START | CENTER | END
TEXT=divider-text
SCROLLVAR=scroll-variable
SCRVHELP=NO | YES | scroll-help-panel-name
|*scroll-help-message-id | %varname | *%varname
SCROLLTAB=NO | YES
SCRCAPS=OFF | ON
INITATTR=NT | CT | ET | WT | WASL
HELP=NO | YES | help-panel-name |
*help-message-id | %varname | *%varname
ATTR
COMMENT
SOURCE
AREA
PANEL
REGION
DD
No
definition-description
DL
FIG
HP
LINES
NOTE
NOTEL
NT
OL
P
PARML
PS
RP
SL
UL
XMP
DL
DDHD
No
definition-description-header
HP
PS
RP
DL
DIVIDER
No
TYPE=NONE | SOLID | DASH | TEXT
GAP=YES | NO
GUTTER=1 | n
NOENDATTR
FORMAT=START | CENTER | END
divider-text
HP
AREA
DTACOL
PANEL
REGION
154
z/OS V1R7.0 ISPF Reference Summary
Summary of DTL Tags
Table 1. Tag summary (continued)
Tag
End tag Attributes
Nested tags
Used within
DL
Yes
TSIZE=10 | ’S1, S2,... Sn’
BREAK=NONE | FIT | ALL
COMPACT
NOSKIP
INDENT=n
FORMAT=START | CENTER | END
DIVEND=NO | YES
SPLIT=NO | YES
DD
DDHD
DLDIV
DT
DTHD
DTDIV
DTHDIV
ATTENTION
CAUTION
DD
FIG
INFO
LI
LINES
LP
NT
PD
WARNING
XMP
DLDIV
No
TYPE=NONE | SOLID | DASH | TEXT
GAP=YES | NO
GUTTER=1 | n
FORMAT=START | CENTER | END
divider-text
HP
DL
DT
No
FORMAT=START | CENTER | END
NOSKIP
SPLIT=NO | YES
definition-term
DTSEG
HP
PS
RP
DL
DTACOL
Yes
PMTWIDTH=n | * | **
ENTWIDTH=n
DESWIDTH=n | *
SELWIDTH=n | *
FLDSPACE=n
PAD=NULLS | USER | char | %varname
PADC=NULLS | USER | char | %varname
OUTLINE=NONE | L | R | O | U | BOX |
%varname
PMTFMT=CUA | ISPF | NONE | END
AUTOTAB=NO | YES
ATTRCHANGE=NO | YES | NEW
PMTLOC=BEFORE | ABOVE
DBALIGN=YES | NO | PROMPT | FIELD | FORCE
VARCLASS=variable-class-name
REQUIRED=NO | YES
CAPS=OFF | ON
VARDCL=YES | NO
COMMENT
DIVIDER
DTAFLD
GRPHDR
SELFLD
SOURCE
AREA
PANEL
REGION
Chapter 7. Dialog Tag Language (DTL) Tags
155
Summary of DTL Tags
Table 1. Tag summary (continued)
Tag
End tag Attributes
Nested tags
Used within
DTAFLD
No
NAME=field-name
DATAVAR=field-data
VARCLASS=variable-class-name
HELP=NO | YES | help-panel-name |
*help-message-id | %varname | *%varname
USAGE=BOTH | IN | OUT
REQUIRED=NO | YES
MSG=message-identifier
AUTOTAB=NO | YES
ENTWIDTH=n
PMTWIDTH=n | * | **
DESWIDTH=n | *
FLDSPACE=n
ALIGN=START | CENTER | END
PMTLOC=BEFORE | ABOVE
DISPLAY=YES | NO
NOENDATTR
PAD=NULLS | USER | char | %varname
PADC=NULLS | USER | char | %varname
OUTLINE=NONE | L | R | O | U | BOX |
%varname
PMTFMT=CUA | ISPF | NONE | END
PSVAR=point-and-shoot-variable | %varname
PSVAL=point-and-shoot-value | %varname
PAS=%varname
CSRGRP=NO | YES | n
EXPAND
FLDWIDTH=n
ATTRCHANGE=NO | YES | NEW
INIT=initial-value
DEPTH=n | %varname
IMAPNAME=image-name | %varname
IMAPNAMEP=image-namep | %varname
PLACE=ABOVE | BELOW | LEFT |
RIGHT | %varname
DBALIGN=YES | NO | PROMPT | FIELD | FORCE
PMTSKIP=NO | YES
DESSKIP=NO | YES
FLDTYPE=CUA | ISPF
COLOR=WHITE | RED | BLUE | GREEN |
PINK | YELLOW | TURQ | %varname
INTENS=HIGH | LOW | NON | %varname
HILITE=USCORE | BLINK | REVERSE | %varname
ATTRCHAR=code
CAPS=OFF | ON
NOJUMP=OFF | ON
AUTOTYPE=PROJECT | GROUP1 | GROUP2 |
GROUP3 | GROUP4 | TYPE |
MEMBER | DSN
AUTOVOL=volser-name
AUTODMEM=YES | NO
VARDCL=YES | NO
prompt-text
ASSIGNL
COMMENT
DTAFLDD
HP
PS
RP
SOURCE
SCRFLD
AREA
DTACOL
PANEL
REGION
DTAFLDD
No
description
HP
PS
RP
DTAFLD
DTDIV
No
156
z/OS V1R7.0 ISPF Reference Summary
DL
Summary of DTL Tags
Table 1. Tag summary (continued)
Tag
End tag Attributes
definition-term-header
Nested tags
Used within
HP
PS
RP
DL
DTHD
No
DTHDIV
No
DL
DTSEG
No
DT
FIG
Yes
FRAME=RULE | NONE
WIDTH=PAGE | COL
NOSKIP
figure-content
DL
FIGCAP
HP
NOTE
NOTEL
NT
OL
P
PARML
PS
RP
SL
UL
XMP
ATTENTION
CAUTION
DD
INFO
LI
LP
NT
PD
WARNING
FIGCAP
No
figure-caption-text
HP
PS
RP
FIG
GA
No
NAME=graphic-area-name
EXTEND=OFF | ON | FORCE
DEPTH=n | *
WIDTH=n
DIV=NONE | BLANK | SOLID | DASH | TEXT
FORMAT=START | CENTER | END
TEXT=divider-text
LVLINE=variable-name
GENERATE
Yes
SUBSTITUTE=NO | YES
ATTR
COMMENT
SOURCE
AREA
HELP
PANEL
REGION
GRPHDR
No
FORMAT=START | CENTER | END | NONE
WIDTH=n
FMTWIDTH=n
INDENT=n
HEADLINE=NO | YES
DIV=NONE | BLANK | SOLID | DASH
DIVLOC=AFTER | BEFORE | BOTH
COMPACT
STRIP
group-heading-text
HP
PS
RP
AREA
DTACOL
PANEL
REGION
AREA
PANEL
REGION
Chapter 7. Dialog Tag Language (DTL) Tags
157
Summary of DTL Tags
Table 1. Tag summary (continued)
Tag
End tag Attributes
HELP
Yes
NAME=help-panel-name
HELP=hhelp-panel-name | %varname
HELPDEF=helpdef-id
WIDTH=50 | n | FIT
DEPTH=10 | n | FIT
CCSID=n
TUTOR
KEYLIST=key-list-name
KEYLTYPE=PRIVATE | SHARED
APPLID=application-id
EXPAND=xy
WINTITLE=window-title
APPTITLE=application-title
MERGESAREA=NO | YES
MSGLINE=YES | NO
IMAPNAME=image-name | %varname
IMAPROW=n | %varname
IMAPCOL=n | %varname
ZUP=zup-id
ZCONT=zcont-id
help-panel-title
HELPDEF
No
ID=helpdef-id
HELP=hhelp-panel-name | %varname
WIDTH=n | FIT
DEPTH=n | FIT
CCSID=n
KEYLIST=key-list-name
KEYLTYPE=PRIVATE | SHARED
APPLID=application-id
EXPAND=xy
WINTITLE=window-title
APPTITLE=application-title
MERGESAREA=NO | YES
IMAPNAME=image-name | %varname
IMAPROW=n | %varname
IMAPCOL=n | %varname
H1
No
COMPACT
heading-text
H2/H3/H4
No
COMPACT
heading-text
158
z/OS V1R7.0 ISPF Reference Summary
Nested tags
Used within
AREA
COMMENT
DIVIDER
GENERATE
HP
INFO
REGION
SOURCE
TEXTLINE
INFO
HP
PS
RP
INFO
Summary of DTL Tags
Table 1. Tag summary (continued)
Tag
End tag Attributes
Nested tags
HP
Yes
TYPE=ET | CH | CT | FP | LEF | LI
| NT | PT | SAC | TEXT | WASL | WT
COLOR=WHITE | RED | BLUE | GREEN |
PINK | YELLOW | TURQ | %varname
INTENS=HIGH | LOW | NON | %varname
HILITE=USCORE | BLINK | REVERSE | %varname
INTENSE=varname
phrase-to-be-highlighted
INFO
Yes
WIDTH=format-width | *
INDENT=n
KEYI
No
KEY=virtual-key
CMD=internal-command-name
CASE=UPPER | MIXED
FKA=NO | YES | LONG | SHORT
PARM=parm-string
FKA-text
Used within
ATTENTION
BOTINST
CAUTION
CHDIV
CHOICE
CMDAREA
DD
DDHD
DIVIDER
DT
DTAFLD
DTAFLDD
DTHD
FIG
FIGCAP
GRPHDR
H2
H3
H4
HELP
LI
LINES
LP
LSTCOL
LSTGRP
NOTE
NT
P
PANEL
PD
PNLINST
PT
SELFLD
TOPINST
WARNING
XMP
DIVIDER
DL
FIG
Hn
LINES
NOTE
NOTEL
NT
OL
P
PARML
SL
SOURCE
UL
XMP
AREA
HELP
PANEL
REGION
KEYL
Chapter 7. Dialog Tag Language (DTL) Tags
159
Summary of DTL Tags
Table 1. Tag summary (continued)
Tag
End tag Attributes
Nested tags
Used within
KEYL
Yes
NAME=key-list-name
HELP=help-panel-name
ACTION=UPDATE | DELETE
APPLID=application-id
KEYI
LI
No
SPACE=NO | YES
NOSKIP
item-text
ATTENTION
CAUTION
DL
FIG
HP
LINES
NOTE
NOTEL
NT
OL
P
PARML
PS
RP
SL
UL
WARNING
XMP
NOTEL
OL
SL
UL
LINES
Yes
NOSKIP
text
DL
HP
NOTE
NOTEL
NT
OL
P
PARML
PS
RP
SL
UL
XMP
ATTENTION
CAUTION
DD
INFO
LI
LP
NT
PD
WARNING
LIT
Yes
literal-display-value
LP
No
NOSKIP
implied-paragraph
160
z/OS V1R7.0 ISPF Reference Summary
XLATI
ATTENTION
CAUTION
DL
FIG
HP
LINES
NOTE
NOTEL
NT
OL
P
PARML
PS
RP
SL
UL
WARNING
XMP
NOTEL
OL
SL
UL
Summary of DTL Tags
Table 1. Tag summary (continued)
Tag
End tag Attributes
Nested tags
Used within
LSTCOL
No
DATAVAR=column-data
VARCLASS=variable-class-name
HELP=NO | YES | help-panel-name |
* help-message-id | %varname | *%varname
USAGE=BOTH | IN | OUT
REQUIRED=NO | YES
MSG=message-id
COLWIDTH=data-width
ALIGN=START | CENTER | END
AUTOTAB=NO | YES
LINE=n
CLEAR
POSITION=n
FORMAT=START | CENTER | END
TEXT=descriptive-text
TEXTLOC=BEFORE | AFTER
TEXTFMT=START | CENTER | END
TEXTLEN=n
TEXTSKIP=NO | YES
NOENDATTR
PAD=NULLS | USER | char | %varname
PADC=NULLS | USER | char | %varname
OUTLINE=NONE | L | R | O | U | BOX |
%varname
PAS=OFF | ON | %varname
CSRGRP=NO | YES | n
ATTRCHANGE=NO | YES | NEW
COLSPACE=n
COLTYPE=CUA | ISPF | EE | VOI | LID
COLOR=WHITE | RED | BLUE | GREEN |
PINK | YELLOW | TURQ | %varname
INTENS=HIGH | LOW | NON | %varname
HILITE=USCORE | BLINK | REVERSE | %varname
CAPS=OFF | ON
DISPLAY=YES | NO
VARDCL=YES | NO
column-heading
COMMENT
HP
PS
RP
SOURCE
SCRFLD
LSTFLD
LSTGRP
LSTFLD
Yes
RULES=NONE | HORIZ | VERT | BOTH
ROWS=NOSCAN | SCAN | %varname
DIV=NONE | BLANK | SOLID | DASH | char
SCROLLVAR=scoll-variable
SCRVHELP=NO | YES | scroll-help-panel-name
|*scroll-help-message-id | %varname | *%varname
SCROLLTAB=NO | YES
SCRCAPS=OFF | ON
ATTRCHANGE=NO | YES | NEW
VARDCL=YES | NO
COMMENT
LSTCOL
LSTGRP
LSTVAR
SOURCE
AREA
PANEL
REGION
LSTGRP
Yes
HEADLINE=NO | YES | DASH
ALIGN=CENTER | START | END
column-group-heading
COMMENT
HP
LSTCOL
LSTGRP
LSTVAR
PS
RP
SOURCE
LSTFLD
LSTGRP
Chapter 7. Dialog Tag Language (DTL) Tags
161
Summary of DTL Tags
Table 1. Tag summary (continued)
Tag
End tag Attributes
Nested tags
Used within
COMMENT
HP
PS
RP
SOURCE
LSTFLD
LSTGRP
LSTVAR
No
DATAVAR=variable-model-name
LINE=n
column-heading
M
No
mnemonic-character
MSG
No
SUFFIX=message-suffix-number
HELP=help-panel-name | %varname | *
MSGTYPE=INFO | WARNING | ACTION
| CRITICAL | %varname
LOCATION=AREA | MODAL | MODAL(L) |
MODELESS | MODELESS (L) | %varname
DISP=KANA | NOKANA
ALARM=NO | YES | %varname
ABBREV=NONE | KEYWORD | VALUE | BOTH
FORMAT=FLOW | ASIS
SMSG=short-message-text
message-text
VARSUB
MSGMBR
Yes
NAME=message-member-name
CCSID=n
WIDTH=76 | 68
COMMENT
MSG
NOTE
No
NOSKIP
INDENT=n
TYPE=ET | CH | CT | FP | LEF | LI
| NT | PT | SAC | TEXT | WASL | WT
COLOR=WHITE | RED | BLUE | GREEN |
PINK | YELLOW | TURQ | %varname
INTENS=HIGH | LOW | NON | %varname
HILITE=USCORE | BLINK | REVERSE | %varname
TEXT=alternate-note-heading
note-text
HP
PS
RP
ATTENTION
CAUTION
DD
FIG
INFO
LI
LINES
LP
PD
WARNING
XMP
NOTEL
Yes
COMPACT
NOSKIP
SPACE=NO | YES
INDENT=n
TYPE=ET | CH | CT | FP | LEF | LI
| NT | PT | SAC | TEXT | WASL | WT
COLOR=WHITE | RED | BLUE | GREEN |
PINK | YELLOW | TURQ | %varname
INTENS=HIGH | LOW | NON | %varname
HILITE=USCORE | BLINK | REVERSE | %varname
TEXT=alternate-note-heading
LI
LP
ATTENTION
CAUTION
DD
FIG
INFO
LI
LINES
LP
PD
WARNING
XMP
162
z/OS V1R7.0 ISPF Reference Summary
ABC
PDC
MSGMBR
Summary of DTL Tags
Table 1. Tag summary (continued)
Tag
End tag Attributes
Nested tags
Used within
NT
Yes
NOSKIP
INDENT=n
TYPE=ET | CH | CT | FP | LEF | LI
| NT | PT | SAC | TEXT | WASL | WT
COLOR=WHITE | RED | BLUE | GREEN |
PINK | YELLOW | TURQ | %varname
INTENS=HIGH | LOW | NON | %varname
HILITE=USCORE | BLINK | REVERSE | %varname
TEXT=alternate-note-heading
note-text
DL
FIG
HP
LINES
OL
P
PARML
PS
RP
SL
UL
XMP
ATTENTION
CAUTION
DD
FIG
INFO
LI
LINES
LP
PD
WARNING
XMP
OL
Yes
COMPACT
NOSKIP
SPACE=NO | YES
INDENT=n
TEXT=OL-heading-text
LI
LP
ATTENTION
CAUTION
DD
FIG
INFO
LI
LINES
LP
NT
PD
WARNING
XMP
P
No
COMPACT
INTENSE=varname
INDENT=n
OFFSET=n
SPACE=NO | YES
paragraph-text
ATTENTION
CAUTION
HP
PS
RP
WARNING
ATTENTION
CAUTION
DD
FIG
INFO
LI
LINES
LP
NT
PD
WARNING
XMP
Chapter 7. Dialog Tag Language (DTL) Tags
163
Summary of DTL Tags
Table 1. Tag summary (continued)
Tag
End tag Attributes
PANDEF
164
No
ID=pandef-id
HELP=help-panel-name | %varname
DEPTH=n | FIT
WIDTH=n | FIT | %varname
KEYLIST=key-list-name
KEYLTYPE=PRIVATE | SHARED
APPLID=application-id
CCSID=n
WINDOW=YES | NO
WINTITLE=window-title
APPTITLE=application-title
PAD=NULLS | USER | char | %varname
PADC=NULLS | USER | char | %varname
OUTLINE=NONE | L | R | O | U | BOX |
%varname
EXPAND=xy
MERGESAREA=NO | YES
ENTKEYTEXT=enter-key-text
IMAPNAME=image-name | %varname
IMAPROW=n | %varname
IMAPCOL=n | %varname
TMARGIN=n
BMARGIN=n
z/OS V1R7.0 ISPF Reference Summary
Nested tags
Used within
Summary of DTL Tags
Table 1. Tag summary (continued)
Tag
PANEL
End tag Attributes
Yes
Nested tags
NAME=panel-name
HELP=help-panel-name | %varname
PANDEF=pandef-id
DEPTH=22 | n | FIT
WIDTH=76 | n | FIT | %varname
KEYLIST=key-list-name
KEYLTYPE=PRIVATE | SHARED
APPLID=application-id
CURSOR=cursor-field
CSRINDEX=index-value
CSRPOS=position-value
CCSID=n
MENU
PRIME
TUTOR
WINDOW=YES | NO
WINTITLE=window-title
APPTITLE=application-title
PAD=NULLS | USER | char | %varname
PADC=NULLS | USER | char | %varname
OUTLINE=NONE | L | R | O | U | BOX |
%varname
EXPAND=xy
MSGLINE=YES | NO
TITLINE=YES | NO
CMDLINE=YES | NO
ATTRUSE=NO | YES | ALL
ENDATTR=DEFAULT | TEXT
TYPE=BOTH | GUI | NOGUI
SMSG=short-msg-fieldname
LMSG=long-msg-fieldname
ASIS
ACTBAR
MERGESAREA=NO | YES
PANELSTMT=YES | NO
ENTKEYTEXT=enter-key-text
IMAPNAME=image-name | %varname
IMAPROW=n | %varname
IMAPCOL=n | %varname
TMARGIN=n
BMARGIN=n
ERRORCHECK=NO | YES
ZUP=zup-id
ZCONT=zcont-id
AUTONRET=NO | YES
AUTOTCMD=NO | YES | PROC
panel-title-text
Used within
AB
AREA
BOTINST
CMDAREA
COMMENT
DA
DIVIDER
DTACOL
DTAFLD
GA
GENERATE
GRPHDR
HP
INFO
LSTFLD
PNLINST
REGION
SELFLD
SOURCE
TEXTLINE
TOPINST
Chapter 7. Dialog Tag Language (DTL) Tags
165
Summary of DTL Tags
Table 1. Tag summary (continued)
Tag
End tag Attributes
Nested tags
Used within
PARML
Yes
TSIZE=10 | ’S1 S2... Sn’
BREAK=ALL | FIT | NONE
COMPACT
SKIP
INDENT=n
FORMAT=START | CENTER | END
DIVEND=NO | YES
SPLIT=NO | YES
PLDIV
PT
PTDIV
PD
ATTENTION
CAUTION
DD
FIG
INFO
LI
LINES
LP
NT
PD
WARNING
XMP
PD
No
parameter-description
DL
FIG
HP
LINES
NOTE
NOTEL
NT
OL
P
PARML
PS
RP
SL
UL
XMP
PARML
PDC
No
HELP=NO | YES | help-panel-name |
*help-message-id | %varname | *%varname
UNAVAIL=unavail-variable-name
CHECKVAR=check-variable-name
MATCH=1 | match-string
ACC1=key1
ACC2=key2
ACC3=key3
pull-down-description-text
ACTION
COMMENT
M
SOURCE
ABC
PDSEP
No
PLDIV
No
TYPE=NONE | SOLID | DASH | TEXT
GAP=YES | NO
GUTTER=1 | n
FORMAT=START | CENTER | END
divider-text
HP
PARML
PNLINST
No
COMPACT
instruction-text
HP
PS
RP
AREA
REGION
PANEL
166
PDC
z/OS V1R7.0 ISPF Reference Summary
Summary of DTL Tags
Table 1. Tag summary (continued)
Tag
End tag Attributes
Nested tags
Used within
PS
Yes
VAR=point-and-shoot-variable-name | %varname
VALUE=point-and-shoot-value | %varname | *
CSRGRP=NO | YES | n
DEPTH=n | %varname
IMAPNAME=image-name | %varname
IMAPNAMEP=image-namep | %varname
PLACE=ABOVE | BELOW | LEFT |
RIGHT | %varname
point-and-shoot-text
PT
No
FORMAT=START | CENTER | END
NOSKIP
SPLIT=NO | YES
parameter-term
PTDIV
No
PARML
PTSEG
No
PT
REGION
Yes
DIR=VERT | HORIZ
INDENT=n
WIDTH=n | *
DEPTH=n | *
EXTEND=OFF | ON | FORCE
ALIGN=YES | NO
GRPBOX=NO | YES
GRPWIDTH=n
GRPBXVAR=variable-name
GRPBXMAT=1 | string
LOCATION=DEFAULT | TITLE
group-box-title
ATTENTION
BOTINST
CAUTION
CHOFLD
CHOICE
DD
DDHD
DT
DTAFLD
DTAFLDD
DTHD
FIG
FIGCAP
GRPHDR
H2
H3
H4
LI
LINES
LP
LSTCOL
LSTGRP
NOTE
NT
P
PD
PNLINST
PT
SELFLD
TOPINST
WARNING
XMP
HP
PS
PTSEG
RP
COMMENT
DA
DIVIDER
DTACOL
DTAFLD
GA
GENERATE
GRPHDR
INFO
LSTFLD
PNLINST
REGION
SELFLD
SOURCE
PARML
AREA
HELP
PANEL
REGION
Chapter 7. Dialog Tag Language (DTL) Tags
167
Summary of DTL Tags
Table 1. Tag summary (continued)
Tag
End tag Attributes
RP
Yes
HELP= help-panel-name | help-message-id
| %varname | *%varname
reference-phrase
SCRFLD
Yes
DISPLEN= n | %varname
INDVAR=ind-var
INDVAL=’ind-chars’
LINDVAR=lind-var
LINDVAL=’lind-char’
RINDVAR=rind-var
RINDVAL=’rind-char’
SINDVAR=sind-var
SINDVAL=’sind-chars’
LCOLIND=lcol-var
LCOLDISP= NO | YES
RCOLIND=rcol-var
RCOLDISP= NO | YES
SCALE=scale-var
SCROLL= ON | OFF | %varname
FLDSPOS= BELOW | ABOVE
168
z/OS V1R7.0 ISPF Reference Summary
Nested tags
Used within
ATTENTION
BOTINST
CAUTION
CHOFLD
CHOICE
DD
DDHD
DT
DTAFLD
DTAFLDD
DTHD
FIG
FIGCAP
GRPHDR
H2
H3
H4
LI
LINES
LP
LSTCOL
LSTGRP
NOTE
NT
P
PD
PNLINST
PT
SELFLD
TOPINST
WARNING
XMP
COMMENT
SOURCE
DTAFLD
LSTCOL
Summary of DTL Tags
Table 1. Tag summary (continued)
Tag
SELFLD
End tag Attributes
Yes
NAME=field-name
HELP=NO | YES | help-panel-name |
*help-message-id | %varname | *%varname
TYPE=SINGLE | MULTI | MENU | MODEL |
TUTOR
PMTLOC=ABOVE | BEFORE
PMTWIDTH=n | * | **
SELWIDTH=n | *
ENTWIDTH=2 | n | ’e1 e2...en’
REQUIRED=NO | YES
MSG=message-identifier
FCHOICE=1 | 0
AUTOTAB=YES | NO
DEPTH=n | *
EXTEND=OFF | ON | FORCE
TRAIL=’trail-var-1 trail-var-2 ... trail-var-n’
CHOICECOLS=1 | n
CHOICEDEPTH=n | *
CWIDTHS=’w1 w2...wn’
PAD=NULLS | USER | char | %varname
PADC=NULLS | USER | char | %varname
OUTLINE=NONE | L | R | O | U | BOX |
%varname
SELMSG=selfld-msg-identifier
SELMSGU=selfld-msg-unavailable
INIT=YES | NO | init-value
VERIFY=YES | NO
REFRESH=YES | NO
SELFMT=START | END
CHKBOX=YES | NO
ZGUI=YES | NO
CSRGRP=NO | YES | n
TSIZE=’s1 s2...sn’
LISTTYPE=RADIO | LISTBOX | DDLIST | COMBO
LISTREF=list-name
LISTDEPTH=n
DBALIGN=YES | NO | FIELD | FORCE
NOSEL=no-selection-value
SELDEFAULT=x
PMTSKIP=NO | YES
FLDTYPE=CUA | ISPF
COLOR=WHITE | RED | BLUE | GREEN |
PINK | YELLOW | TURQ | %varname
INTENS=HIGH | LOW | NON | %varname
HILITE=USCORE | BLINK | REVERSE | %varname
SELCHECK=NO |YES
VARDCL=YES | NO
field-prompt-text
Nested tags
Used within
CHDIV
CHOICE
COMMENT
HP
PS
RP
SOURCE
AREA
DTACOL
PANEL
REGION
Chapter 7. Dialog Tag Language (DTL) Tags
169
Summary of DTL Tags
Table 1. Tag summary (continued)
Tag
End tag Attributes
SL
Yes
COMPACT
NOSKIP
SPACE=NO | YES
INDENT=n
TEXT=’SL-heading-text’
SOURCE
Yes
TYPE=PROC | REINIT | INIT | ABCINIT |
ABCPROC
text
T
No
TEXTLINE
Yes
TEXTSEG
No
TOPINST
UL
170
Nested tags
Used within
LI
LP
ATTENTION
CAUTION
DD
FIG
INFO
LI
LINES
LP
NT
PD
WARNING
XMP
ABC
AREA
CHOICE
DA
DTACOL
DTAFLD
HELP
LSTCOL
LSTFLD
LSTGRP
PANEL
PDC
REGION
SELFLD
CMD
DTAFLD
TEXTSEG
HELP
PANEL
EXPAND=AFTER | BEFORE | BOTH
WIDTH=n
text
HP
TEXTLINE
No
COMPACT
instruction-text
HP
PS
RP
PANEL
Yes
COMPACT
NOSKIP
SPACE=NO | YES
INDENT=n
TEXT=UL-heading-text
LI
LP
ATTENTION
CAUTION
DD
FIG
INFO
LI
LINES
LP
NT
PD
WARNING
XMP
z/OS V1R7.0 ISPF Reference Summary
Summary of DTL Tags
Table 1. Tag summary (continued)
Tag
End tag Attributes
Nested tags
Used within
VARCLASS
No
NAME=variable-class-name
TYPE=’CHAR maximum length’
’DBCS maximum length’
’MIXED maximum length’
’ANY maximum length’
’EBCDIC maximum length’
’%varname maximum length’
ITIME
STDTIME
IDATE
STDDATE
JDATE
JSTD
’VMASK maximum-length’
’NUMERIC total-digits 0 | fractional-digits’
MSG=message-identifier
CHECKL
XLATL
VARDCL
No
NAME=name
VARCLASS=variable-class-name
VARLIST
Yes
VARSUB
No
VAR=variable-name
WARNING
Yes
text
DL
FIG
HP
LINES
NOTE
NOTEL
NT
OL
P
PARML
PS
RP
SL
UL
XMP
LI
LP
P
XLATI
No
VALUE=internal-value
displayed-value
LIT
XLATL
XLATL
Yes
FORMAT=NONE | UPPER
TRUNC=n | char
MSG=message-identifier
XLATI
VARCLASS
XMP
Yes
NOSKIP
text
DL
HP
NOTE
NOTEL
NT
OL
P
PARML
PS
RP
SL
UL
ATTENTION
CAUTION
DD
FIG
INFO
LI
LINES
LP
NT
PD
WARNING
VARLIST
VARDCL
MSG
Chapter 7. Dialog Tag Language (DTL) Tags
171
172
z/OS V1R7.0 ISPF Reference Summary
Appendix. Accessibility
Accessibility features help a user who has a physical disability, such as restricted
mobility or limited vision, to use software products successfully. The major
accessibility features in z/OS enable users to:
v Use assistive technologies such as screen readers and screen magnifier software
v Operate specific or equivalent features using only the keyboard
v Customize display attributes such as color, contrast, and font size
Using assistive technologies
Assistive technology products, such as screen readers, function with the user
interfaces found in z/OS. Consult the assistive technology documentation for
specific information when using such products to access z/OS interfaces.
Keyboard navigation of the user interface
Users can access z/OS user interfaces using TSO/E or ISPF. Refer to z/OS TSO/E
Primer, z/OS TSO/E User’s Guide, and z/OS ISPF User’s Guide Vol I for information
about accessing TSO/E and ISPF interfaces. These guides describe how to use
TSO/E and ISPF, including the use of keyboard shortcuts or function keys (PF
keys). Each guide includes the default settings for the PF keys and explains how to
modify their functions.
z/OS information
z/OS information is accessible using screen readers with the BookServer/Library
Server versions of z/OS books in the Internet library at:
www.ibm.com/servers/eserver/zseries/zos/bkserv/
© Copyright IBM Corp. 1989, 2005
173
174
z/OS V1R7.0 ISPF Reference Summary
Notices
This information was developed for products and services offered in the USA.
IBM may not offer the products, services, or features discussed in this document in
other countries. Consult your local IBM representative for information on the
products and services currently available in your area. Any reference to an IBM
product, program, or service is not intended to state or imply that only that IBM
product, program, or service may be used. Any functionally equivalent product,
program, or service that does not infringe any IBM intellectual property right may
be used instead. However, it is the user’s responsibility to evaluate and verify the
operation of any non-IBM product, program, or service.
IBM may have patents or pending patent applications covering subject matter
described in this document. The furnishing of this document does not give you
any license to these patents. You can send license inquiries, in writing, to:
IBM Director of Licensing
IBM Corporation
North Castle Drive
Armonk, NY 10504-1785
USA
For license inquiries regarding double-byte (DBCS) information, contact the IBM
Intellectual Property Department in your country or send inquiries, in writing, to:
IBM World Trade Asia Corporation
Licensing
2-31 Roppongi 3-chome, Minato-ku
Tokyo 106, Japan
The following paragraph does not apply to the United Kingdom or any other
country where such provisions are inconsistent with local law:
INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS
PUBLICATION “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS
FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or
implied warranties in certain transactions, therefore, this statement may not apply
to you.
This information could include technical inaccuracies or typographical errors.
Changes are periodically made to the information herein; these changes will be
incorporated in new editions of the publication. IBM may make improvements
and/or changes in the product(s) and/or the program(s) described in this
publication at any time without notice.
Any references in this information to non-IBM Web sites are provided for
convenience only and do not in any manner serve as an endorsement of those Web
sites. The materials at those Web sites are not part of the materials for this IBM
product and use of those Web sites is at your own risk.
IBM may use or distribute any of the information you supply in any way it
believes appropriate without incurring any obligation to you.
© Copyright IBM Corp. 1989, 2005
175
Licensees of this program who wish to have information about it for the purpose
of enabling: (i) the exchange of information between independently created
programs and other programs (including this one) and (ii) the mutual use of the
information which has been exchanged, should contact:
IBM Corporation
Mail Station P300
2455 South Road
Poughkeepsie, NY 12601-5400
USA
Such information may be available, subject to appropriate terms and conditions,
including in some cases, payment of a fee.
The licensed program described in this information and all licensed material
available for it are provided by IBM under terms of the IBM Customer Agreement,
IBM International Program License Agreement, or any equivalent agreement
between us.
If you are viewing this information softcopy, the photographs and color
illustrations may not appear.
Programming Interface Information
This publication primarily documents information that is NOT intended to be used
as Programming Interfaces of ISPF.
This publication also documents intended Programming Interfaces that allow the
customer to write programs to obtain the services of ISPF. This information is
identified where it occurs, either by an introductory statement to a chapter or
section or by the following marking:
+---------------------Programming Interface information----------------------+
+------------------End of Programming Interface information------------------+
Trademarks
The following terms are trademarks of International Business Machines
Corporation in the United States, other countries, or both:
AD/Cycle
APL2
BookManager
BookMaster
C++/MVS
COBOL/370
Common User Access
CUA
DFSMSrmm
DFSMS/MVS
DFSORT
FFST
GDDM
IBM
Language Environment
MVS
MVS/XA
OS/390
RACF
SAA
Systems Application Architecture
Tivoli
VTAM
z/OS
Microsoft, Windows, and Windows NT are trademarks of Microsoft Corporation in
the United States, other countries, or both.
176
z/OS V1R7.0 ISPF Reference Summary
UNIX is a registered trademark of The Open Group in the United States and other
countries.
Linux is a trademark of Linus Torvalds in the United States, other countries, or
both.
Other company, product, and service names may be trademarks or service marks
of others.
Notices
177
178
z/OS V1R7.0 ISPF Reference Summary
Readers’ Comments — We’d Like to Hear from You
Interactive System Productivity Facility (ISPF)
Reference Summary
z/OS Version 1 Release 7.0
Publication No. SC34-4816-04
Overall, how satisfied are you with the information in this book?
Overall satisfaction
Very Satisfied
Satisfied
Neutral
Dissatisfied
h
h
h
h
Very
Dissatisfied
h
How satisfied are you that the information in this book is:
Accurate
Complete
Easy to find
Easy to understand
Well organized
Applicable to your tasks
Very Satisfied
Satisfied
Neutral
Dissatisfied
h
h
h
h
h
h
h
h
h
h
h
h
h
h
h
h
h
h
h
h
h
h
h
h
Very
Dissatisfied
h
h
h
h
h
h
Please tell us how we can improve this book:
Thank you for your responses. May we contact you?
h Yes
h No
When you send comments to IBM, you grant IBM a nonexclusive right to use or distribute your comments in any
way it believes appropriate without incurring any obligation to you.
Name
Company or Organization
Phone No.
Address
SC34-4816-04
___________________________________________________________________________________________________
Readers’ Comments — We’d Like to Hear from You
Cut or Fold
Along Line
_ _ _ _ _ _ _Fold
_ _ _and
_ _ _Tape
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _Please
_ _ _ _ _do
_ _not
_ _ staple
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _Fold
_ _ _and
_ _ Tape
______
NO POSTAGE
NECESSARY
IF MAILED IN THE
UNITED STATES
BUSINESS REPLY MAIL
FIRST-CLASS MAIL
PERMIT NO. 40 ARMONK, NEW YORK
POSTAGE WILL BE PAID BY ADDRESSEE
IBM Corporation
Department J87/D325
555 Bailey Avenue
San Jose, CA
U.S.A. 95141-9989
_________________________________________________________________________________________
Please do not staple
Fold and Tape
Fold and Tape
SC34-4816-04
Cut or Fold
Along Line
Program Number: 5694-A01
Printed in USA
SC34-4816-04
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertising