EDTPARL - Work file-specific parameter settings

When reading the work file-specific parameter settings with the IEDTGET function, EDT saves the information in the EDTPARL control block.

Creating the EDTPARL control block

The Assembler macro IEDTPARL can be used to generate the EDTPARL control block.

Name	Operation	Operands
[name]	IEDTPARL	[ { D | C } ] [,prefix] [,VERSION= { 1 | 2 | 3 | 4 } ]

name	– Symbolic name of the first DS statement when C is specified. – DSECT name if D is specified. If name is not specified then EDTPARL is used (preceded by prefix if specified).
D C	A dummy section (DSECT) is generated. A memory section with symbolic addresses is generated (no CSECT statement).
prefix	One character with which the generated field names should start. If prefix is not specified, E is used by default.
VERSION	Selects which version of the control block is to be generated: Versions 1, 2, 3 are used with the V16 format of the interface. Version 4 is used with the V17 format of the interface.

If the macro IEDTPARL VERSION=4 is specified then the EDTPARL control block is generated in the following form:

           IEDTPARL D,VERSION=4
1 EDTPARL  MFPRE DNAME=EDT,MF=D,PREFIX=*
2 EDTPARL  DSECT ,
2                *,##### PREFIX=, MACID= #####
1 *--------------- EDT UNIT NUMBER, EDTPARL VERSION NUMBER --------------
1 EPLUNITC EQU   66                  EDT UNIT NUMBER
1 EPLVERSC EQU   4                   EDTPARL VERSION NUMBER
1 *                       *---- CONTROL BLOCK HEADER --------------------
1 EPLFHE   DS    0XL8                GENERAL OPERAND LIST HEADER
1 EPLIFID  DS    0A                  INTERFACE IDENTIFIER
1 EPLUNIT  DC    AL2(XPLUNITC)       UNIT NUMBER
1          DS    AL1                 RESERVED
1 EPLVERS  DC    AL1(XPLVERSC)       FUNCTION INTERFACE VERSION NUMBER
1          DS    A                   RESERVED
1 *                       *---- OUTPUT FIELDS ---------------------------
1 EPLVPOS  DS    CL8                 FIRST LINE IN WINDOW
1 EPLHPOS  DS    H                   FIRST COLUMN IN WINDOW
1 EPLRLIM  DS    H                   MAX RECORD-LENGTH IN F-MODE
1 EPLINF   DS    CL1                 INF ON/OFF  (1/0)
1 EPLLOW   DS    CL1                 LOWER ON/OFF (1/0)
1 EPLHEX   DS    CL1                 HEX ON/OFF (1/0)
1 EPLEDL   DS    CL1                 EDIT LONG ON/OFF (1/0)
1 EPLSCALE DS    CL1                 SCALE ON/OFF (1/0)
1 EPLPROT  DS    CL1                 PROTECTION ON/OFF (1/0)
1 EPLSTRUC DS    CL1                 STRUCTURE SYMBOL IF EBCDIC
1 EPLOPEN  DS    CL1                 OPEN FLAG:   (I/P/R/S/X/0)
1 EPLEMPTY DS    CL1                 EMPTY FLAG
1 EPLMODIF DS    CL1                 MODIFIED FLAG
1 EPLSTDF  DS    CL54                STANDARD FILENAME
1 EPLSTDL  DS    CL54                STANDARD LIBRARY NAME
1 EPLSTDT  DS    CL8                 STANDARD PLAM TYPE
1          DS    CL4                 RESERVED
1 EPLVPOS1 DS    CL8                 FIRST LINE IN WINDOW 1
1 EPLHPOS1 DS    H                   FIRST COLUMN IN WINDOW 1
1 EPLVPOS2 DS    CL8                 FIRST LINE IN WINDOW 2
1 EPLHPOS2 DS    H                   FIRST COLUMN IN WINDOW 2
1 EPLINDX1 DS    CL1                 INDEX OFF/ON/FULL (0/1/2) WINDOW 1
1 EPLINDX2 DS    CL1                 INDEX OFF/ON/FULL (0/1/2) WINDOW 2
1 EPLOPENC DS    XL1024              COMMON AREA FOR FILE DESCRIPTION
1 EPLOPEND EQU   *                   END OF COMMON AREA
1          ORG   XPLOPENC            DESCRIPTION OF OPENED DATA FILE
1 EPLOPNFL DS    CL54                NAME OF OPENED FILE/PLAM LIBRARY
1 EPLOPNE  DS    CL64                NAME OF OPENED PLAM ELEMENT
1 EPLOPNV  DS    CL24                VERSION OF OPENED PLAM ELEMENT

