z/OS ISPF Services Guide
Previous topic |
Next topic
|
Contents
|
Contact z/OS
|
Library
|
PDF
Contents (exploded view)
z/OS ISPF Services Guide
SC19-3626-00
First Edition (September 2013)
Abstract for ISPF Services Guide
Where to find more information
Introduction to ISPF services
Description of the services
Using ISPQRY to test whether ISPF is active
Invoking the ISPF services
Load module search order
Invoking services from command procedures
The ISPEXEC interface
ISPEXEC parameter conventions
Using command invocation variables
Attention interrupt handling
Passing dialog variables as parameters
Invoking ISPF services with program functions
The ISPLINK interface
CALL ISPLINK parameters
The ISPEXEC interface
CALL ISPEXEC parameters
Using parameters as symbolic variables
FORTRAN and Pascal
FORTRAN examples
Pascal example
APL2
APL2 examples
PL/I
PL/I examples
COBOL
COBOL examples
C
C Examples
Assembler
Assembler example
Return codes from services
Command invocation return code variable
Call invocation return code variables
Return code of 12 or higher
System variables used to format error messages
Return codes from I/O and command routines
A summary of the ISPF services
Display services
File tailoring services
Library access services
PDF component services
Table services
Variable services
Miscellaneous services
Description of the ISPF services
ADDPOP—start pop-up window mode
Command invocation format
Call invocation format
Parameters
Return codes
Example
BRIF—Browse interface
Command invocation format
Call invocation format
Parameters
Dialog-supplied routines
Read routine
Command routine
Return codes
Read Routine Return Codes
Command routine
BRIF service
Example
Call invocation
BROWSE—browse a data set
Command invocation format
Call invocation format
Parameters
Return codes
Example
Command invocation
Call invocation
CONTROL—set processing modes
Command invocation format
Call invocation format
ADDPOP/REMPOP service in relation to CONTROL service
Parameters
Return codes
Examples
Example 1:
Example 2:
Example 3:
Example 4:
DIRLIST—directory list service
Command invocation format
Call invocation format
Parameters
Return codes
Example
DISPLAY—display panels and messages
Command invocation format
Call invocation format
Parameters
Using the COMMAND Option
Return codes
Examples
Example 1: Display variables and message, set cursor position
Example 2: Unknown command handled by DISPLAY
Example 3: Unknown command handled by dialog
Example 4: Command stack contains an invalid parameter
Example 5: Display message in a pop-up window
DSINFO—data set information dialog service
Command invocation format
Call invocation format
Parameters
Return codes
Example
EDIF—Edit interface
Command invocation format
Call invocation format
Parameters
Dialog-supplied routines
Read routine
Write routine
Command routine
Return codes
Read routine
Write Routine Return Codes
Command Routine Return Codes
EDIF Service Return Codes
Example
Call invocation
EDIREC - Initialize Edit Recovery
Command invocation format
Call invocation format
Parameters
Return codes
Example
EDIT—edit a data set
Command invocation format
Call invocation format
Parameters
Return codes
Examples
Example 1: Edit a PDS member
Command invocation
Call invocation
Example 2: Edit a workstation file
Command invocation
Call invocation
Example 3: Edit a z/OS UNIX file
Command invocation
Call invocation
EDREC—specify edit recovery handling
Command invocation format
Call invocation format
Parameters
Return codes
Examples
Example 1:
Command invocation
Call invocation
Example 2:
FILESTAT—statistics for a file
Command invocation format
Call invocation format
Parameters
Return codes
Example
FILEXFER—upload or download file
Command invocation format
Call invocation format
Parameters
Return codes
Example
FTCLOSE—end file tailoring
Command invocation format
Call invocation format
Parameters
Return codes
Example
FTERASE—erase file tailoring output
Command invocation format
Call invocation format
Parameters
Return codes
Example
FTINCL—include a skeleton
Command invocation format
Call invocation format
Parameters
Return codes
Example
FTOPEN—begin file tailoring
Command invocation format
Call invocation format
Parameters
Return codes
Example
GETMSG—get a message
Command invocation format
Call invocation format
Parameters
Return codes
Example
GRERROR—graphics error block service
Command invocation format
Call invocation format
Parameters
Return codes
GRINIT—graphics initialization
Command invocation format
Call invocation format
Parameters
Return codes
Example
GRTERM—graphics termination service
Command invocation format
Call invocation format
Return codes
LIBDEF—allocate application libraries
Application data element search order
Command invocation format
Call invocation format
Parameters
Usage notes
LIBDEF Display utility
User link libraries
Message libraries
Return codes
Examples
Example 1: The DATASET keyword
Example 2: The EXCLDATA keyword
Example 3: The LIBRARY keyword
Example 4: The EXCLLIBR keyword
Example 5: The STACK keyword
Example 6: The STKADD keyword
LIST—write lines to the list data set
Command invocation format
Call invocation format
Parameters
Return codes
Formatting data to be written to the list data set
List data set characteristics affect the LIST service
Controlling line spacing, page eject, and highlighting
How ISPF controls printer functions (CC not specified)
How the dialog controls printer functions (CC specified)
Using system variables ZLSTNUML and ZLSTLPP
How carriage control characters affect truncation
Examples
Example 1
Example 2
Example 3
Example 4
LMCLOSE—close a data set
Command invocation format
Call invocation format
Parameters
Return codes
Example
Command invocation
Call invocation
LMCOMP—compresses a partitioned data set
Command invocation format
Call invocation format
Parameters
Return codes
Example
Command invocation
Call invocation
LMCOPY—copy members of a data set
Command invocation format
Call invocation format
Parameters
Return codes
Example
Command invocation
Call invocation
LMDDISP—data set list service
Command invocation format
Call invocation format
Parameters
Return codes
Example
Command invocation
Call invocation
LMDFREE—free a data set list ID
Command invocation format
Call invocation format
Parameters
Return codes
Example
Command invocation
Call invocation
LMDINIT—initialize a data set list
Command invocation format
Call invocation format
Parameters
Return codes
Examples
Example 1:
Command invocation
Call invocation
Example 2:
Command invocation
Call invocation
Call invocation
LMDLIST-list data sets
Command invocation format
Call invocation format
Parameters
Return codes
Examples
Example 1:
Command invocation
Call invocation
Example 2:
Example 3:
LMERASE—erase a data set
Command invocation format
Call invocation format
Parameters
Return codes
Example
Command invocation
Call invocation
LMFREE—free data set from its association with data ID
Command invocation format
Call invocation format
Parameters
Return codes
Example
Command invocation
Call invocation
LMGET—read a logical record from a data set
Command invocation format
Call invocation format
Parameters
Return codes
Example 1
Command invocation
Call invocation
Example 2
Example 3 (MULTX)
LMINIT—generate a data ID for a data set
Command invocation format
Call invocation format
Parameters
Return codes
Examples
Example 1:
Command invocation
Call invocation
Example 2:
Command invocation
Call invocation
Example 3:
Command invocation
Call invocation
LMMADD—add a member to a data set
Command invocation format
Call invocation format
Parameters
Return codes
Example
Command invocation
Call invocation
LMMDEL—delete members from a data set
Command invocation format
Call invocation format
Parameters
Return codes
Example
Command invocation
Call invocation
LMMDISP—member list service
Dialog variables
DISPLAY option
Command invocation format
Call invocation format
Parameters
Return codes
Example
Call invocation
GET option
Command invocation format
Call invocation format
Parameters
Return codes
Example
Command invocation
Call invocation
PUT option
Command invocation format
Call invocation format
Parameters
Return codes
Example
Command invocation
Call invocation
ADD option
Command invocation format
Call invocation format
Parameters
Return codes
Example
Command invocation
Call invocation
DELETE option
Command invocation format
Call invocation format
Parameters
Return codes
Example
Command invocation
Call invocation
FREE option
Command invocation format
Call invocation format
Parameters
Return codes
Example
Command invocation
Call invocation
LMMFIND—find a library member
Command invocation format
Call invocation format
Parameters
Return codes
Example
Command invocation
Call invocation
LMMLIST—list a library's members
Command invocation format
Call invocation format
Parameters
Return codes
Examples
Example 1:
Command invocation
Call invocation
Example 2:
Command invocation
Call invocation
Example 3:
LMMOVE—move members of a data set
Command invocation format
Call invocation format
Parameters
Return codes
Example
Command invocation
Call invocation
LMMREN—rename a data set member
Command invocation format
Call invocation format
Parameters
Return codes
Example
Command invocation
Call invocation
LMMREP—replace a member of a data set
Command invocation format
Call invocation format
Parameters
Return codes
Example
Command invocation
Call invocation
LMMSTATS—set and store, or delete ISPF statistics
Command invocation format
Call invocation format
Parameters
Return codes
Example
Command invocation
Call invocation
LMOPEN—open a data set
Command invocation format
Call invocation format
Parameters
Return codes
Example
Command invocation
Call invocation
LMPRINT—print a partitioned or sequential data set
Command invocation format
Call invocation format
Parameters
Return codes
Example
Command invocation
Call invocation
LMPUT—write a logical record to a data set
Command invocation format
Call invocation format
Parameters
Return codes
Example
Command invocation
Call invocation
Example (MULTX)
LMQUERY—give a dialog information about a data set
Command invocation format
Call invocation format
Parameters
Return codes
Example
Command invocation
Call invocation
LMRENAME—rename an ISPF library
Command invocation format
Call invocation format
Parameters
Return codes
Example
Command invocation
Call invocation
LOG—write a message to the log data set
Command invocation format
Call invocation format
Parameters
Return codes
Example 1
Example 2
Example 3
MEMLIST—member list dialog service
Command invocation format
Call invocation format
Parameters
Return codes
Example
PQUERY—obtain panel information
Command invocation format
Call invocation format
Parameters
Return codes
Example
QBASELIB—query base library information
Command invocation format
Call invocation format
Parameters
Return codes
Example
QLIBDEF—query LIBDEF definition information
Command invocation format
Call invocation format
Parameters
Return codes
Example
QTABOPEN—query open ISPF tables
Command invocation format
Call invocation format
Parameters
Return codes
Example
QUERYENQ—query system ENQ data
Command invocation format
Call invocation format
Parameters
Variables returned in each row of the table
Return codes
REMPOP—remove a pop-up window
Command invocation format
Call invocation format
Parameters
Return codes
SELECT—select a panel or function
Command invocation format
Call invocation format
Parameters
Return codes
Examples
Example 1
Example 2
Example 3
Example 4
Example 5
Example 6
SETMSG—set next message
Command invocation format
Call invocation format
Parameters
Return codes
Example 1
Example 2
TBADD—add a row to a table
Command invocation format
Call invocation format
Parameters
Return codes
Example 1
Example 2
TBBOTTOM—set the row pointer to bottom
Command invocation format
Call invocation format
Parameters
Return codes
Example
TBCLOSE—close and save a table
Command invocation format
Call invocation format
Parameters
Return codes
Example
TBCREATE—create a new table
Command invocation format
Call invocation format
Parameters
Return codes
Examples
Example 1
Example 2
Example 3
TBDELETE—delete a row from a table
Command invocation format
Call invocation format
Parameters
Return codes
Example
TBDISPL—display table information
TBDISPL operation
Operational results from user actions
ZTDTOP and ZTDSELS variables
Command invocation format
Call invocation format
Parameters
Parameter processing
Return codes
Example
System variables related to TBDISPL
Panel control variables related to TBDISPL
Parameter variables related to TBDISPL
Using TBDISPL with other services
Techniques for using the TBDISPL service
Rules applying to variable model lines
Example—panel using variable model lines
Example—scroll indicator field in first variable model line
Example—using the TBDISPL and TBPUT services
Command procedure function
Description of function steps
TBDISPL summary
TBEND—close a table without saving
Command invocation format
Call invocation format
Parameters
Return codes
Example
TBERASE—erase a table
Command invocation format
Call invocation format
Parameters
Return codes
Example
TBEXIST—determine whether a row exists in a table
Command invocation format
Call invocation format
Parameters
Return codes
Example
TBGET—retrieve a row from a table
Command invocation format
Call invocation format
Parameters
Return codes
Example
TBMOD—modify a row in a table
Command invocation format
Call invocation format
Parameters
Return codes
Example
TBOPEN—open a table
Command invocation format
Call invocation format
Parameters
Return codes
Example
TBPUT—update a row in a table
Command invocation format
Call invocation format
Parameters
Return codes
Example
TBQUERY—obtain table information
Command invocation format
Call invocation format
Parameters
Return codes
Example
TBSARG—define a search argument
Command invocation format
Call invocation format
Parameters
Return codes
Examples
TBSAVE—save a table
Command invocation format
Call invocation format
Parameters
Return codes
Example
TBSCAN—search a table
Command invocation format
Call invocation format
Parameters
Return codes
Examples
Example 1
Example 2
Example 3
TBSKIP—move the row pointer
Command invocation format
Call invocation format
Parameters
Return codes
Example
TBSORT—sort a table
Command invocation format
Call invocation format
Parameters
Return codes
Example 1
Example 2
TBSTATS—retrieve table statistics
Command invocation format
Call invocation format
Parameters
Return codes
Example
TBTOP—set the row pointer to the top
Command invocation format
Call invocation format
Parameters
Return codes
Example
TBVCLEAR—clear table variables
Command invocation format
Call invocation format
Parameters
Return codes
Example
TRANS—translate CCSID data
Command invocation format
Call invocation format
Parameters
Return codes
VCOPY—create a copy of a variable
Command invocation format
Call invocation format
Parameters
Return codes
Example
VDEFINE—define function variables
Command invocation format
Call invocation format
Parameters
Return codes
Examples
Example 1: Error message variable
Example 2: Different data formats
Example 3: Variables in a structure
Example 4: Character data variables
VDEFINE exit routine
Return codes
Example of Using the VDEFINE Exit
VDELETE—remove a definition of function variables
Command invocation format
Call invocation format
Parameters
Return codes
Example
VERASE—remove variables from shared or profile pool
Command invocation format
Call invocation format
Parameters
Return codes
Example
VGET—retrieve variables from a pool or profile or system symbol
Command invocation format
Call invocation format
Parameters
Return codes
Examples
VIEW—view a data set
Command invocation format
Call invocation format
Parameters
Return codes
Examples
Example 1:
Command invocation
Call invocation
Example 2:
Command invocation
Call invocation
Example 3:
Command invocation
Call invocation
VIIF—View interface
Command invocation format
Call invocation format
Parameters
Dialog-supplied routines
Read routine
Command routine
Write routine
Return codes
Read routine
Command routine return codes
VIIF service return codes
Write routine return codes
Example
Call invocation
VMASK—mask and edit processing
VMASK call invocation
Parameters
Return codes
Example
The VEDIT statement
VPUT—update variables in the shared or profile pool
Command invocation format
Call invocation format
Parameters
Return codes
Example
VREPLACE—replace a variable
Command invocation format
Call invocation format
Parameters
Return codes
Example
VRESET—reset function variables
Command invocation format
Call invocation format
Return codes
Example
VSYM—resolve system symbols
Command invocation format
Call invocation format
Parameters
Return codes
Example
WSCON—connect to a workstation
Command invocation format
Call invocation format
Parameters
Return codes
Example
WSDISCON—disconnect from a workstation
Command invocation format
Call invocation format
Parameters
Return codes
Usage notes
Restrictions
JSON API
JSON data structures and variables used to communicate between ISPF and a client
JSON data structures sent from TSO to client (message type 2)
TSO Message JSON
TSO message JSON example
TSO prompt JSON
TSO prompt JSON example
JSON data structures sent from ISPF to client (message type 3)
ISPF panel display JSON
ISPF panel display JSON examples
ISPF action JSON
ISPF action JSON example
JSON data structures sent from client to TSO (message type 7)
TSO user response JSON
TSO user response JSON example
TSO action request JSON
TSO action request JSON example
JSON data structures sent from client to ISPF (message type 8)
User response JSON
User response JSON examples
Client action JSON
Client action JSON examples
ISPF variables
Copyright IBM Corporation 1990, 2014