Exit control block data names

Table 1. Exit data names
Description Data type Set by: Value
Eye catcher CL8 ZDT initialization "UIOEXCB"
Interface version F ZDT initialization
1
Initial value
Level support F I/O exit initialization
0
Process without exit
1
I/O performed by Z Data Tools
2
Reserved for future use
Function code F ZDT, for every call to the exit
1
Initialize once per data set
2
Terminate once per data set
3
Open, multiple possible per data set
4
Close, multiple possible per data set
5
Read, required
6
Write, required
7
Reserved for future use
8
Reserved for future use
9
Reserved for future use
Exit return code F I/O exit
0
OK, default. See note 1.
4
Warning
8
Error, terminate function
12
Severe error, terminate function
16
Fatal error, terminate function
Warning code F I/O exit
0
Normal warning, default. See note 1.
1
Reserved for future use
2
Complete, continue processing without exit
Functions supported by exit X I/O exit initialization
1
Read, required
2
Write, required
3
Read + write, default
32
Reserved for future use
64
Reserved for future use
128
Reserved for future use
Operating mode X ZDT initialization
1
TSO in batch
8
Keyword mode
16
Command mode
32
Query/answer mode
64
Fullscreen ISPF
128
Batch, without TSO
DDNAME CL8 ZDT initialization DDname allocated by Z Data Tools
DSN CL44 ZDT initialization fully qualified DSN
Member name CL8 ZDT initialization Member name, only if the data set is opened as sequential, not PO
VOLSER CL6 ZDT initialization First VOLSER of the data set, set to blank if not used
DSORG 2X ZDT open Data set organization:

1st byte:

1
Unmovable
2
PDS(E)
32
DA
64
PS
128
IS

2nd byte:

1
HFS
8
VSAM
16
IAM involved
VSAM catalog entry X ZDT open
8
Path
16
Alternate index
32
Index
64
Data
128
Cluster
VSAM type information X ZDT open
4
IAM
8
LDS
16
VRRDS
32
RRDS
64
ESDS
128
KSDS
RECFM X ZDT open
2 - M
Machine control character
4 - A
ASA control character
8 - S
Spanned
16 - B
Blocked
32 - T
Track overflow
64 - V
Variable
128 - F
Fixed
128+64 - U
Undefined
Allocation mode X ZDT initialization
1
Old
2
Mod
4
New
8
(new,catlg)
16
Shr
128
JCL/DD allocated
Open mode X ZDT open
1
Input
2
Output
4
Update/inout
8
Initial load (VSAM)
Processing mode X ZDT initialization
128
Temporary file used in support edit of data (dsn - original name preserved)
LRECL F ZDT open record length (non-VSAM)
BLKSIZE F ZDT open block size (non-VSAM)
MLRECL F ZDT open maximum record length (VSAM)
CISZ F ZDT open CI size (VSAM)
KEYLEN F ZDT open key length
RKP F ZDT open relative key position (relative to zero offset into the IO area)
RBA XL8 ZDT or I/O exit read XRBA (VSAM)
SLOT F ZDT or I/O exit read slot number (VSAM, RRDS/VRRDS)
MAXL F I/O exit open maximum record length ever to be returned by the exit after read and decompression/decoding. The initial value is the same as that for the file on DASD.
Estimated raw (that is, uncompressed) data set size, as a percentage of the original size. See note 2. F I/O exit open
0
Unknown
nnn
Percentage of the original size
100
Initial value
Current® input record pointer A ZDT, all IO I/O area address passed to the exit (size at least as big as the maximum record length) holds the record to be processed by read/write
Current input record length F ZDT, all IO length of record passed to the exit
Current output record pointer A ZDT, all IO I/O area address passed to the exit (size at least as big as the maximum record length) for the output record, holds the record being the result of processing by read/write
Current output record length F I/O exit, all IO Length of record passed from the exit, if zero then the input record will be assumed to be unchanged and the output record will be ignored
HFS path name pointer A ZDT initialization, open Address of an HFS path name
HFS path name length F ZDT initialization, open Length of an HFS path name
HFS object type X ZDT initialization, open HFS object type specified by the HFS path:
4
Socket
8
Symbolic link
16
FIFO
32
Regular file
64
Special character file
128
Directory
Note: Only regular files are supported. Directory can be set at initialization only. Other types are added for completeness.
HFS processing mode X ZDT initialization, open HFS processing mode used in an HFS file processing:
64
Binary mode (records of fixed, arbitrary defined, length)
128
Text mode (record boundaries determined by delimiters)
Message CL80 I/O exit, all (Error) message - can be provided for output after each operation, non-error messages will be suppressed after 100 messages per session. See note 3.
User scratchpad area CL1024 UIOEX, all Maintained by the exit from INIT to TERM
Note:
  1. Zero is the default. This code is initialized to zero on every call from Z Data Tools to the exit, before the control block is passed to the exit.
  2. This is a compression ratio, where 100 means the same size as the original data. 100 is the initial value. See Open call discussion for more information, and examples of a compression ratio.
  3. See Information that should always be returned from the I/O Exit to Z Data Tools for more information about message suppression.