1 EPLOPNT  DS    CL8                 TYP OF OPENED PLAM ELEMENT
1          ORG   XPLOPENC            DESCRIPTION OF OPENED UFS FILE
1 EPLOPNX  DS    CL1024              NAME OF OPENED UFS FILE
1 *
1 EPLCCSN  DS    CL8                 CODED CHARACTER SET NAME       V17.0
1 EPLCCSNG DS    XL1                 CCS IS GLOBAL (0/1)            V17.0
1 EPLSSTRU DS    H                   STRUCTURE SYMBOL UTF16
1 *--------------- LENGTH OF CONTROL BLOCK ------------------------------
1 EPLPARLL EQU   *-EDTPARL

Depending on the setting of the Open flag EPLOPEN, the EPLOPENC field contains the description of the file opened with @OPEN or @XOPEN or of the PLAM element.

Meaning of the control block fields		Length (bytes)	Format	Parameter type
				Call	Return
EPLUNIT	Identification of EDT.	2	X	C(M)
EPLVERS	Control block version number.	1	X	C(M)
EPLVPOS	1st line in the data window (00000001..99999999), same value as EPLVPOS1	8	C		R
EPLHPOS	1st column in the data window (1..32768), same value as EPLHPOS1)	2	X		R
EPLRLIM	Max. record length in F mode (1..32768)	2	X		R
EPLINF	Information On/Off (1/0)	1	P		R
EPLLOW	Lower On/Off (1/0)	1	P		R
EPLHEX	Hex On/Off (1/0)	1	P		R
EPLEDL	Edit Long On/Off (1/0)	1	P		R
EPLSCALE	Scale On/Off (1/0)	1	P		R
EPLPROT	Protection On/Off (1/0)	1	P		R
EPLSTRUC	Structure symbol (if EBCDIC coding, if another coding is used then the value is simply stored in EPLSSTRU)	1	C		R
EPLOPEN	OPEN display = R: ISAM real P: PLAM I: ISAM virtual S: SAM virtual X: UFS/POSIX 0: No file opened	1	P		R
EPLEMPTY	File empty yes/no (1/0)	1	P		R
EPLMODIF	File modified yes/no (1/0)	1	P		R
EPLSTDF	Default file name set with @FILE	54	P		R
EPLSTDL	Default library name set with @PAR LIBRARY=...	54	P		R
EPLSTDT	Default type set with @PAR ELEMENT- TYPE=...	8	P		R
EPLOPNFL	EPLOPEN = R: ISAM file name, real, opened P: PLAM library name I: ISAM file name S: SAM file name, padded with blanks	54	P		R
EPLOPNE	EPLOPEN = P: PLAM element name, padded with blanks	64	P		R
EPLOPNV	EPLOPEN = P: PLAM version number, padded with blanks	24	P		R
EPLOPNT	EPLOPEN = P: PLAM type, padded with blanks	8	P		R
EPLOPNX	EPLOPEN = X: POSIX file name, padded with blanks, not ending with 0	1024	P		R
EPLVPOS1	First line number in window 1	8	P		R
EPLHPOS1	First column in window 1	2	X		R
EPLVPOS2	First line number in window 2	8	P		R
EPLHPOS2	First column in window 2	2	X		R
EPLINDX1	Index Off/On/Full window 1 (0/1/2), as set with @PAR INDEX=...bzw. @PAR EDIT- FULL=...	1	P		R
EPLINDX2	Index Off/On/Full window 2 (0/1/2)	1	P		R
EPLCCSN	Character set for the work file. If the work file is empty, EPLCCSN contains blanks.	8	P		R
EPLCCSNG	The character set applies to all non-empty work files Yes/No (1/0)	1	P		R
EPLSSTRU	Structure symbol in UTF16	2	U		R

C (M)	Call parameter	Must be supplied by the caller. This is set by the macro (when the P parameter is set) and should not be changed by the user.
D	Call parameter	Must be deleted with binary zeros by the user on the first call.
R X P U	Return parameter Binary format Printable UTF16 characters	Supplied by EDT. Binary digits Printable texts (in the character set EDF03IRV). Text in UTF16 coding

Changes compared to the V16 format

• The EPLCCSN field is new (it previously had the name EPGCCSN in the control block EDTPARG).

• The EPLCCSNG field is new.

• The EPLSTCOD field is no longer used.

• The EPLOPNXC field is no longer used.

• The EPLSTRUC field now only contains the structure symbol if this can be displayed as an EBCDIC character; otherwise it contains binary zeros. The EPLSSTRU field always contains the structure symbol in UTF16 coding.

Compatible V17 format

If V17 format is used to call EDT in compatibility mode or to call an EDT version lower than V17.0 then the information items not supplied by the relevant V16 version are set to default values:

• All file name fields with blanks

• EPLVPOS1 and EPLVPOS2 with '00010000'

• EPLHPOS1 and EPLHPOS2 with binary 1

• EPLINDX1 and EPLINDX2 with '1'

• EPLCCSN with the globally specified CCSN (EPLCCSNG then contains 1) if the work file is not empty; otherwise with blanks (EPLCCSNG then contains 0).