Retrieve Display File Description (QDFRTVFD) API
Required Parameter Group:
| 1 | Receiver variable | Output | Char(*) |
| 2 | Length of receiver variable | Input | Binary(4) |
| 3 | Format name | Input | Char(8) |
| 4 | Qualified file name | Input | Char(20) |
| 5 | Error code | Output | Char(*) |
Default Public Authority: *USE
Threadsafe: No
The Retrieve Display File Description (QDFRTVFD) API allows you to get specific information about the data description specifications (DDS) definition used to create a display file.
If the returned data does not fill the receiver variable, the contents of the remainder of the variable are not changed.
Authorities and Locks
- Library Authority
- *USE
- File Authority
- *OBJOPR
- File Lock
- *SHRNUP
Required Parameter Group
- Receiver variable
- OUTPUT; CHAR(*)
The receiver variable that receives the information requested. You can specify the size of the area smaller than the format requested as long as you specify the length of receiver variable parameter correctly. As a result, the API returns only the data the area can hold.
- Length of receiver variable
- INPUT; BINARY(4)
The length of the receiver variable. If the data available is larger than the length of the receiver variable, the result is truncated. The minimum length is 8 bytes. The actual length of the structure is returned in variable WDFFSIZE in structure QDFFBASE (see the Base File Section (QDFFBASE)).
- Format name
- INPUT; CHAR(8)
The content of the information to be returned about the specified display file. You can use the following format name:
DSPF0100 Display file information See Format DSPF0100 for a description of these formats.
- Qualified file name
- INPUT; CHAR(20)
The name of the file about which the information is to be extracted and the library in which it is located. The first 10 characters contain the file name. The second 10 characters contain the library name.
The special values for the library name follow:
*CURLIB The job's current library *LIBL The library list
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
Format DSPF0100
Format DSPF0100 provides detailed information about how display files are built. The various structures that comprise the display file information format are organized in the following manner:
- Base file formats (see Base File Formats)
- File formats (see File Formats)
- Record formats (see Record Formats)
- Field formats (see Field Formats)
- Keyword formats (see Keyword Formats)
- Where-used formats (see Where-Used Formats)
The structures for each format follow DSPF0100 Format. The structures include the variable names, field information, and offsets. Unlike many APIs, which use an offset from the beginning of the variable, most QDFRTVFD offsets are relative to the start of a base structure. To determine how to arrive at the data, see the introduction to each structure.
The use of the term optioned in the tables refers to an indicator that controls whether the DDS keyword is in effect or not. For more information about option indicators, see Condition for display files (positions 7 through 16).
The asterisk (*) in the Variable Name column represents a reserved field. No variable is associated with these reserved fields.
DSPF0100 Format provides an overview of format DSPF0100 by showing how this information is organized. The abbreviated names in the figure correspond to the structure names of the tables. The formats are shown by section (for example, base file, file header, record header, and so forth). The keyword formats do not appear in the figure.
DSPF0100 Format
Base File Formats
The base file formats follow.
Base File Section (QDFFBASE)
Base file structure. This is the first structure and is located at offset zero of the returned data.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(31) | WDFFRETN | Length of the returned data. | |
| 4 | 4 | BIN(31) | WDFFSIZE | Size of the display file description. | |
| 8 | 8 | BIN(15) | WDFFINOF | Displacement to file header section (see structure QDFFINFO, File Header Section (QDFFINFO)). | |
| 10 | A | BIN(15) | WDFFRCS | Number of record formats specified. This number includes internally generated record formats. | |
| 12 | C | CHAR(1) | WDFFDPAT | Display attribute bits. | |
| 12 | C | 0 | BIT(1) | WDFFSEPI | If on, INDARA keyword is specified. |
| 12 | C | 1 | BIT(1) | WDFFDESF | If on, ERRSFL keyword is specified.
Note: The ERRSFL keyword generates additional internal records (*ERRSFL). |
| 12 | C | 2 | BIT(6) | * | Reserved. |
| 13 | D | BIN(15) | WDFFSCR | Number of valid file screen sizes (see structure QDFFSCRA, Screen Size Table (QDFFSCRA)). | |
| 15 | F | BIN(15) | WDFFSRSQ | Displacement to sort sequence table (see structure QDFFSSEQ, Sort Sequence Table (QDFFSSEQ)). | |
| 17 | 11 | CHAR(2) | WDFFACCSID | CCSID of source member used to create the device file. | |
| 19 | 13 | CHAR(*) | WDFFSCRS | Screen size table. This area defines the screen sizes valid for externally defined files. This is specified by the DSPSIZ keyword. When not specified, a default DSPSIZ(*DS3) is generated. Structure QDFFSCRA (Screen Size Table (QDFFSCRA)) defines the entries. The elements are in the sequence that the DSPSIZ keywords are specified. | |
Screen Size Table (QDFFSCRA)
Screen ID array. The number of entries in this structure is defined by variable WDFFSCR in structure QDFFBASE. This structure is defined at variable WDFFSCRS in structure QDFFBASE. The structure is ARRAY(*).
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(1) | WDFFSCIA | Screen ID. X'03' is defined as *DS3; X'04' is defined as *DS4. | |
| 1 | 1 | CHAR(4) | * | Reserved. | |
Sort Sequence Table (QDFFSSEQ)
Sort sequence table information used for the ALTSEQ keyword. The displacement to this structure from the beginning of structure QDFFBASE is at variable WDFFSRSQ in QDFFBASE.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(256) | WDFFSST | Sort sequence table. | |
| 256 | 100 | BIN(16) | WDFFSSC | CCSID associated with the table. | |
| 258 | 102 | CHAR(10) | WDFFSSN | Table name. | |
| 268 | 10C | CHAR(10) | WDFFSSL | Library name. | |
| 278 | 116 | CHAR(2) | WDFFSSFL | Indicator flags. | |
| 278 | 116 | 0 | BIT(1) | WDFFSSUS | Weighted indicator. 0 is defined as shared weighted; 1 is defined as unique weighted. |
| 278 | 116 | 1 | BIT(1) | WDFFSSSB | Substitution characters indicator. 0 is defined as having no substitution characters; 1 is defined as having substitution characters. |
| 278 | 116 | 2 | BIT(14) | * | Reserved. |
| 280 | 118 | CHAR(26) | * | Reserved. | |
File Formats
File Header Section shows the file section of the overview figure (DSPF0100 Format).
File Header Section
File Header Section (QDFFINFO)
File header structure. The displacement to this structure from the beginning of structure QDFFBASE is at variable WDFFINOF in structure QDFFBASE.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(31) | WDFFDFLO | Length of the file header section. This includes the display-file-level device-dependent section. This is also the displacement from structure QDFFINFO to the record format table (see structure QDFARFTE, Record Format Table (QDFARFTE)). | |
| 4 | 4 | BIN(31) | WDFFWUOF | Displacement to the where-used file-level information structure from structure QDFFINFO (see structure QDFWFLEI, Where-Used File-Level Information Structure (QDFWFLEI)). | |
| 8 | 8 | BIN(31) | WDFFFMWU | Length of file header section and the where-used file-level information structure. | |
| 12 | C | BIN(31) | WDFFSEQO | Displacement from structure QDFFINFO to the sequence number table defined by structure QDFFSEQT (see Sequence Number Table (QDFFSEQT)). 0, if not present. | |
| 16 | 10 | BIN(15) | WDFFSFL | Maximum number of entries in the selection tables defined by structure QDFFSTBL (see Selection Table Entry (QDFFSTBL)) at the record and field levels. | |
| 18 | 12 | BIN(15) | WDFFSCE | Maximum number of entries in the selection tables for this file (structure QDFFSTBL, Selection Table Entry (QDFFSTBL)) at the record levels. | |
| 20 | 14 | CHAR(2) | WDFFFFLG | File level flag. | |
| 20 | 14 | 0 | BIT(1) | * | Reserved. |
| 20 | 14 | 1 | BIT(1) | WDFFGRPH | If on, the file contains at least one field with a graphic (G) data type. |
| 20 | 14 | 2 | BIT(14) | * | Reserved. |
| 22 | 16 | CHAR(12) | * | Reserved. | |
| 34 | 22 | BIN(15) | WDFFXDOF | Displacement to display-file-level device-dependent section from structure QDFFINFO (see structure QDFFDPDD, Display-File-Level Device-Dependent Section (QDFFDPDD)). | |
Display-File-Level Device-Dependent Section (QDFFDPDD)
Display device dependent section. The displacement to this structure from the beginning of structure QDFFINFO is at variable WDFFXDOF in QDFFINFO.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(8) | * | Reserved. | |
| 8 | 8 | CHAR(2) | WDFFFKWD | Miscellaneous keyword indicator. | |
| 8 | 8 | 0 | BIT(1) | WDFFOPEN | If on, OPENPRT keyword specified in file. |
| 8 | 8 | 1 | BIT(1) | WDFFCLRL | If on, CLRL keyword specified in some record format in this file. |
| 8 | 8 | 2 | BIT(1) | WDFFFICV | If on, IGCCNV keyword specified in file.
Note: The IGCCNV keyword generates additional internal records (*IGCFMT). |
| 8 | 8 | 3 | BIT(1) | WDFFAGPH | If on, ALWGPH keyword specified on at least one record format in file. |
| 8 | 8 | 4 | BIT(1) | WDFFXHRD | If on, file-level HLPRCD keyword is specified. |
| 8 | 8 | 5 | BIT(1) | WDFFUDMT | If on, USRDSPMGT keyword is specified. |
| 8 | 8 | 6 | BIT(1) | WDFFPRPG | If on, PRINT(*PGM) keyword is specified. |
| 8 | 8 | 7 | BIT(1) | WDFFHSIO | If on, file-level HLPSCHIDX keyword is specified. |
| 9 | 9 | 0 | BIT(1) | WDFFXHTL | If on, file-level HLPTITLE keyword is specified. |
| 9 | 9 | 1 | BIT(1) | WDFFXUIM | If on, file-level HLPPNLGRP keyword is specified. |
| 9 | 9 | 2 | BIT(1) | WDFFXHDC | If on, file-level HLPDOC keyword is specified. |
| 9 | 9 | 3 | BIT(1) | * | Reserved. |
| 9 | 9 | 4 | BIT(1) | WDFFALTN | If on, at least one ALTNAME keyword is specified in file. |
| 9 | 9 | 5 | BIT(1) | WDFFHFUL | If on, HLPFULL keyword is specified in file. |
| 9 | 9 | 6 | BIT(1) | WDFFESFL | If on, ERRSFL keyword is specified in file.
Note: The ERRSFL keyword generates additional internal records (*ERRSFL). |
| 9 | 9 | 7 | BIT(1) | WDFFWDW | If on, WINDOW keyword is specified in file. |
| 10 | A | CHAR(2) | * | Reserved. | |
| 12 | C | CHAR(1) | WDFFSHB1 | Start-of-header (SOH) bits. | |
| 12 | C | 0 | BIT(1) | WDFFSHCS | If on, CHECK(RLTB) keyword is specified. |
| 12 | C | 1 | BIT(1) | * | Reserved. |
| 12 | C | 2 | BIT(1) | WDFFAUTO | If on, DSPRL keyword is specified. |
| 12 | C | 3 | BIT(5) | * | Reserved. |
| 13 | D | CHAR(2) | * | Reserved. | |
| 15 | F | CHAR(1) | WDFFSHRA | Row address of the message line for primary display size. | |
| 16 | 10 | CHAR(1) | WDFFCKY1 | File-level CA keys 17 through 24. | |
| 16 | 10 | 0 | BIT(1) | WDFFCK24 | If on, CA key 24 is specified. |
| 16 | 10 | 1 | BIT(1) | WDFFCK23 | If on, CA key 23 is specified. |
| 16 | 10 | 2 | BIT(1) | WDFFCK22 | If on, CA key 22 is specified. |
| 16 | 10 | 3 | BIT(1) | WDFFCK21 | If on, CA key 21 is specified. |
| 16 | 10 | 4 | BIT(1) | WDFFCK20 | If on, CA key 20 is specified. |
| 16 | 10 | 5 | BIT(1) | WDFFCK19 | If on, CA key 19 is specified. |
| 16 | 10 | 6 | BIT(1) | WDFFCK18 | If on, CA key 18 is specified. |
| 16 | 10 | 7 | BIT(1) | WDFFCK17 | If on, CA key 17 is specified. |
| 17 | 11 | CHAR(1) | WDFFCKY2 | File-level CA keys 9 through 16. | |
| 17 | 11 | 0 | BIT(1) | WDFFCK16 | If on, CA key 16 is specified. |
| 17 | 11 | 1 | BIT(1) | WDFFCK15 | If on, CA key 15 is specified. |
| 17 | 11 | 2 | BIT(1) | WDFFCK14 | If on, CA key 14 is specified. |
| 17 | 11 | 3 | BIT(1) | WDFFCK13 | If on, CA key 13 is specified. |
| 17 | 11 | 4 | BIT(1) | WDFFCK12 | If on, CA key 12 is specified. |
| 17 | 11 | 5 | BIT(1) | WDFFCK11 | If on, CA key 11 is specified. |
| 17 | 11 | 6 | BIT(1) | WDFFCK10 | If on, CA key 10 is specified. |
| 17 | 11 | 7 | BIT(1) | WDFFCK9 | If on, CA key 9 is specified. |
| 18 | 12 | CHAR(1) | WDFFCKY3 | File-level CA keys 1 through 8. | |
| 18 | 12 | 0 | BIT(1) | WDFFCK8 | If on, CA key 8 is specified. |
| 18 | 12 | 1 | BIT(1) | WDFFCK7 | If on, CA key 7 is specified. |
| 18 | 12 | 2 | BIT(1) | WDFFCK6 | If on, CA key 6 is specified. |
| 18 | 12 | 3 | BIT(1) | WDFFCK5 | If on, CA key 5 is specified. |
| 18 | 12 | 4 | BIT(1) | WDFFCK4 | If on, CA key 4 is specified. |
| 18 | 12 | 5 | BIT(1) | WDFFCK3 | If on, CA key 3 is specified. |
| 18 | 12 | 6 | BIT(1) | WDFFCK2 | If on, CA key 2 is specified. |
| 18 | 12 | 7 | BIT(1) | WDFFCK1 | If on, CA key 1 is specified. |
| 19 | 13 | CHAR(1) | WDFFMKWD | Miscellaneous keyword indicators. | |
| 19 | 13 | 0 | BIT(1) | WDFFBRDR | If on, file-level WDWBORDER keyword is specified. |
| 19 | 13 | 1 | BIT(1) | * | Reserved. |
| 19 | 13 | 2 | BIT(1) | WDFFRTCR | If on, RTNCSRLOC keyword is specified. |
| 19 | 13 | 3 | BIT(1) | WDFFFFCP | If on, FLDCSRPRG keyword is specified. |
| 19 | 13 | 4 | BIT(1) | WDFFDSPP | If on, DSPATR program-to-system field is specified in file. |
| 19 | 13 | 5 | BIT(1) | WDFFHBKS | If on, HLPSHELF keyword is specified in file. |
| 19 | 13 | 6 | BIT(1) | WDFFINLYF | If on, CSRINPONLY keyword is specified in file. |
| 19 | 13 | 7 | BIT(1) | WDFFDBCSCNFLD | If on, CNTFLD keyword is used on a DBCS field in the file. |
| 20 | 14 | CHAR(1) | WDFFMKW2 | More miscellaneous keywords. | |
| 20 | 14 | 0 | BIT(1) | WDFFHTML | If on, the HTML keyword was specified in the file. |
| 20 | 14 | 1 | BIT(7) | * | Reserved. |
| 21 | 15 | CHAR(3) | * | Reserved. | |
| 24 | 18 | BIN(15) | WDFFXDOC | Displacement to keyword category displacement string from structure QDFFINFO (see structure QDFFCOSA, Keyword Category Displacement String (QDFFCOSA)). 0, if no file keyword categories. | |
Record Format Table (QDFARFTE)
Record format table array. The number of entries in this structure is defined by variable WDFFRCS in structure QDFFBASE. The displacement to this structure from the beginning of structure QDFFINFO is at variable WDFFDFLO in QDFFINFO. The structure is ARRAY(*).
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(10) | WDFARFNM | Record format name. Names that begin with * are internally generated record formats. | |
| 10 | A | BIN(15) | WDFARCND | Miscellaneous record contents. | |
| 10 | A | 0 | BIT(1) | WDFFRECD | If on, RECID keyword specified on this format. |
| 10 | A | 1 | BIT(15) | * | Reserved. |
| 12 | C | BIN(31) | WDFARFOF | Displacement to the record header section (see structure QDFFRINF, Record Header Section (QDFFRINF)) from structure QDFFINFO. | |
Sequence Number Table (QDFFSEQT)
Sequence number table. The number of entries in this structure is defined by variable WDFFRCS in structure QDFFBASE. The displacement to this structure from the beginning of structure QDFFINFO is at variable WDFFSEQO in QDFFINFO. The structure is ARRAY(*).
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(13) | WDFFSEQ | Level-check number for format. There is a one-to-one correspondence between this array and the entries in the record format table. | |
| 13 | D | CHAR(3) | * | Reserved. | |
Record Formats
Record Header Section shows the record section of the overview figure (DSPF0100 Format).
Record Header Section
Record Header Section (QDFFRINF)
Record header section. The displacement to this structure from the beginning of structure QDFFINFO is at variable WDFARFOF in structure QDFARFTE.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(31) | WDFFRDDO | Length of the record header section. This length includes the device-dependent sections (that is, it is the displacement to structure QDFFFINF for the first field in that record format). | |
| 4 | 4 | BIN(31) | WDFFOFIT | The displacement from structure QDFFRINF to the field indexing table defined by structure QDFFFITB (see Field Indexing Table (QDFFFITB)). | |
| 8 | 8 | BIN(31) | WDFFSTBO | The displacement from structure QDFFRINF to the selection table defined by structure QDFFSELT (see Selection Table (QDFFSELT)). 0, if no selection table present. | |
| 12 | C | BIN(31) | WDFFRFLG | Miscellaneous record contents. | |
| 12 | C | 0 | BIT(1) | WDFFUDDS | If on, USRDFN keyword is specified. |
| 12 | C | 1 | BIT(1) | WDFFSFL | If on, SFL keyword is specified (next record is SFLCTL). |
| 12 | C | 2 | BIT(1) | WDFFSFLC | If on, SFLCTL keyword is specified (previous record is SFL). |
| 12 | C | 3 | BIT(1) | WDFFMSGR | If on, SFLMSGRCD keyword is specified. |
| 12 | C | 4 | BIT(1) | WDFFRICV | If on, IGCCNV record is specified.
Note: The IGCCNV keyword generates additional internal records. |
| 12 | C | 5 | BIT(3) | * | Reserved. |
| 13 | D | 0 | BIT(1) | WDFFALLH | If on, all fields in format are hidden. |
| 13 | D | 1 | BIT(1) | * | Reserved. |
| 13 | D | 2 | BIT(1) | WDFFREXC | If on, DBCS data that can be processed is specified in record. This occurs when the O, J, or E data type is specified; when DBCS literals are specified on a DFT, DFTVAL, SFLMSG, RECID, ERRMSG, or RTGCON keyword. |
| 13 | D | 3 | BIT(1) | WDFFRIDV | If on, format requires a DBCS device. |
| 13 | D | 4 | BIT(1) | WDFFREXT | If on, extractable DBCS data is in format. |
| 13 | D | 5 | BIT(1) | WDFFRALT | If on, at least one field in format was specified as IGCALTTYP. |
| 13 | D | 6 | BIT(1) | WDFFMEMF | If on, CHECK(ME) or CHECK(MF) specified in at least one field in record. |
| 13 | D | 7 | BIT(1) | WDFFNDLC | If on, ALWENDLOC keyword is specified in record. |
| 14 | E | 0 | BIT(1) | WDFFRGPH | If on, graphic fields are specified in record. |
| 14 | E | 1 | BIT(1) | WDFFRCL | If on, RTNCSRLOC keyword is specified in record. |
| 14 | E | 2 | BIT(1) | WDFFMBAR | If on, MNUBAR keyword is specified in record. |
| 14 | E | 3 | BIT(1) | WDFFPULL | If on, PULLDOWN keyword is specified in record. |
| 14 | E | 4 | BIT(1) | WDFFPLSI | Selection indicators on PULLDOWN keyword. 0 is defined as *NOSLTIND; 1 is defined as *SLTIND (default). |
| 14 | E | 5 | BIT(1) | WDFFFCPF | If on, FLDCSRPRG specified on field in record. |
| 14 | E | 6 | BIT(1) | WDFFCNTMCFFLD | If on, CNTFLD, MLTCHCFLD, or SNGCHCFLD keyword is specified on a field within this record. |
| 14 | E | 7 | BIT(1) | WDFFEDTMSK | If on, EDTMSK keyword is specified in record. |
| 15 | F | 0 | BIT(1) | WDFFGRIDREC | If on, GRDRCD keyword is specified in record. |
| 15 | F | 1 | BIT(7) | * | Reserved. |
| 16 | 10 | BIN(15) | WDFFFLD | Number of fields in this record. | |
| 18 | 12 | CHAR(4) | * | Reserved. | |
| 22 | 16 | BIN(15) | WDFFINDO | If INDARA keyword is specified and response indicators are in this record, this is the displacement from structure QDFFRINF to the response indicator keyword array (see structure QDFKMSCP, Response Indicator Keyword Array (QDFKMSCP)) in category 4. 0 means the INDARA keyword is not specified or if INDARA is specified, there are no response indicators. | |
| 24 | 18 | CHAR(4) | * | Reserved. | |
| 28 | 1C | BIN(15) | WDFFRAOF | Displacements to display-record-level device-dependent section and subfile control record from structure QDFFRINF (see structures QDFFRDPD, Display-Record-Level Device-Dependent Section (QDFFRDPD), and QDFFSFCR, Subfile Control Record (QDFFSFCR)). | |
Display-Record-Level Device-Dependent Section (QDFFRDPD)
Display device-dependent section for nonsubfile records. Structure QDFFSFCR (Subfile Control Record (QDFFSFCR)) is used when subfiles are specified. The displacement to this structure from the beginning of structure QDFFRINF is an entry in the table at variable WDFFRAOF in QDFFRINF.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(31) | WDFFDRCO | Displacement to first row-column table (QDFFRCTB) from structure QDFFRINF. One row-column table exists for each display size (see variable WDFFSCR in structure QDFFBASE). The following may be used to access the correct table: let n = index into screen size array QDFFSCRA. (WDFFDRCO + (n - 1) * (WDFFFLD * LENGTH(WDFFRC)) + LENGTH(WDFFFRTO) ) from QDFFRINF. | |
| 4 | 4 | BIN(15) | WDFFINCP | Number of input-capable fields (that is, total input, both, and hidden). | |
| 6 | 6 | BIN(15) | WDFFIBF | Number of input and both fields. | |
| 8 | 8 | BIN(15) | WDFFOIS | Number of option indicators. | |
| 10 | A | CHAR(2) | * | Reserved. | |
| 12 | C | CHAR(4) | WDFACKYS | Indicates if a CA or CF key is specified. To determine which key (CA or CF) is specified, check the corresponding WDFFCKnn bit in structure QDFFDPDD (see Display-File-Level Device-Dependent Section (QDFFDPDD)). | |
| 12 | C | CHAR(1) | WDFACKY1 | Keys 1 through 8 without option indicators. | |
| 12 | C | 0 | BIT(1) | WDFACK1 | If on, CA/CF key 1 is specified. |
| 12 | C | 1 | BIT(1) | WDFACK2 | If on, CA/CF key 2 is specified. |
| 12 | C | 2 | BIT(1) | WDFACK3 | If on, CA/CF key 3 is specified. |
| 12 | C | 3 | BIT(1) | WDFACK4 | If on, CA/CF key 4 is specified. |
| 12 | C | 4 | BIT(1) | WDFACK5 | If on, CA/CF key 5 is specified. |
| 12 | C | 5 | BIT(1) | WDFACK6 | If on, CA/CF key 6 is specified. |
| 12 | C | 6 | BIT(1) | WDFACK7 | If on, CA/CF key 7 is specified. |
| 12 | C | 7 | BIT(1) | WDFACK8 | If on, CA/CF key 8 is specified. |
| 13 | D | CHAR(1) | WDFACKY2 | Keys 9 through 16 without option indicators. | |
| 13 | D | 0 | BIT(1) | WDFACK9 | If on, CA/CF key 9 is specified. |
| 13 | D | 1 | BIT(1) | WDFACK10 | if on, CA/CF key 10 is specified. |
| 13 | D | 2 | BIT(1) | WDFACK11 | If on, CA/CF key 11 is specified. |
| 13 | D | 3 | BIT(1) | WDFACK12 | If on, CA/CF key 12 is specified. |
| 13 | D | 4 | BIT(1) | WDFACK13 | If on, CA/CF key 13 is specified. |
| 13 | D | 5 | BIT(1) | WDFACK14 | If on, CA/CF key 14 is specified. |
| 13 | D | 6 | BIT(1) | WDFACK15 | If on, CA/CF key 15 is specified. |
| 13 | D | 7 | BIT(1) | WDFACK16 | If on, CA/CF key 16 is specified. |
| 14 | E | CHAR(1) | WDFACKY3 | Keys 17 through 24 without option indicators. | |
| 14 | E | 0 | BIT(1) | WDFACK17 | If on, CA/CF key 17 is specified. |
| 14 | E | 1 | BIT(1) | WDFACK18 | If on, CA/CF key 18 is specified. |
| 14 | E | 2 | BIT(1) | WDFACK19 | If on, CA/CF key 19 is specified. |
| 14 | E | 3 | BIT(1) | WDFACK20 | If on, CA/CF key 20 is specified. |
| 14 | E | 4 | BIT(1) | WDFACK21 | If on, CA/CF key 21 is specified. |
| 14 | E | 5 | BIT(1) | WDFACK22 | If on, CA/CF key 22 is specified. |
| 14 | E | 6 | BIT(1) | WDFACK23 | If on, CA/CF key 23 is specified. |
| 14 | E | 7 | BIT(1) | WDFACK24 | If on, CA/CF key 24 is specified. |
| 15 | F | CHAR(1) | WDFFCMDK | Other command keys without option indicators. | |
| 15 | F | 0 | BIT(1) | WDFFRLUP | If on, ROLLUP keyword is specified. |
| 15 | F | 1 | BIT(1) | WDFFRLDN | If on, ROLLDOWN keyword is specified. |
| 15 | F | 2 | BIT(1) | WDFFPRNT | If on, PRINT keyword is specified. |
| 15 | F | 3 | BIT(1) | WDFFHOME | If on, HOME keyword is specified. |
| 15 | F | 4 | BIT(1) | WDFFCLR | If on, CLEAR keyword is specified. |
| 15 | F | 5 | BIT(1) | WDFFHELP | If on, HELP keyword is specified. |
| 15 | F | 6 | BIT(2) | * | Reserved. |
| 16 | 10 | CHAR(2) | WDFFPUTK | Miscellaneous PUT conditions. | |
| 16 | 10 | 0 | BIT(1) | WDFFFSEL | If on, field selection. |
| 16 | 10 | 1 | BIT(1) | WDFFPUTR | If on, PUTRETAIN keyword is specified on some fields for this format. |
| 16 | 10 | 2 | BIT(1) | WDFFVSLN | If on, SLNO(*VAR) keyword is specified. |
| 16 | 10 | 3 | BIT(1) | WDFFALRL | If on, ALWROL keyword is specified. |
| 16 | 10 | 4 | BIT(1) | WDFFNOCO | Currently set for records containing floating point fields or DBCS data that requires a DBCS device (refer to WDFFRIDV). |
| 16 | 10 | 5 | BIT(1) | WDFFALGP | If on, unconditioned ALWGPH keyword is specified. |
| 16 | 10 | 6 | BIT(1) | WDFFRDMD | If on, DSPMOD keyword is specified. |
| 16 | 10 | 7 | BIT(1) | WDFFRMID | If on, MSGID keyword is specified on field in record. |
| 17 | 11 | 0 | BIT(1) | WDFFRKEY | If on, RETKEY keyword is specified. |
| 17 | 11 | 1 | BIT(1) | WDFFRCKY | If on, RETCMDKEY keyword is specified. |
| 17 | 11 | 2 | BIT(1) | WDFFRDVL | If on, DFTVAL keyword is specified on field. |
| 17 | 11 | 3 | BIT(1) | WDFFVSL1 | If on, SLNO(*VAR) keyword is specified and a field in row 1, column 1 is specified for at least one display size. |
| 17 | 11 | 4 | BIT(1) | WDFFMSGA | If on, unconditioned MSGALARM keyword is specified. |
| 17 | 11 | 5 | BIT(1) | WDFFRLST | If on, unconditioned RETLCKSTS keyword is specified. |
| 17 | 11 | 6 | BIT(1) | WDFFURDS | If on, unconditioned USRRSTDSP keyword is specified. |
| 17 | 11 | 7 | BIT(1) | WDFFRMVW | If on, unconditioned RMVWDW keyword is specified |
| 18 | 12 | CHAR(2) | WDFFGETK | Miscellaneous get conditions. | |
| 18 | 12 | 0 | BIT(1) | * | Reserved. |
| 18 | 12 | 1 | BIT(1) | WDFFLOGN | If on, LOGINP keyword is specified. |
| 18 | 12 | 2 | BIT(1) | WDFFINZR | If on, INZRCD keyword is specified. |
| 18 | 12 | 3 | BIT(1) | WDFFRTND | If on, RTNDTA keyword is specified. |
| 18 | 12 | 4 | BIT(1) | WDFFUNLK | If on, UNLOCK keyword is specified. |
| 18 | 12 | 5 | BIT(1) | WDFFRSET | If on, UNLOCK(*MDTOFF) keyword specified or UNLOCK keyword specified with GETRETAIN. |
| 18 | 12 | 6 | BIT(1) | WDFFEARS | If on, UNLOCK(*ERASE) keyword specified or UNLOCK keyword specified without GETRETAIN. |
| 18 | 12 | 7 | BIT(1) | WDFFASUM | If on, ASSUME keyword is specified. |
| 19 | 13 | 0 | BIT(1) | WDFFKEEP | If on, KEEP keyword is specified. |
| 19 | 13 | 1 | BIT(1) | * | Reserved. |
| 19 | 13 | 2 | BIT(1) | WDFFWDWR | If on, WINDOW keyword specified in record. |
| 19 | 13 | 3 | BIT(1) | WDFFQILE | If on, SFLPGMQ(276) keyword is specified. |
| 19 | 13 | 4 | BIT(1) | WDFFSFLCHCCTL | If on, SFLCHCCTL keyword is specified. |
| 19 | 13 | 5 | BIT(3) | * | Reserved. |
| 20 | 14 | BIN(15) | WDFFERRM | Index to first field in index table with either ERRMSG or ERRMSGID keyword. 0, if record has no field with either keyword. See structure QDFFFITB, Field Indexing Table (QDFFFITB). | |
| 22 | 16 | CHAR(1) | WDFFBITS | Miscellaneous flags. | |
| 22 | 16 | 0 | BIT(1) | WDFFERIN | If on, unconditioned ERASEINP(*MDTON) keyword is specified and ERASEINP(*ALL) is not specified. |
| 22 | 16 | 1 | BIT(1) | WDFFMDTO | If on, unconditioned MDTOFF(*UNPR) is specified and MDTOFF(*ALL) is not specified. |
| 22 | 16 | 2 | BIT(6) | * | Reserved. |
| 23 | 17 | CHAR(1) | WDFFBITF | Miscellaneous flags. | |
| 23 | 17 | 0 | BIT(2) | * | Reserved. |
| 23 | 17 | 2 | BIT(2) | WDFFBLKC | Blink flags. X'00' is defined as reserved; X'01' is defined as blink cursor and keyword BLINK unconditioned; X'10' is defined as reset blink cursor and no keyword BLINK; X'11' is defined as reserved. |
| 23 | 17 | 4 | BIT(1) | WDFFNOLK | If on, no unconditioned lock. 0 is defined as lock unconditioned (do not unlock keyboard); 1 is defined as no LOCK keyword or conditioned lock (unlock keyboard). |
| 23 | 17 | 5 | BIT(1) | WDFFALRM | If on, ALARM keyword unconditioned. |
| 23 | 17 | 6 | BIT(2) | * | Reserved. |
| 24 | 18 | BIN(15) | WDFFCGRI | Response indicator for record-level CHANGE keyword. For files with INDARA keyword, this is the response indicator minus 1. For those without INDARA keyword, this is the response indicator input buffer displacement. -1 shows keyword is not present. | |
| 26 | 1A | CHAR(2) | WDFFHFLG | Help flags. | |
| 26 | 1A | 0 | BIT(1) | WDFFHSEQ | If on, HLPSEQ keyword on record. |
| 26 | 1A | 1 | BIT(1) | WDFFHLP | If on, help specifications on record. |
| 26 | 1A | 2 | BIT(1) | WDFFNHLP | If on, record cannot be used as help text. It contains one of the keywords USRDFN, SFL, or SFLCTL. |
| 26 | 1A | 3 | BIT(1) | WDFFHRTN | If on, HLPRTN keyword on record. |
| 26 | 1A | 4 | BIT(1) | WDFFHTLE | If on, HLPTITLE keyword on record. |
| 26 | 1A | 5 | BIT(1) | WDFFHCLR | If on, HLPCLR keyword on record. |
| 26 | 1A | 6 | BIT(1) | WDFFCHNG | If on, no parameter for CHANGE keyword. |
| 26 | 1A | 7 | BIT(1) | WDFFRPGM | If on, PRINT keyword on record level with *PGM. |
| 27 | 1B | 0 | BIT(1) | WDFFHLPC | If on, HLPCMDKEY keyword on record. |
| 27 | 1B | 1 | BIT(1) | WDFFRSTCSR | If on, *RSTCSR parameter is specified on the PULLDOWN keyword on the record. |
| 27 | 1B | 2 | BIT(1) | WDFFINLY | If on, CSRINPONLY keyword is specified and is unoptioned. |
| 27 | 1B | 3 | BIT(1) | WDFFNOSEP | If on, *NOSEPARATOR parameter is specified on the MNUBAR keyword on this record. |
| 27 | 1B | 4 | BIT(4) | * | Reserved. |
| 28 | 1C | BIN(15) | WDFFXRDO | Displacement to display-record-level device-dependent extension structure from structure QDFFRINF (see structure QDFFXRDP, Display-Record-Level Device-Dependent Section Extension Structure (QDFFXRDP)). | |
| 30 | 1E | CHAR(2) | * | Reserved. | |
| 32 | 20 | BIN(15) | WDFFRDOC | Displacement to keyword category displacement string from structure QDFFRINF. (See structure QDFFCOSA, Keyword Category Displacement String (QDFFCOSA).) 0, if no keyword categories. | |
Display-Record-Level Device-Dependent Section Extension Structure (QDFFXRDP)
Extension structure. The displacement to this structure from the beginning of structure QDFFRINF is at variable WDFFXRDO in structure QDFFRDPD.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(31) | WDFFOTO | Displacement to field order table from structure QDFFRINF (see structure QDFFOT, Field Order Table (QDFFOT)). | |
| 4 | 4 | BIN(31) | WDFFNRCO | Displacement to first field name in row-column order table (see variable WDFFDRCO in structure QDFFRDPD. For every row-column table, there is a corresponding field name in row-column order in the field name table (see structure QDFFNTB, Field Name Table (QDFFNTB)). | |
| 8 | 8 | CHAR(4) | * | Reserved. | |
| 12 | C | BIN(15) | WDFFNUMOFSEGS | Number of segments in record for CNTFLD and EDTMSK. | |
| 14 | E | CHAR(2) | * | Reserved. | |
| 16 | 10 | BIN(15) | WDFFSFLCHCTLO | Buffer displacement to the field containing control for selection list. | |
| 18 | 12 | CHAR(6) | * | Reserved. | |
Subfile Control Record (QDFFSFCR)
Display device-dependent section for records specifying subfiles. This structure replaces structure QDFFRDPD when subfiles are specified (variable WDFFSFLC in structure QDFFRINF is set on. The displacement to this structure from the beginning of structure QDFFRINF is an entry in the table at variable WDFFRAOF in QDFFRINF.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(34) | WDFFSFLG | Display-record-level device-dependent section (structure QDFFRDPD, Display-Record-Level Device-Dependent Section (QDFFRDPD)) is mapped here. | |
| 34 | 22 | CHAR(1) | WDFFSFEN | Command key associated with SFLENTER keyword. X'00' indicates the keyword is not present. | |
| 35 | 23 | CHAR(1) | WDFFSFDR | Command key associated with SFLDROP or SFLFOLD keyword. X'00' indicates neither keyword is specified (see WDFFSFFD in this table). | |
| 36 | 24 | CHAR(1) | WDFFSFLFLG | Subfile flags. | |
| 36 | 24 | 0 | BIT(1) | WDFFSFLSNGCHC | If on, SFLSNGCHC keyword is specified. |
| 36 | 24 | 1 | BIT(1) | WDFFSFLMLTCHC | If on, SFLMLTCHC keyword is specified. |
| 36 | 24 | 2 | BIT(1) | WDFFSFLSELRSC | If on, *RSTCSR parameter is specified on SFLMLTCHC or SFLSNGCHC keyword. |
| 36 | 24 | 3 | BIT(1) | WDFFSFLSELSND | If on, *SLTIND parameter is specified on SFLMLTCHC or SFLSNGCHC keyword. |
| 36 | 24 | 4 | BIT(1) | WDFFSFLSELAST | If on, *AUTOSLT parameter is specified on SFLSNGCHC keyword. |
| 36 | 24 | 5 | BIT(1) | WDFFSFLSCRBAR | If on, SFLEND(*SCRBAR) keyword is specified. |
| 36 | 24 | 6 | BIT(1) | WDFFSFLRTNSEL | If on, SFLRTNSEL keyword is specified. |
| 36 | 24 | 7 | BIT(1) | WDFFSFLSCROLL | If on, SFLSCROLL keyword is specified. |
| 37 | 25 | CHAR(1) | WDFFSFST | Miscellaneous flags. | |
| 37 | 25 | 0 | BIT(1) | WDFFSFNA | If on, SFLRNA keyword is specified. |
| 37 | 25 | 1 | BIT(1) | WDFFSFCU | If on, SFLRCDNBR(CURSOR) keyword is specified. |
| 37 | 25 | 2 | BIT(1) | WDFFSFDM | If on, DSPMOD keyword is specified. |
| 37 | 25 | 3 | BIT(1) | WDFFSFFD | 0 indicates the initial display is fold; 1
indicates the initial display is drop. If WDFFSFDR equals X'00', there is no
SFLDROP or SFLFOLD keyword, and this value equals 0. If WDFFSFDR does not equal
X'00', either this value equals 0 (SFLFOLD) or 1 (SFLDROP).
Note: Also refer to comments for variable WDFFSFDR in this structure. |
| 37 | 25 | 4 | BIT(1) | WDFFSFFDI | 0 indicates that SFLDROP or SFLFOLD are not
optioned; use WDFFSFFD to determine which one to use. 1 indicates that SFLDROP
and SFLFOLD are optioned; use indicators.
Note: Also refer to comments for variable WDFFSFDR in this structure. |
| 37 | 25 | 5 | BIT(1) | WDFFSFEM | If on, SFLEND(*MORE) keyword is specified. |
| 37 | 25 | 6 | BIT(1) | WDFFSFLRCDtop | If on, SFLRCDNBR(*top) keyword is specified. |
| 37 | 25 | 7 | BIT(1) | WDFFSFLSELSTE | If on, *AUTOSLTENH parameter is specified on SFLSNGCHC keyword. |
| 38 | 26 | BIN(15) | WDFFSFPQ | Contains the value specified for the SFLPGMQ keyword. | |
| 40 | 28 | BIN(15) | WDFFSFVL | SFLROLVAL field length. 0 indicates that the keyword is not specified. | |
| 42 | 2A | BIN(15) | WDFFSFVO | Displacement in input buffer to SFLROLVAL. | |
| 44 | 2C | BIN(15) | WDFFSFFI | Index into field indexing table of field with SFLROLVAL. | |
| 46 | 2E | BIN(15) | WDFFSFL | SFLRCDNBR field length. 0 indicates that the keyword is not specified. | |
| 48 | 30 | BIN(15) | WDFFSFO | Displacement in output buffer to SFLRCDNBR. | |
| 50 | 32 | BIN(15) | WDFFSFLEXTOFF | Displacement to the QDFFSFCREXT extension structure (see Subfile Control Record Extension (QDFFSFCREXT)) from this structure. | |
| 52 | 34 | CHAR(1) | WDFFSFLNOFL | Miscellaneous bits. | |
| 52 | 34 | CHAR(1) | WDFFSFNOFL | Miscellaneous flags. | |
| 52 | 34 | 0 | BIT(1) | WDFFSFLSELNRS | If on, *NORSTCSR parameter is specified on SFLMLTCHC or SFLSNGCHC keyword. |
| 52 | 34 | 1 | BIT(1) | WDFFSFLSELNST | If on, *NOAUTOSLT parameter is specified on SFLSNGCHC keyword. |
| 52 | 34 | 2 | BIT(6) | * | Reserved |
| 53 | 35 | CHAR(1) | * | Reserved. | |
| 54 | 36 | CHAR(*) | WDFFSFPM | SFL parameter values (see structure QDFFSFHR, Subfile Control Entry (QDFFSFHR)). One entry is present for each specified display size (see WDFFSCRS in structure QDFFBASE). The order of this array is the same as structure QDFFSCRA (Screen Size Table (QDFFSCRA)). | |
Subfile Control Entry (QDFFSFHR)
Subfile control entry in the subfile control record. This structure is defined at variable WDFFSFPM in structure QDFFSFCR. The structure is ARRAY(*).
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFFSFSZ | SFLSIZ. | |
| 2 | 2 | BIN(15) | WDFFSFPG | SFLPAG. If this is a field selection subfile, this is the number of lines occupied by subfile. If this is a nonfield selection subfile, this is the maximum number of subfile records on the screen. | |
| 4 | 4 | CHAR(2) | * | Reserved. | |
| 6 | 6 | BIN(15) | WDFFSFT | Number of fields not dropped, that is, the number of fields on first line of SFL record with SFLDROP specified. | |
| 8 | 8 | BIN(15) | WDFFSFR1 | Subfile start row. | |
| 8 | 8 | CHAR(1) | * | Reserved. | |
| 9 | 9 | CHAR(1) | WDFFSFSR | Subfile start row. For SFLMSGRCD, this is line number. | |
| 10 | A | BIN(15) | WDFFSFR2 | Subfile end row. | |
| 10 | A | CHAR(1) | * | Reserved. | |
| 11 | B | CHAR(1) | WDFFSFER | Subfile end row. | |
| 12 | C | CHAR(4) | WDFFSFLN | Horizontal subfile (SFLLIN). 0 is defined as not horizontal subfile. | |
| 12 | C | BIN(15) | WDFFSFH1 | Number of horizontal records per line. | |
| 14 | E | BIN(15) | WDFFSFH2 | Number of characters from field 1, record n to field 1, record n+1. | |
| 16 | 10 | BIN(15) | WDFFSFF | Number of fields per record. | |
| 18 | 12 | CHAR(6) | * | Reserved. | |
Subfile Control Record Extension (QDFFSFCREXT)
Subfile control record extension entry in the subfile control record (see structure QDFFSFCR, Subfile Control Record (QDFFSFCR)). Variable WDFFSFLEXTOFF contains the displacement to this structure from structure QDFFSFCR.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFFSFLSCRLLO | Displacement to the field with the SFLSCROLL keyword. | |
| 2 | 2 | BIN(15) | WDFFSFLSIZSFO | Displacement to the field specified on the SFLSIZ keyword. -1 indicates a number was specified. | |
| 4 | 4 | BIN(15) | WDFFSFLSELOFF | Displacement to the field specified on the SFLMLTCHC keyword that is used to tell the application the number of selections made from the selection list. | |
| 6 | 6 | CHAR(1) | WDFFSFLSELCH1 | Primary character to be used to indicate a selection list item has been selected. | |
| 7 | 7 | CHAR(1) | WDFFSFLSELCH2 | Secondary character to be used to indicate a selection list item has been selected. | |
| 8 | 8 | CHAR(8) | * | Reserved. | |
Row-Column Table (QDFFRCTB)
Row-column table, one table per screen size. The displacement to this structure from the beginning of structure QDFFRINF is at variable WDFFDRCO in structure QDFFRDPD.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(1) | WDFFFRRO | From row of attribute of first field in format. | |
| 1 | 1 | CHAR(1) | WDFFFRCO | From column of attribute of first field in format. | |
| 2 | 2 | CHAR(1) | WDFFTORO | To row of last data character of last field in format (excluding trailing attribute). | |
| 3 | 3 | CHAR(1) | WDFFTOCO | To column of last data character of last field in format (excluding trailing attribute). | |
| 4 | 4 | CHAR(1) | WDFFRBIT | Miscellaneous flags. | |
| 4 | 4 | 0 | BIT(1) | WDFFMDF | Multiple defined fields (MDF) present for this screen size. MDF fields are defined to be a group of fields that have the same beginning row-column, and the first field in the group must have field selection. |
| 4 | 4 | 1 | BIT(1) | WDFFFRC1 | First field in the record has attribute in column 1 for this screen size. |
| 4 | 4 | 2 | BIT(1) | WDFFTRAT | If on, the trailing attribute for this screen size was in column one. |
| 4 | 4 | 3 | BIT(1) | WDFFR1C1 | First field in record begins in row 1, column 1 for this screen size. |
| 4 | 4 | 4 | BIT(1) | WDFFR2C1 | First field in record begins in row 2, column 1 for this screen size and the SLNO(nn) keyword. |
| 4 | 4 | 5 | BIT(3) | * | Reserved. |
| 5 | 5 | CHAR(1) | * | Reserved. | |
| 6 | 6 | CHAR(*) | WDFFRC | Row-column table, one entry per field (see structure QDFFRCTE, Row-Column Table Entry (QDFFRCTE)). | |
Row-Column Table Entry (QDFFRCTE)
Row-column table with one table entry per field. The number of entries in this structure is defined by variable WDFFFLD in structure QDFFRINF. This structure is defined at variable WDFFRC in structure QDFFRCTB. The structure is ARRAY(*).
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(1) | WDFFSROW | Starting row. X'FF' indicates that the location for the secondary display size was *NOLOC, or was a hidden field, a program field, or a message line. | |
| 1 | 1 | CHAR(1) | WDFFSCOL | Starting column. X'FF' indicates that the location for the secondary display size was *NOLOC, or was a hidden field, a program field, or a message line. | |
Field Name Table (QDFFNTB)
Field name table with one field name entry per field. This structure is present when the RTNCSRLOC keyword is specified in the DDS. The number of entries in this structure is defined by variable WDFFFLD in structure QDFFRINF. The displacement to this structure from the beginning of structure QDFFRINF is at variable WDFFNRCO in structure QDFFXRDP. The structure is ARRAY(*).
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(10) | WDFFNAM | Field name entry. | |
Field Order Table (QDFFOT)
Field order table with one field order entry per field. This structure is present when the USRDFNMGT keyword is specified in the DDS. The number of entries in this structure is defined by variable WDFFFLD in structure QDFFRINF. The displacement to this structure from the beginning of structure QDFFRINF is at variable WDFFOTO in structure QDFFXRDP. The structure is ARRAY(*).
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFFLD | Order of field in DDS source. | |
Field Indexing Table (QDFFFITB)
Field indexing table. The number of entries in this structure is defined by variable WDFFFLD. The displacement to this structure from the beginning of structure QDFFRINF is at variable WDFFOFIT in QDFFRINF. The structure is ARRAY(*).
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(31) | WDFFFOFS | Displacement from the record header (structure QDFFRINF) to this field's header section (see structure QDFFFINF, Field Header Section (QDFFFINF)). | |
| 4 | 4 | BIN(15) | WDFFSELI | Index to the entry in the selection table (see variable WDFFSTE in structure QDFFSELT) for the condition selecting this field. 1 represents no field selection. | |
| 6 | 6 | BIN(15) | WDFFDLEN | Display length. Edited field length and UCS-2 displayed field length. For floating point edited fields, this value is the significand plus 7. For nonfloating-point edited fields when the FLTFIXDEC keyword is specified, this value is the length specified for the field plus 2. When the FLTFIXDEC keyword is not specified, this value is 7 plus the length specified for the field. | |
Field Formats
Field Header Section shows the field section of the overview figure (DSPF0100 Format).
Field Header Section
Field Header Section (QDFFFINF)
Field header declare. The displacement to this structure from the beginning of structure QDFFRINF is at variable WDFFFOFS in structure QDFFFITB.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFFFLEN | Length of this declare, including all the device-dependent sections. | |
| 2 | 2 | CHAR(1) | WDFFFIOA | Field attribute. X'01' indicates Constant (see structure QDFFFCON, Constant Field Header Table (QDFFFCON)), X'02' indicates Output (O), X'03' indicates Message (M), X'04' indicates Input (I), X'05' indicates Both (B), X'06' indicates Hidden (H), and X'07' indicates Program to System (P). | |
| 3 | 3 | CHAR(1) | WDFFBFLG | Miscellaneous flags. | |
| 3 | 3 | 0 | BIT(1) | WDFFDATE | If on, DATE keyword is specified. |
| 3 | 3 | 1 | BIT(1) | WDFFDATY | If on, DATEY keyword is specified. |
| 3 | 3 | 2 | BIT(1) | WDFFTIME | If on, TIME keyword is specified. |
| 3 | 3 | 3 | BIT(1) | WDFFFOLD | If on, BLKFOLD keyword is specified. |
| 3 | 3 | 4 | BIT(1) | WDFFEDIT | If on, EDTCDE or EDTWRD keyword is specified. |
| 3 | 3 | 5 | BIT(1) | WDFFINBT | If on, field is either input or both. |
| 3 | 3 | 6 | BIT(1) | WDFFDFT | If on, DFT or DFTVAL keyword is specified. |
| 3 | 3 | 7 | BIT(1) | WDFFFALT | If on, IGCALTTYP keyword is specified. |
| 4 | 4 | CHAR(1) | WDFFFBIT | Miscellaneous flags. | |
| 4 | 4 | 0 | BIT(1) | WDFFIGCC | If on, DBCS literals are specified on DFT or DFTVAL keyword. |
| 4 | 4 | 1 | BIT(1) | WDFFFCSO | If on, first character of DFT or DFTVAL keyword is shift out (SO). |
| 4 | 4 | 2 | BIT(1) | WDFFOPDV | If on, optioned DFTVAL keyword is specified. |
| 4 | 4 | 3 | BIT(1) | WDFFALWE | If on, ALWENDLOC applies to field. Trailing attribute byte should be truncated for at least one display size. |
| 4 | 4 | 4 | BIT(1) | WDFFUSER | If on, USER keyword is specified. |
| 4 | 4 | 5 | BIT(1) | WDFFSYSN | If on, SYSNAME keyword is specified. |
| 4 | 4 | 6 | BIT(1) | WDFFEDFT | If on, EDTWRD was generated due to the DATE or TIME keyword, or due to the L, T, or Z edit code. |
| 4 | 4 | 7 | BIT(1) | WDFF_EDTCDE_Y | If on, the edit code specified on the EDTCDE keyword is used for formatting dates. The edit code is either a W or a Y. |
| 5 | 5 | CHAR(1) | * | Reserved. | |
| 6 | 6 | CHAR(*) | WDFFFTBE | Field header table entries. Use structure QDFFFCON (Constant Field Header Table (QDFFFCON)) for constant fields and structure QDFFFNAM (Named Field Header Table (QDFFFNAM)) for named fields. | |
Constant Field Header Table (QDFFFCON)
Field header declare for constant fields. This structure is defined at variable WDFFFTBE in structure QDFFFINF.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(2) | * | Reserved. | |
| 2 | 2 | BIN(15) | WDFFFAOC | Displacement for constant fields to field-level device-dependent sections (structure QDFFFDPD, Display-Field-Level Device-Dependent Section (QDFFFDPD)) from structure QDFFFINF (Field Header Section (QDFFFINF)). | |
Named Field Header Table (QDFFFNAM)
Field header declare for named fields. This structure is defined at variable WDFFFTBE in structure QDFFFINF.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFFINPO | Input buffer displacement. -1 indicates no buffer location. | |
| 2 | 2 | BIN(15) | WDFFOUTO | Output buffer displacement. -1 indicates no buffer location. | |
| 4 | 4 | BIN(15) | WDFFPLEN | Program length. User's program field length for floating point fields indicates precision 4 is defined as *SINGLE; 8 is defined as *DOUBLE. | |
| 6 | 6 | CHAR(1) | WDFFDEC | Decimals (X'00' through X'1F'). X'FF' indicates field is character or DBCS-capable. | |
| 7 | 7 | CHAR(1) | WDFFKBDT | Keyboard shift and data type. X'00' indicates Alpha shift/character (A), X'01' indicates Alpha only (X), X'02' indicates Numeric shift (N), X'03' indicates Numeric only (Y), X'04' indicates Katakana (K), X'05' indicates Digits only (D), X'06' indicates Inhibit keyboard (I), X'07' indicates Signed numeric/zoned (S), X'08' indicates Binary (B), X'09' indicates Packed (P), X'0A' indicates Floating (F), X'0B' indicates DBCS (J), X'0C' indicates Open (O), X'0D' indicates Either (E), X'0E' indicates Numeric-only character (M), X'0F' indicates Graphic (G), X'10' indicates Date (L), X'11' indicates Time (T), and X'12' indicates Timestamp (Z). | |
| 8 | 8 | CHAR(2) | * | Reserved. | |
| 10 | A | BIN(15) | WDFFFAOF | Displacement for nonconstant (named) fields to display-field-level device-dependent section (structure QDFFFDPD, Display-Field-Level Device-Dependent Section (QDFFFDPD)) from structure QDFFFINF (Field Header Section (QDFFFINF)). | |
Display-Field-Level Device-Dependent Section (QDFFFDPD)
Display device-dependent section. The displacement to this structure from the beginning of structure QDFFFINF is an entry in the table at variable WDFFFAOF in structure QDFFFNAM.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(1) | WDFFFLGS | Miscellaneous flags. | |
| 0 | 0 | 0 | BIT(1) | WDFFDSPC | If on, unconditioned DSPATR(PC) keyword is specified. |
| 0 | 0 | 1 | BIT(1) | WDFFUCND | If on, unconditioned DSPATR(ND) keyword is specified. |
| 0 | 0 | 2 | BIT(1) | WDFFFXDC | If on, FLTFIXDEC keyword is specified. |
| 0 | 0 | 3 | BIT(1) | WDFFIACV | If on, IGCANKCNV keyword is specified. |
| 0 | 0 | 4 | BIT(1) | WDFFCSCP | If on, CHRID keyword is specified. |
| 0 | 0 | 5 | BIT(1) | WDFFMGID | If on, MSGID keyword is specified. |
| 0 | 0 | 6 | BIT(1) | WDFFDPNR | If on, DUP keyword is specified without a response indicator on a numeric field. |
| 0 | 0 | 7 | BIT(1) | WDFFDSPN | Field's base cursor position. If on, the field is input-capable and no unoptioned DSPATR(PR) or no unoptioned DSPATR(PC) is in any field in the record. |
| 1 | 1 | CHAR(1) | WDFFSA | Default screen attribute byte for workstation. | |
| 1 | 1 | 0 | BIT(3) | * | Reserved. Always B'001'. |
| 1 | 1 | 3 | BIT(1) | WDFFCLOS | If on, unconditioned DSPATR(CS) keyword is specified. |
| 1 | 1 | 4 | BIT(1) | WDFFBLNK | If on, unconditioned DSPATR(BL) keyword is specified. |
| Note: If the following three bits are on, unconditioned DSPATR(ND) is specified. | |||||
| 1 | 1 | 5 | BIT(1) | WDFFUDLN | If on, unconditioned DSPATR(UL) keyword is specified. |
| 1 | 1 | 6 | BIT(1) | WDFFHILI | If on, unconditioned DSPATR(HI) keyword is specified. |
| 1 | 1 | 7 | BIT(1) | WDFFRVIM | If on, unconditioned DSPATR(RI) keyword is specified. |
| 2 | 2 | BIN(15) | WDFFXFDO | Displacement to field-dependent extension structure from QDFFFINF (see structure QDFFXFDP, Field-Dependent Extension Structure (QDFFXFDP)). 0 indicates no extension structure is present. | |
| 4 | 4 | BIN(15) | WDFFFDOC | Displacement to keyword category displacement string from structure QDFFFINF (see structure QDFFCOSA, Keyword Category Displacement String (QDFFCOSA)). 0, if no keyword categories. | |
| 6 | 6 | CHAR(*) | WDFFFICE | Input-capable display field-level device-dependent section entries (see structure QDFFFDIC, Input-Capable Display Field-Level Device-Dependent Section (QDFFFDIC)). Only used for types X'04' (input) and X'05' (both); see variable WDFFFIOA in structure QDFFFINF. | |
Input-Capable Display Field-Level Device-Dependent Section (QDFFFDIC)
Input-capable display device-dependent section. This structure is used for types X'04' (input) and X'05' (both); see variable WDFFFIOA in structure QDFFFINF. This structure is defined at variable WDFFFICE ) in structure QDFFFDPD.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(2) | WDFFFWFW | Miscellaneous flags. | |
| 0 | 0 | 0 | BIT(2) | * | Reserved. |
| 0 | 0 | 2 | BIT(1) | WDFFFWPR | If on, unconditioned DSPATR(PR) keyword is specified. |
| 0 | 0 | 3 | BIT(1) | WDFFFWDP | If on, unconditioned DUP keyword is specified. |
| 0 | 0 | 4 | BIT(1) | WDFFFWMD | If on, unconditioned DSPATR(MDT) keyword is specified. |
| 0 | 0 | 5 | BIT(3) | WDFFFWSF | Keyboard shift. B'000' indicates alpha shift, B'001' indicates alpha only, B'010' indicates numeric shift (also floating point), B'011' indicates numeric only (also numeric-only character keyboard shift), B'100' indicates Katakana/CHECK(RL), B'101' indicates digits only, B'110' indicates inhibit keyboard, B'111' indicates signed numeric. |
| 1 | 1 | 0 | BIT(1) | WDFFFWRA | If on, unconditioned AUTO(RA) keyword is specified. |
| 1 | 1 | 1 | BIT(1) | WDFFFWFE | If on, CHECK(FE) keyword is specified. |
| 1 | 1 | 2 | BIT(1) | WDFFFWLW | Lowercase (not monocase). 0 indicates lowercase; 1 indicates not lowercase (uppercase). |
| 1 | 1 | 3 | BIT(1) | * | Reserved. |
| 1 | 1 | 4 | BIT(1) | WDFFFWME | If on, unconditioned CHECK(ME) keyword is specified. |
| 1 | 1 | 5 | BIT(3) | WDFFFWAJ | Adjustments. B'000' indicates no adjustment, B'101' indicates AUTO(RAZ), B'110' indicates AUTO(RAB), B'111' indicates CHECK(MF). |
| 2 | 2 | CHAR(1) | WDFFSSKW | Keywords present. | |
| 2 | 2 | 0 | BIT(1) | WDFFBLKS | If on, BLANKS keyword is specified. |
| 2 | 2 | 1 | BIT(1) | WDFFSSCH | If on, CHANGE keyword is specified. |
| 2 | 2 | 2 | BIT(1) | WDFFSSDR | If on, DUP keyword is specified with a response indicator. |
| 2 | 2 | 3 | BIT(1) | WDFFSSDP | If on, DUP keyword is specified with or without a response indicator. |
| 2 | 2 | 4 | BIT(1) | WDFFSSAB | If on, CHECK(AB) keyword is specified. |
| 2 | 2 | 5 | BIT(1) | WDFFDSOD | If on, DSPATR(OID) keyword is specified. |
| 2 | 2 | 6 | BIT(1) | WDFFDSSP | If on, DSPATR(SP) keyword is specified. |
| 2 | 2 | 7 | BIT(1) | WDFFVLCK | If on, validity checking keywords specified in category 25, Category 25 (GET Validation Keywords) (that is, category 25 is present). |
| 3 | 3 | CHAR(1) | WDFFCHKB | Miscellaneous flags. | |
| 3 | 3 | 0 | BIT(1) | WDFFCM10 | If on, CHECK(M10) keyword is specified. |
| 3 | 3 | 1 | BIT(1) | WDFFCM11 | If on, CHECK(M11) keyword is specified. |
| 3 | 3 | 2 | BIT(1) | WDFFM10F | If on, CHECK(M10F) keyword is specified. |
| 3 | 3 | 3 | BIT(1) | WDFFM11F | If on, CHECK(M11F) keyword is specified. |
| 3 | 3 | 4 | BIT(4) | * | Reserved. |
Field-Dependent Extension Structure (QDFFXFDP)
Field-dependent extension structure. The displacement to this structure from the beginning of structure QDFFFINF is at variable WDFFXFDO in structure QDFFFDPD.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(2) | WDFFKFLG | Miscellaneous flag. | |
| 0 | 0 | 0 | BIT(1) | WDFFNOBA | If on, field has no beginning attribute. |
| 0 | 0 | 1 | BIT(1) | WDFFNOEA | If on, field has no ending attribute. |
| 0 | 0 | 2 | BIT(1) | * | Reserved. |
| 0 | 0 | 3 | BIT(1) | WDFFFDCP | If on, this field is referenced by another field using the FLDCSRPRG keyword. |
| 0 | 0 | 4 | BIT(1) | WDFFSFCP | If on, SFLCSRPRG keyword specified on field. |
| 0 | 0 | 5 | BIT(1) | WDFFMLTC | If on, MLTCHCFLD keyword is specified. |
| 0 | 0 | 6 | BIT(1) | WDFFSNGC | If on, SNGCHCFLD or PSHBTNFLD keyword is specified. |
| 0 | 0 | 7 | BIT(1) | WDFFCNTF | If on, CNTFLD keyword is specified. |
| 1 | 1 | 0 | BIT(1) | WDFFENFA | If on, ENTFLDATR keyword is specified. |
| 1 | 1 | 1 | BIT(1) | WDFFFCRP | If on, FLDCSRPRG keyword is specified. |
| 1 | 1 | 2 | BIT(1) | WDFFEDTM | If on, EDTMSK keyword is specified. |
| 1 | 1 | 3 | BIT(1) | WDFFPFLD | If on, field has associated program-to-system field. |
| 1 | 1 | 4 | BIT(1) | WDFFNOCC | If on, NOCCSID keyword is specified. |
| 1 | 1 | 5 | BIT(1) | WDFFPUSHBTN | If on, PSHBTNFLD keyword is specified. |
| 1 | 1 | 6 | BIT(1) | WDFFCHCHDHEXP | If on, structure QDFKCHC (CHCFLD Keyword Structure (QDFKCHC)) has an extension structure appended to it. |
| 1 | 1 | 7 | BIT(1) | WDFFWRDWRAP | If on, WRDWRAP keyword is specified. |
| 2 | 2 | BIN(15) | WDFFFLDINX | Field index of current field. | |
| 4 | 4 | CHAR(1) | WDFFXLFLGS | Miscellaneous flags. | |
| 4 | 4 | 0 | BIT(1) | WDFFVALNUM | If on, VALNUM keyword is specified. |
| 4 | 4 | 1 | BIT(1) | WDFFUCS2OF | If on, WDFF_UCS2_CCSID contains the output buffer offset where the CCSID is located. |
| 4 | 4 | 2 | BIT(6) | * | Reserved. |
| 5 | 5 | BIN(16) | WDFF_UCS2_ CCSID | The UCS-2 CCSID specified on the CCSID keyword. If WDFFUCS2OF is on, this is the output buffer offset where the CCSID is located. | |
| 7 | 7 | CHAR(1) | * | Reserved. | |
Selection Table (QDFFSELT)
Selection table. The table entries are defined in structure QDFFSTBL (page Selection Table Entry (QDFFSTBL)). The entries in the where-used section (Where-Used Formats) are stored in the same order as the selection table. The displacement to this structure from the beginning of structure QDFFRINF is at variable WDFFSTBO in structure QDFFRINF.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(31) | WDFFSTLN | Selection table length. | |
| 4 | 4 | BIN(15) | WDFFSTT | Total number of table entries used by the display to resolve record- and field-level selection entries. | |
| 6 | 6 | CHAR(2) | * | Reserved. | |
| 8 | 8 | CHAR(*) | WDFFSTE | Selection table entries (see structure QDFFSTBL, Selection Table Entry (QDFFSTBL)). | |
Selection Table Entry (QDFFSTBL)
Selection table entry. The number of entries in this structure is defined by variable WDFFSTT in structure QDFFSELT. This structure is defined at variable WDFFSTE in structure QDFFSELT. The structure is ARRAY(*).
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFFSTEL | Length of this table entry. | |
| 2 | 2 | BIN(15) | WDFFCND | Number of conditions in the entry. | |
| 4 | 4 | ARRAY(*) OF CHAR(1) | WDFFSELM | Array of selection table indicators. The number of entries in this structure is defined by variable WDFFCND in this table. Each character contains a displacement into the output buffer for an option indicator. An entry is used to designate whether the indicator must be on (X'F1') or off (X'F0'). If an entry is on, the indicator must be on; if it is off, the indicator must be off. The value X'7F' in this field designates the end of the entry. | |
Keyword Category Displacement String (QDFFCOSA)
Category displacement string. This structure occurs for each display file-, record-, or field-level section that has keyword structures. For file-level sections, the displacement to this structure is from the beginning of structure QDFFINFO at variable WDFFXDOC) in structure QDFFDPDD. For record-level sections, the displacement to this structure is from the beginning of structure QDFFRINF at variable WDFFRDOC ) in structure QDFFRDPD. For field-level sections, the displacement to this structure is from the beginning of structure QDFFFINF at variable WDFFFDOC) in structure QDFFFDPD.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFFCCT | Number of entries in the category displacement string. | |
| 2 | 2 | CHAR(*) | WDFFCCOS | Category displacement string (see structure QDFFCCOA, Keyword Category Displacement String Entry (QDFFCCOA)). | |
Keyword Category Displacement String Entry (QDFFCCOA)
Category displacement string array. Each keyword category type that is present in the file, record, or field section has an entry. The number of entries in this structure is defined by variable WDFFCCT in structure QDFFCOSA. This structure is defined at variable WDFFCCOS in structure QDFFCOSA. The structure is ARRAY(*).
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(1) | WDFFCAID | Category ID (X'01' through X'FF'). | |
| 1 | 1 | BIN(15) | WDFFCAOF | Displacement to category from the start of each section header (see structure QDFFINFO on File Header Section (QDFFINFO) for file-level keywords, structure QDFFRINF on Record Header Section (QDFFRINF) for record-level keywords, or structure QDFFFINF on Field Header Section (QDFFFINF) for field-level keywords). | |
Keyword Formats
Category 1 (File-Level Keywords)
The following table shows the keyword ID that corresponds to the file-level keywords. Not all keywords require a structure. There are no structures for keyword IDs X'01', X'03', and X'0D'. The text associated with the HLPTITLE keyword is contained in variable WDFKFLNM in structure QDFKFLPP.
| ID | Keyword | ID | Keyword |
|---|---|---|---|
| X'01' | PASSRCD | X'07' | HLPDOC |
| X'02' | MSGLOC | X'08' | HLPSCHIDX |
| X'03' | X'09' | HLPTITLE | |
| X'04' | IGCCNV | X'0A' | ALTNAME |
| X'05' | HLPRCD | X'0B' | ERRSFL |
| X'06' | HLPPNLGRP | X'0C' | WDWBORDER |
File-Level Keywords (QDFKFILK)
File-level keywords. The displacement to this structure from the beginning of the appropriate section (file, record, or field) is from variable WDFFCAOF in structure QDFFCCOA.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFKFIL | Number of keywords to follow. | |
| 0 | 0 | CHAR(*) | WDFKFILE | File-level keyword with parameters (see structure QDFKFLPM, File-Level Keyword with Parameters (QDFKFLPM)). | |
File-Level Keyword with Parameters (QDFKFLPM)
File-level keyword with parameters. The number of entries in this structure is defined by variable WDFKFIL in structure QDFKFILK. This structure is defined at variable WDFKFILE in structure QDFKFILK. The structure is ARRAY(*).
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(1) | WDFKFLID | Keyword ID. | |
| 1 | 1 | BIN(15) | WDFKFLST | Index into selection table (see structure QDFFSELT, Selection Table (QDFFSELT)). 1 indicates not optioned. | |
| 3 | 3 | BIN(15) | WDFKFLRS | Response indicator minus one for files with INDARA keyword. Response indicator input buffer displacement for those without INDARA keyword. In either case, -1 represents no response indicator specified. | |
| 5 | 5 | BIN(15) | WDFKFLP | Number of parameters to follow. | |
| 7 | 7 | CHAR(*) | WDFKFLEX | Category 1 keyword parameter entries. | |
Category 1 Parameter Entry (QDFKFLPP)
Parameter entries for category 1. The number of entries in this structure is defined by variable WDFKFLP in structure QDFKFLPM. This structure is defined at variable WDFKFLEX in structure QDFKFLPM. The structure is ARRAY(*).
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFKFLLN | Length of the following keyword parameter entry. | |
| 2 | 2 | CHAR(*) | WDFKFLNM | Keyword parameter structure. | |
MSGLOC Keyword Structure (QDFKFLSZ)
MSGLOC keyword structure. Use this structure for the category 1 keyword that has a keyword ID of X'02' in structure QDFKFLPM (File-Level Keyword with Parameters (QDFKFLPM)). The number of entries in this structure is defined by variable WDFFSCR in structure QDFFBASE. This structure is defined at variable WDFKFLNM in structure QDFKFLPP. The structure is ARRAY(*).
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFKFLML | MSGLOC values. | |
| 2 | 2 | CHAR(4) | * | Reserved. | |
IGCCNV Keyword Structure (QDFKICVP)
IGCCNV keyword structure. Use this structure for the category 1 keyword that has a keyword ID of X'04' in structure QDFKFLPM (File-Level Keyword with Parameters (QDFKFLPM)). This structure is defined at variable WDFKFLNM in structure QDFKFLPP.
Note: The IGCCNV keyword generates additional internal records.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFKICVN | IGCCNV format line number. | |
| 2 | 2 | BIN(15) | WDFKICVK | IGCCNV format CF key. | |
| 4 | 4 | BIN(15) | WDFKICVT | Index to internally generated record in the record format table. | |
HLPRCD Keyword Structure (QDFKHARD)
HLPRCD keyword structure. Use this structure for the category 1 keyword that has a keyword ID of X'05' in structure QDFKFLPM (File-Level Keyword with Parameters (QDFKFLPM)). This structure is defined at variable WDFKFLNM in structure QDFKFLPP.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(10) | WDFKHRFM | Record format name. | |
| 10 | A | CHAR(10) | WDFKHFIL | File name. | |
| 20 | 14 | CHAR(10) | WDFKHLIB | File library name. | |
HLPPNLGRP Keyword Structure (QDFKHXPS)
HLPPNLGRP keyword structure. Use this structure for the category 1 keyword that has a keyword ID of X'06' in structure QDFKFLPM (File-Level Keyword with Parameters (QDFKFLPM)). This structure is defined at variable WDFKFLNM in structure QDFKFLPP.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(10) | WDFKHXHG | Help panel group. | |
| 10 | A | CHAR(10) | WDFKHXHL | Help panel group library name. | |
| 20 | 14 | BIN(15) | WDFKHXML | Length of module name. | |
| 22 | 16 | CHAR(*) | WDFKHXMN | Help module name. | |
HLPDOC Keyword Structure (QDFKHDOC)
HLPDOC keyword structure. Use this structure for the category 1 keyword that has a keyword ID of X'07' in structure QDFKFLPM (File-Level Keyword with Parameters (QDFKFLPM)). This structure is defined at variable WDFKFLNM in structure QDFKFLPP.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(10) | WDFKHDLA | Help text label name. | |
| 10 | A | CHAR(12) | WDFKHDDO | Document name. | |
| 22 | 16 | BIN(15) | WDFKHDFL | Length of folder name. | |
| 24 | 18 | CHAR(*) | WDFKHDFD | Folder name. | |
HLPSCHIDX Keyword Structure (QDFKSIDX)
HLPSCHIDX keyword structure. Use this structure for the category 1 keyword that has a keyword ID of X'08' in structure QDFKFLPM (File-Level Keyword with Parameters (QDFKFLPM)). This structure is defined at variable WDFKFLNM in structure QDFKFLPP.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(10) | WDFKSIOB | Search index object name. | |
| 10 | A | CHAR(10) | WDFKSILB | Search index object library name. | |
ALTNAME Keyword Structure (QDFKFALX)
ALTNAME keyword structure. Use this structure for the category 1 keyword that has a keyword ID of X'0A' in structure QDFKFLPM. This structure is defined at variable WDFKFLNM in structure QDFKFLPP.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFKALT | Count of ALTNAME keywords. | |
| 2 | 2 | CHAR(*) | WDFKAARY | Alternative names (see structure QDFKFALK, ALTNAME Keyword Entry (QDFKFALK)). | |
ALTNAME Keyword Entry (QDFKFALK)
ALTNAME keyword entry. This structure is defined at variable WDFKAARY in structure QDFKFALX.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(10) | WDFKANME | ALTNAME keyword value (excluding apostrophes). | |
| 10 | A | BIN(15) | WDFKAINX | Index to record format in record format table. | |
ERRSFL Keyword Structure (QDFKESFL)
ERRSFL keyword structure. Use this structure for the category 1 keyword that has a keyword ID of X'0B' in structure QDFKFLPM (File-Level Keyword with Parameters (QDFKFLPM)). This structure is defined at variable WDFKFLNM in structure QDFKFLPP.
Note: The ERRSFL keyword generates additional internal records.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(10) | WDFKESCR | Subfile control record name. | |
WDWBORDER Keyword Structure (QDFKBODR)
WDWBORDER keyword structure. Use this structure for the category 1 keyword that has a keyword ID of X'0C' in structure QDFKFLPM (File-Level Keyword with Parameters (QDFKFLPM)). This structure is defined at variable WDFKFLNM in structure QDFKFLPP.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(1) | WDFKCLOR | Values for *COLOR. X'00' indicates not specified, X'3A' indicates BLU, X'20' indicates GRN, X'22' indicates WHT, X'28' indicates RED, X'30' indicates TRQ, X'32' indicates YLW, X'38' indicates PNK. | |
| 1 | 1 | CHAR(1) | WDFKDATR | Values for *DSPATR. Combination of two or more of these values: X'00' indicates no attribute X'30' indicates (*DSPATR CS), X'28' indicates (*DSPATR BL), X'24' indicates (*DSPATR UL), X'22' indicates (*DSPATR HI), X'21' indicates (*DSPATR RI), and X'27' indicates (*DSPATR ND). | |
| 2 | 2 | CHAR(8) | WDFKCHRS | WDWBORDER characters in the following order: top-left corner, top horizontal, top-right corner, left vertical, right vertical, bottom-left corner, bottom horizontal, bottom-right corner. If not specified, eight entries of X'00' will occur. | |
Category 2 (Record-Level Command Key Keywords)
The following table shows the keyword ID that corresponds to the record-level command-key keywords. Use structure QDFKCKKE for category 2 keyword IDs X'01' through X'25' and X'30'.
| ID | Keyword | ID | Keyword | ID | Keyword |
|---|---|---|---|---|---|
| X'01' | CA/CF01 | X'0E' | CA/CF14 | X'1A' | ROLLDOWN |
| X'02' | CA/CF02 | X'0F' | CA/CF15 | X'1B' | |
| X'03' | CA/CF03 | X'10' | CA/CF16 | X'1C' | HOME |
| X'04' | CA/CF04 | X'11' | CA/CF17 | X'1D' | CLEAR |
| X'05' | CA/CF05 | X'12' | CA/CF18 | X'1E' | HELP |
| X'06' | CA/CF06 | X'13' | CA/CF19 | X'20' | HLPRTN |
| X'07' | CA/CF07 | X'14' | CA/CF20 | X'21' | VLDCMDKEY |
| X'08' | CA/CF08 | X'15' | CA/CF21 | X'22' | ALTHELP |
| X'09' | CA/CF09 | X'16' | CA/CF22 | X'23' | ALTPAGEUP |
| X'0A' | CA/CF10 | X'17' | CA/CF23 | X'24' | ALTPAGEDWN |
| X'0B' | CA/CF11 | X'18' | CA/CF24 | X'25' | MNUBARSW |
| X'0C' | CA/CF12 | X'19' | ROLLUP | X'30' | MNUCNL |
| X'0D' | CA/CF13 |
Command Key Keyword Structure (QDFKCKKW)
Structure for command key keywords. The displacement to this structure from the beginning of the appropriate section (file, record, or field) is at variable WDFFCAOF in structure QDFFCCOA.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFKCKS | Number of entries in the array. | |
| 2 | 2 | CHAR(*) | WDFKCKCM | Command key keyword entries (see structure QDFKCKKE, Command Key Keyword Entries (QDFKCKKE)). | |
Command Key Keyword Entries (QDFKCKKE)
Command key keyword array. The number of entries in this structure is defined by variable WDFKCKS in structure QDFKCKKW. This structure is defined at variable WDFKCKCM in structure QDFKCKKW. The structure is ARRAY(*).
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(1) | WDFKCKID | Keyword ID. | |
| 1 | 1 | BIN(15) | WDFKCKIN | Index into selection table. 1 indicates not optioned. | |
| 3 | 3 | BIN(15) | WDFKCKRS | Response indicator minus one for files with INDARA keyword. Response indicator input buffer displacement for those without INDARA. -1 indicates no response indicator is specified. | |
| 5 | 5 | CHAR(4) | WDFKCKMA | Key mask (ignored for VLDCMDKEY and HLPRTN keywords). The OR values for the key mask follow: X'80000000' CA/CF01, X'40000000' CA/CF02, X'20000000' CA/CF03, X'10000000' CA/CF04, X'08000000' CA/CF05, X'04000000' CA/CF06, X'02000000' CA/CF07, X'01000000' CA/CF08, X'00800000' CA/CF09, X'00400000' CA/CF10, X'00200000' CA/CF11, X'00100000' CA/CF12, X'00080000' CA/CF13, X'00040000' CA/CF14, X'00020000' CA/CF15, X'00010000' CA/CF16, X'00008000' CA/CF17, X'00004000' CA/CF18, X'00002000' CA/CF19, X'00001000' CA/CF20, X'00000800' CA/CF21, X'00000400' CA/CF22, X'00000200' CA/CF23, X'00000100' CA/CF24, X'00000080' ROLLUP, X'00000040' ROLLDOWN, X'00000020' PRINT, X'00000010' HOME, X'00000008' CLEAR, X'00000004' HELP. | |
Note: The following keywords use the first three bytes of the mask field (WDFKCKMA) for the command key mask for the command key associated with the keyword. If the keyword is specified without a command key, a default command key is used. In addition, these keywords use the last byte of WDFKCKMA for a special purpose. The last byte contains the AID byte which is returned when the command key associated with the keyword is pressed. For example, if ALTPAGEDWN is specified as ALTPAGEDWN(CF04), then the last byte of the mask is X'34'. If you need to OR the masks of these keywords with the masks of the other keywords, zero out the last byte of the mask first. The keywords and the AID bytes for the default command keys are:
| Keyword | Default AID byte |
|---|---|
| ALTHELP | X'31' |
| ALTPAGEUP | X'37' |
| ALTPAGEDWN | X'38' |
| MNUBARSW | X'3A' |
| MNUCNL | X'3C' |
Category 3 (OVERLAY-Related Keywords and PUTRETAIN)
The following table shows the keyword ID that corresponds to the OVERLAY-related keywords and PUTRETAIN. Not all keywords require a structure. There are no structures for keyword IDs X'02', X'03', X'04', X'05', X'06', X'08', and X'09'.
| ID | Keyword | ID | Keyword |
|---|---|---|---|
| X'01' | OVERLAY | X'07' | PUTRETAIN |
| X'02' | PUTOVR | X'08' | PROTECT |
| X'03' | ERASEINP(*MDTON) | X'09' | INZINP |
| X'04' | MDTOFF(*UNPR) | X'10' | ERASE |
| X'05' | ERASEINP(*ALL) | X'11' | CLRL |
| X'06' | MDTOFF(*ALL) |
OVERLAY Keyword Structure (QDFKOVRR)
OVERLAY-related keywords. This structure is used if the keyword ID in structure QDFKFLPM (File-Level Keyword with Parameters (QDFKFLPM)) is X'01'. The displacement to this structure from the beginning of the appropriate section (file, record, and field) is at variable WDFFCAOF in structure QDFFCCOA.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFKOLS | Number of keyword entries to follow. | |
| 2 | 2 | CHAR(*) | WDFKOVRT | Array of keyword entries. Entries are contained in structure QDFKOVRE (Keyword Structure (QDFKOVRE)) or QDFKOVRP (OVERLAY and PUTRETAIN-Related Keyword Structure (QDFKOVRP)). | |
Keyword Structure (QDFKOVRE)
Array structure for keywords. Use this structure for category 3 keywords that have a keyword ID of X'02', X'03', X'04', X'05', X'06', X'08', or X'09'. This structure is defined at variable WDFKOVRT in structure QDFKOVRR. The structure is ARRAY(*).
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(1) | WDFKOLAD | Keyword ID. | |
| 1 | 1 | BIN(15) | WDFKOLAN | Index into selection table. 1 indicates not optioned. | |
OVERLAY and PUTRETAIN-Related Keyword Structure (QDFKOVRP)
Structure for OVERLAY and PUTRETAIN-related keywords. Use this structure for
category 3 keywords that have a keyword ID of X'01', X'07', X'10', or X'11'.
This structure is defined at variable WDFKOVRT in
structure QDFKOVRR. The structure is ARRAY(*).
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(1) | WDFKOLID | Keyword ID. | |
| 1 | 1 | BIN(15) | WDFKOLIN | Index into selection table. 1 indicates not optioned. | |
| 3 | 3 | CHAR(*) | WDFKOLEX | Extra remaining portion of this category for ERASE and CLRL. | |
ERASE Keyword Structure (QDFKOLER)
ERASE keyword structure. Use this structure for the category 3 keyword that
has a keyword ID of X'10'. This structure is defined at variable WDFKOLEX in structure QDFKOVRP.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFKOLE | Number of bytes to follow. | |
| 2 | 2 | ARRAY(*) OF BIN(15) | WDFKOLAR | Indexes to the record format table for the format to be erased. 0, if format does not exist. | |
CLRL Keyword Structure (QDFKOLCL)
CLRL keyword structure. Use this structure for the category 3 keyword that
has a keyword ID of X'11'. This structure is defined at variable WDFKOLEX in structure QDFKOVRP.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFKOLC | Number of bytes to follow (always 2). | |
| 2 | 2 | BIN(15) | WDFKOLCN | Clear line number. | |
Category 4 (Record-Level Miscellaneous Keywords)
The following table shows the keyword ID that corresponds to the record-level miscellaneous keywords. Not all keywords require a structure. There are no structures for keyword IDs X'01', X'02', X'03', X'04', X'05', X'06', X'07', X'08', and X'09'.
Note: Keywords INDARA2 and RTNCSRLOC2 are internally
generated.
| ID | Keyword | ID | Keyword |
|---|---|---|---|
| X'01' | LOCK | X'09' | RMVWDW |
| X'02' | ALARM | X'0F' | DSPMOD |
| X'03' | BLINK | X'10' | CSRLOC |
| X'04' | LOGOUT | X'11' | INDARA |
| X'05' | ALWGPH | X'13' | SETOFF |
| X'06' | MSGALARM | X'15' | RTNCSRLOC |
| X'07' | RETLCKSTS | X'16' | MNUBARDSP |
| X'08' | USRRSTDSP |
Miscellaneous Record-Level Keywords (QDFKMSRL)
Miscellaneous record-level keywords. The displacement to this structure from
the beginning of the appropriate section (file, record, or field) is at
variable WDFFCAOF in structure QDFFCCOA.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFKMSS | Number of keywords to follow. | |
| 2 | 2 | CHAR(*) | WDFKMSKW | Array of keyword entries. Entries are contained in structure QDFKMSAP (Parameter Structure (QDFKMSAP)). | |
Parameter Structure (QDFKMSAP)
Array structure for keywords with simple parameters. This structure is
defined at variable WDFKMSKW in structure QDFKMSRL.
The structure is ARRAY(*).
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 2 | 2 | CHAR(1) | WDFKMSAD | Keyword ID. | |
| 3 | 3 | BIN(15) | WDFKMSAN | Index into selection table. 1 indicates not optioned. | |
Response Indicator Keyword Array (QDFKMSCP)
Miscellaneous record-level keywords. Use this structure for category 4
keywords that have a keyword ID of X'10', X'11', X'0F', or X'13'. The
displacement to this structure from the beginning of structure QDFFRINF is at
variable WDFFINDO in structure QDFFRINF.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(1) | WDFKMSID | Keyword ID. | |
| 1 | 1 | BIN(15) | WDFKMSIN | Index into selection table. 1 indicates keyword is not optioned. For SETOFF, this contains the response indicator displacement. | |
| 3 | 3 | CHAR(*) | WDFKMSEX | Additional structures for CSRLOC, INDARA, DSPMOD, and MNUBARDSP keywords. (See structures QDFKMSK1 on CSRLOC Keyword Structure (QDFKMSK1), QDFKMSK2 on INDARA Keyword Structure (QDFKMSK2), QDFKMSK3 on DSPMOD Keyword Structure (QDFKMSK3), and QDFKMSMBDSP on MNUBARDSP Keyword Structure (QDFKMSMBDSP).) | |
CSRLOC Keyword Structure (QDFKMSK1)
Remaining portion of CSRLOC keyword. Use this structure for a category 4
keyword that has a keyword ID of X'10'. This structure is defined at variable
WDFKMSEX in structure QDFKMSCP.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFKMSLC | Length of data follows. | |
| 2 | 2 | CHAR(1) | * | Reserved. | |
| 3 | 3 | BIN(15) | WDFKMSRW | Output buffer displacement for row value field. | |
| 5 | 5 | BIN(15) | WDFKMSCL | Output buffer displacement for column value field. | |
| 7 | 7 | BIN(31) | WDFKMSFA | Index into name table for line number field. | |
| 11 | B | BIN(31) | WDFKMSFB | Index into name table for position number field. | |
INDARA Keyword Structure (QDFKMSK2)
Remaining portion of INDARA keyword. Use this structure for a category 4
keyword that has a keyword ID of X'11'. This structure is defined at variable
WDFKMSEX in structure QDFKMSCP.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFKMSLN | Length of data that follows. Length may be zero. | |
| 2 | 2 | ARRAY(*) OF BIN(15) | WDFKMSRI | List of response indicators that are referred to in this record (including SETOFF). The value is the indicator displacement (that is, the indicator number minus one). If an indicator is only an option indicator (and not a response indicator), this value is -1. | |
DSPMOD Keyword Structure (QDFKMSK3)
Remaining portion of DSPMOD keyword. Use this structure for a category 4
keyword that has a keyword ID of X'0F'. This structure is defined at variable
WDFKMSEX in structure QDFKMSCP.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFKMSDM | Index into display size array (valid values are 1 through 4). | |
RTNCSRLOC and RTNCSRLOC2 Keyword Structure (QDFKMSCLN)
Remaining portion of RTNCSRLOC and RTNCSRLOC2 keywords. Use this structure
for a category 4 keyword that has a keyword ID of X'15'. This structure is
defined at variable WDFKMSEX in structure
QDFKMSCP.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFKMSCRO | Displacement into input buffer to the hidden field that contains the name of the record that the cursor is on. Valid for RTNCSRLOC keyword or for the *RECNAME parameter of the RTNCSRLOC2 keyword. | |
| 0 | 0 | BIN(15) | WDFKRCLR | Displacement into input buffer to the hidden field that contains the row number the cursor is on. Valid for *WINDOW or *MOUSE parameter of RTNCSRLOC2 keyword. | |
| 2 | 2 | BIN(15) | WDFKMSCFO | Displacement into input buffer to the hidden field that contains the name of the field that the cursor is on. Valid for RTNCSRLOC keyword or for the *RECNAME parameter of the RTNCSRLOC2 keyword. | |
| 2 | 2 | BIN(15) | WDFKRCLC | Displacement into input buffer to the hidden field that contains the column number the cursor is on. Valid for *WINDOW or *MOUSE parameter of RTNCSRLOC2 keyword. | |
| 4 | 4 | BIN(15) | WDFKMSCLO | Displacement into input buffer to the hidden field that contains the relative position into the field that the cursor is on. Valid for RTNCSRLOC keyword or for the *RECNAME parameter of the RTNCSRLOC2 keyword. | |
| 4 | 4 | BIN(15) | WDFKCLWR | Displacement into input buffer to the hidden field that contains the row of the cursor relative to the active window or to the location of the cursor after the mouse button action has been processed. Valid for *WINDOW or *MOUSE parameter of RTNCSRLOC2 keyword. | |
| 6 | 6 | BIN(15) | WDFKRCLWC | Displacement into input buffer to the hidden field that contains the column of the cursor relative to the active window or to the location of the cursor after the mouse button action has been processed. Valid for *WINDOW or *MOUSE parameter of RTNCSRLOC2 keyword and does not exist for the RTNCSRLOC keyword. | |
| 8 | 8 | CHAR(1) | WDFKRCTYPE | The type of RTNCSRLOC format specified. X'00' indicates *RECNAME is specified, X'01' indicates *WINDOW is specified, and X'02' indicates *MOUSE is specified. This section is only valid for the RTNCSRLOC2 keyword and does not exist for the RTNCSRLOC keyword. | |
| 9 | 9 | CHAR(1) | WDFKRCFLGS | Miscellaneous flags for the RTNCSRLOC2 keyword. This section is only valid for the RTNCSRLOC2 keyword and does not exist for the RTNCSRLOC keyword. | |
| 9 | 9 | 0 | BIT(1) | WDFKRCLFMT2 | 1 indicates this is returning row-column information. 0 indicates this is returning record name and field name information. This section is only valid for the RTNCSRLOC2 keyword and does not exist for the RTNCSRLOC keyword. |
| 9 | 9 | 1 | BIT(7) | * | Reserved. |
MNUBARDSP Keyword Structure (QDFKMSMBDSP)
Remaining portion of MNUBARDSP. Use this structure for a category 4 keyword
that has a keyword ID of X'16'. This structure is defined at variable WDFKMSEX in structure QDFKMSCP.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(10) | WDFKMBDRCN | The name of the menu bar record that the MNUBARDSP keyword wants to display. If MNUBARDSP is on a MNUBAR keyword record, this field contains hexadecimal zeros. | |
| 10 | A | BIN(15) | WDFKMBDCFO | Displacement into input buffer to the hidden field that contains the number of the CHOICE specified by the user. -1, if not used. | |
| 12 | C | BIN(15) | WDFKMBDPIO | If the PULLDOWN contains only the SNGCHCFLD keyword, this is the displacement into the input buffer to the hidden field that contains the input from the PULLDOWN. -1, if not used. | |
Category 6 Keywords (Record-Level Keywords)
The following table shows the keyword ID that corresponds to category 6
keywords. Both of these keyword IDs require a structure.
| ID | Keyword |
|---|---|
| X'01' | INVITE |
| X'09' | FRCDTA |
Record-level Keywords with selection array index (QDFRCAT06).
Record-level keywords with only an index into the selection table. The displacement to this structure from the beginning of the appropriate section (file, record, or field) is at variable WDFFCAOF in structure QDFFCCOA.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(1) | WDFKC6ID | Keyword ID. | |
| 1 | 1 | BIN(15) | WDFKCINX | Index into selection table. 1 indicates not optioned. | |
Category 0B Keywords (File-Level Keywords with Parameters)
The following table shows the keyword ID that corresponds to category 0B
keywords. Both of these keyword IDs require a structure.
| ID | Keyword |
|---|---|
| X'01' | GRDATR |
| X'02' | HLPSHELF |
File-Level Keywords with Parameters Structure (QDFK0BPR)
File-level keywords with parameters. The displacement to this structure from
the beginning of the appropriate section (file, record, or field) is at
variable WDFFCAOF in structure QDFFCCOA.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFK0BPCT | Number of keywords to follow. | |
| 2 | 2 | CHAR(*) | WDFK0BKW | File-level keyword entries. See structure QDFK0BXWP (File-Level Keyword Structure (QDFK0BXWP)). | |
File-Level Keyword Structure (QDFK0BXWP)
File-level keyword structure. This structure is defined at variable WDFK0BKW in structure QDFK0BPR.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(1) | WDFK0BPID | Keyword ID. | |
| 1 | 1 | BIN(15) | WDFK0BPIN | Index into selection table. 1 indicates keyword is not optioned. | |
| 3 | 3 | BIN(15) | WDFK0BPLN | Length of parameter for keyword. | |
| 5 | 5 | CHAR(*) | WDFK0BPEX | Extra remaining portion for keywords. The actual length is in variable WDFKMPLN in structure QDFKMRWP. | |
GRDATR Parameter Structure (QDFK0BGATR)
GRDATR parameter structure. Use this structure for category 0B keywords that
have a keyword ID of X'01'. The structure is defined at variable WDFK0BPEX in structure QDFK0BXWP.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(1) | WDFK0BCLR | Color parameter. X'FE' indicates not specified. | |
| 1 | 1 | CHAR(1) | * | Reserved. | |
| 2 | 2 | CHAR(1) | WDFK0BLT | Line type. X'FE' indicates not specified. | |
| 3 | 3 | CHAR(1) | * | Reserved. | |
HLPSHELF Parameter Structure (QDFKHBKPRM)
Structure for HLPSHELF parameters. Use this structure for category 0B
keywords that have a keyword ID of X'02'. The structure is defined at variable
WDFK0BPEX in structure QDFK0BXWP.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(8) | WDFKHBKNAM | Bookshelf name. | |
Category 17 (Record-Level Miscellaneous Keywords with Parameters)
The following table shows the keyword ID that corresponds to the record-level miscellaneous keywords with parameters. Not all keywords require a structure. There are no structures for keyword IDs X'03', X'04', and X'05'.
Note: HLP is an internal keyword generated when an
H-specification is specified.
| ID | Keyword | ID | Keyword |
|---|---|---|---|
| X'01' | HLP | X'05' | TIMER |
| X'02' | HLPSEQ | X'06' | |
| X'03' | HLPTITLE | X'07' | WDWBORDER |
| X'04' | HLPCLR | X'08' | WINDOW |
Miscellaneous Record-Level Structure (QDFKMRPR)
Miscellaneous record-level with parameters. The displacement to this
structure from the beginning of the appropriate section (file, record, or
field) is at variable WDFFCAOF in structure
QDFFCCOA.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFKRPS | Number of keywords to follow | |
| 2 | 2 | CHAR(*) | WDFKRPKW | Record-level keyword entries (see structure QDFKMRWP, Miscellaneous Record-Level Keywords (QDFKMRWP)). | |
Miscellaneous Record-Level Keywords (QDFKMRWP)
Miscellaneous record-level keywords. This structure is defined at variable
WDFKRPKW in structure QDFKMRPR. The structure is
ARRAY(*).
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(1) | WDFKMPID | Keyword ID. | |
| 1 | 1 | BIN(15) | WDFKMPIN | Index into selection table. 1 indicates keyword is not optioned. | |
| 3 | 3 | BIN(15) | WDFKMPLN | Length of parameter for keyword. | |
| 5 | 5 | CHAR(*) | WDFKMPEX | Extra remaining portion for keywords. Actual length of parameter is specified in variable WDFKMPLN in this structure. | |
HLP Keyword Structure (QDFKHSTR)
Remaining portion of H-specification. Use this structure for a category 17 keyword that has a keyword ID of X'01'. This structure is defined at variable WDFKMPEX in structure QDFKMRWP.
Note: HLP is an internal keyword generated when an
H-specification is specified.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFKH | Count of H-specifications. | |
| 2 | 2 | CHAR(*) | WDFKHV | Variable part of parameter. | |
HLP Keyword Entry Structure (QDFKHPRM)
Entry for the internal HLP keyword. The total number of entries is contained
in variable WDFKH in structure QDFKHSTR. This
structure is defined at variable WDFKHV in structure
QDFKHSTR. Displacements to subsequent entries are calculated using variable
WDFKHOFS in structure QDFKHSTR. The structure is ARRAY(*).
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFKHOFS | Length of this H-specification. | |
| 2 | 2 | BIN(15) | WDFKHFLG | Flags for H-specification. | |
| 2 | 2 | 0 | BIT(1) | WDFKHBDY | If on, HLPBDY keyword is specified. |
| 2 | 2 | 1 | BIT(1) | WDFKHPRD | If on, HLPRCD keyword is specified. Structure QDFKHNMS (HLPRCD Keyword Structure (QDFKHNMS)) is defined at variable WDFKHVAR of this structure. |
| 2 | 2 | 2 | BIT(1) | WDFKHPNL | If on, HLPPNLGRP keyword is specified. Structure QDFKHPS (HLPPNLGRP Keyword Structure (QDFKHPS)) is defined at variable WDFKHVAR. |
| 2 | 2 | 3 | BIT(1) | WDFKHPDC | If on, HLPDOC keyword is specified. Structure QDFKHRDC (HLPDOC Keyword Structure (QDFKHRDC)) is defined at variable WDFKHVAR. |
| 2 | 2 | 4 | BIT(1) | WDFKDFHR | If on, file name on HLPRCD keyword is the default. |
| 2 | 2 | 5 | BIT(1) | WDFKHEXC | If on, HLPEXCLD keyword is specified. |
| 2 | 2 | 6 | BIT(1) | WDFKENPT | If on, CHOICE, MNUBAR, or PULLDOWN help was specified in this H-specification. This indicates enhanced display structure QDFKHARX (HLPARA Keyword Enhanced Display Structure (QDFKHARX)) is mapped at variable WDFKHEXT in structure QDFKHARA. |
| 2 | 2 | 7 | BIT(9) | * | Reserved. |
| 4 | 4 | BIN(15) | WDFKHSRO | Displacement to structure containing help source information. (See structure QDFKHNMS on HLPRCD Keyword Structure (QDFKHNMS), QDFKHPS on HLPPNLGRP Keyword Structure (QDFKHPS), or QDFKHRDC on HLPDOC Keyword Structure (QDFKHRDC).) | |
| 6 | 6 | BIN(15) | WDFKHCRD | Selection string for help source on HLPRCD, HLPDOC, and HLPPNLGRP keywords. 1 indicates not specified or no indicator on keyword. | |
| 8 | 8 | BIN(15) | WDFKHCBY | Selection string for HLPBDY keyword. 1 indicates keyword not specified or no indicator on keyword. | |
| 10 | A | BIN(15) | WDFKHARO | Displacement to HLPARA information (see structure QDFKHARA, HLPARA Keyword Structure (QDFKHARA)). | |
| 12 | C | BIN(15) | WDFKHCEX | Selection string for HLPEXCLD. 1 indicates keyword not specified or no indicator on keyword. | |
| 14 | E | CHAR(3) | * | Reserved. | |
| 17 | 11 | CHAR(*) | WDFKHVAR | Variable length parameters. | |
HLPRCD Keyword Structure (QDFKHNMS)
HLPRCD keyword structure. This structure is present only if variable
WDFKHPRD in structure QDFKHPRM is set on. This structure is defined at variable
WDFKHVAR in structure QDFKHPRM.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(10) | WDFKHRCD | Record format name. | |
| 10 | A | CHAR(10) | WDFKHFLE | File name. | |
| 20 | 14 | CHAR(10) | WDFKHRLB | File library name. If file and library were not specified, these are the display file and library names. If file but not library is specified, the library name is *LIBL. | |
HLPPNLGRP Keyword Structure (QDFKHPS)
HLPPNLGRP keyword structure. This structure is present only if variable
WDFKHPNL in structure QDFKHPRM is set on. This structure is defined at variable
WDFKHVAR in structure QDFKHPRM.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(10) | WDFKHPNN | Help panel group name. | |
| 10 | A | CHAR(10) | WDFKHPLB | Help panel group library name. If library was not specified, the library name is *LIBL. | |
| 20 | 14 | BIN(15) | WDFKHMLN | Length of help module name. | |
| 22 | 16 | CHAR(*) | WDFKHMN | Help module name. | |
HLPDOC Keyword Structure (QDFKHRDC)
HLPDOC keyword structure. This structure is present only if variable
WDFKHPDC in structure QDFKHPRM is set on. This structure is defined at variable
WDFKHVAR in structure QDFKHPRM.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(10) | WDFKHRLA | Help text label name. | |
| 10 | A | CHAR(12) | WDFKHRDO | Document name. | |
| 22 | 16 | BIN(15) | WDFKHRFL | Length of folder name. | |
| 24 | 18 | CHAR(*) | WDFKHRFD | Folder name. | |
HLPARA Keyword Structure (QDFKHARA)
HLPARA keyword structure. This structure is repeated for each display size
specified. The number of display sizes is defined by variable WDFFSCR in
structure QDFFBASE. This structure is defined at variable WDFKHARO in structure QDFKHPRM. The structure is
ARRAY(*).
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(1) | WDFKHFRO | From row. | |
| 1 | 1 | CHAR(1) | WDFKHFCO | From column. | |
| 2 | 2 | CHAR(1) | WDFKHTRO | To row. | |
| 3 | 3 | CHAR(1) | WDFKHTCO | To column. | |
| 4 | 4 | CHAR(*) | WDFKHEXT | Enhanced display extension (see structure QDFKHARX, HLPARA Keyword Enhanced Display Structure (QDFKHARX)). This field is present only if variable WDFKENPT in structure QDFKHPRM is on. | |
HLPARA Keyword Enhanced Display Structure (QDFKHARX)
HLPARA enhanced display mapping. This structure is present only if variable
WDFKHPRD in structure QDFKHPRM is on. This structure
is defined at variable WDFKHEXT in structure
QDFKHARA.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(1) | WDFKHAFLG | Help area flags. | |
| 0 | 0 | 0 | BIT(1) | WDFKHCHC | Choice-level help. |
| 0 | 0 | 1 | BIT(2) | * | Reserved. |
| 0 | 0 | 3 | BIT(1) | WDFKHFLDC | Choice-level help, with no choice number. |
| 0 | 0 | 4 | BIT(1) | WDFKHRC | If on, HLPARA(*RCD) keyword is specified. |
| 0 | 0 | 5 | BIT(3) | * | Reserved. |
| 1 | 1 | BIN(15) | WDFKHFLDI | Index to field on choice-level help. | |
| 3 | 3 | CHAR(2) | WDFKHCHID | Choice number for choice-level help. | |
HLPSEQ Keyword Structure (QDFKHSEQ)
Remaining portion of HLPSEQ. Use this structure for a category 17 keyword
that has a keyword ID of X'02'. This structure is defined at variable WDFKMPEX in structure QDFKMRWP.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(10) | WDFKHSGN | Help group name. | |
| 10 | A | BIN(15) | WDFKHSS | Help sequence number. | |
| 12 | C | BIN(15) | WDFKHSIF | Index to first record in help group. | |
| 14 | E | BIN(15) | WDFKHSIL | Index to last record in help group. | |
| 16 | 10 | BIN(15) | WDFKHSIN | Index to next record in help group. | |
| 18 | 12 | BIN(15) | WDFKHSIP | Index to previous record in help group. | |
PRINT Keyword Structure (QDFKPRTR)
PRINT keyword structure. Use this structure for a category 17 keyword that
has a keyword ID of X'06'. This structure is defined at variable WDFKMPEX in structure QDFKMRWP.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFKRLRS | Response indicator; -1, if no response indicator. | |
| 2 | 2 | BIN(15) | WDFKRLP | Number of parameters to follow. | |
| 4 | 4 | CHAR(*) | WDFKPRTP | Remaining print structure. | |
Record-Level Print Parameters (QDFKPPRM)
Record-level print parameters. This structure is defined at variable WDFKMPEX in structure QDFKMRWP.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFKPLEN | Length of parameter to follow. | |
| 2 | 2 | CHAR(*) | WDFKPFLN | Print file or library name. | |
WDWBORDER Keyword Structure (QDFKBRDR)
WDWBORDER keyword structure. Use this structure for a category 17 keyword
that has a keyword ID of X'07'. This structure is defined at variable WDFKMPEX in structure QDFKMRWP.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(1) | WDFKCOLR | Value for *COLOR. X'00' indicates not specified, X'3A' indicates BLU, X'20' indicates GRN, X'22' indicates WHT, X'28' indicates RED, X'30' indicates TRQ, X'32' indicates YLW, X'38' indicates PNK. | |
| 1 | 1 | CHAR(1) | WDFKDSPA | Value for *DSPATR (combination of two or more of these values): X'00' indicates no attribute, X'30' indicates (*DSPATR CS), X'28' indicates (*DSPATR BL), X'24' indicates (*DSPATR UL), X'22' indicates (*DSPATR HI), X'21' indicates (*DSPATR RI), X'27' indicates (*DSPATR ND). If multiple values are specified, they are ORed together. | |
| 2 | 2 | CHAR(8) | WDFKCHAR | Border characters in the following order: top-left corner, top horizontal, top-right corner, left vertical, right vertical, bottom-left corner, bottom horizontal, bottom-right corner. | |
Window Data Array Structure (QDFKWDTA)
Window data array. Use this structure for a category 17 keyword that has a
keyword ID of X'08'. There is one array entry for each display size specified.
This structure is defined at variable WDFKMPEX in
structure QDFKMRWP. The structure is ARRAY(*).
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(2) | WDFWDWB | Miscellaneous flags that describe the type of information provided by this window keyword. | |
| 0 | 0 | 0 | BIT(1) | WDFKDEFN | 1 indicates window definition; do not use variable WDFKWNAM in this structure. 0 indicates window reference; use WDFKWNAM. |
| 0 | 0 | 1 | BIT(1) | WDFKLINC | 1 indicates actual line number provided. 0 indicates displacement to line number field provided. This field is not used if variable WDFKDEFN in this structure equals 0. |
| 0 | 0 | 2 | BIT(1) | WDFKLFL1 | 1 indicates line number field length is 1 digit long. 0 indicates line number is not 1 digit long. This field is not used if WDFKDEFN equals 0 or WDFKLINC equals 1. |
| 0 | 0 | 3 | BIT(1) | WDFKLFL2 | 1 indicates line number field length is 2 digits
long. 0 indicates line number is not 1 digit long. This field is not used if
WDFKDEFN equals 0 or WDFKLINC equals 1.
Note: If WDFKLFL1 and WDFKLFL2 both equal 0, the field length is 3 digits. |
| 0 | 0 | 4 | BIT(1) | WDFKPOSC | 1 indicates actual position number provided. 0 indicates displacement to position number field provided. This field is not used if WDFKDEFN equals 0. |
| 0 | 0 | 5 | BIT(1) | WDFKPFL1 | 1 indicates position number field length is 1 digit long. 0 indicates position number is not 1 digit long. This field is not used if WDFKDEFN equals 0 or WDFKPOSC equals 1. |
| 0 | 0 | 6 | BIT(1) | WDFKPFL2 | 1 indicates position number field length is 2
digits long. 0 indicates position number is not 1 digit long. This field is not
used if WDFKDEFN equals 0 or WDFKPOSC equals 1.
Note: If WDFKPFL1 and WDFKPFL2 both equal 0, the field length is 3 digits. |
| 0 | 0 | 7 | BIT(1) | WDFKDFTB | Default specified in place of first two parameters. Bits WDFKLINC and WDFKPOSC will also be set and WDFKLINW and WDFKPOSW will be set to 0. |
| 1 | 1 | 0 | BIT(1) | WDFKNMLN | If on, *NOMSGLIN parameter is specified. This window does not contain a message line. |
| 1 | 1 | 1 | BIT(1) | WDFKWRST | If on, *NORSTCSR parameter is specified. This window allows the function keys to work outside of the window. |
| 1 | 1 | 2 | BIT(6) | * | Reserved. |
| 2 | 2 | CHAR(10) | WDFKWNAM | Name of window definition record. | |
| 2 | 2 | BIN(15) | WDFKLIN | Line number or displacement. | |
| 4 | 4 | BIN(15) | WDFKPOS | Position number or displacement. | |
| 6 | 6 | BIN(15) | WDFKLINW | Number of window lines in window. | |
| 8 | 8 | BIN(15) | WDFKPOSW | Number of window positions in window. | |
| 10 | A | CHAR(2) | * | Reserved. | |
Window Title Structure (QDFKWDWTTL)
Window title structure. This structure is defined at variable WDFKRPKW in structure QDFKMRPR.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(5) | WDFKWDWOVL | Miscellaneous record-level keywords. Structure QDFKMRWP (Miscellaneous Record-Level Keywords (QDFKMRWP)) overlays this field. | |
| 5 | 5 | CHAR(1) | WDFKWTFLAGS | Miscellaneous flags that describe the type of information provided by this window title keyword. | |
| 5 | 5 | 0 | BIT(1) | WDFKWTTXTF | 1 indicates window title text is in a program-to-system field. 0 indicates window title text is a text literal. |
| 5 | 5 | 1 | BIT(1) | WDFKWTCLRF | 1 indicates window title color value is in a program-to-system field. 0 indicates window title color value is in the parameter. |
| 5 | 5 | 2 | BIT(1) | WDFKWTATRF | 1 indicates window title attribute value is in a program-to-system field. 0 indicates window title attribute value is in the parameter. |
| 5 | 5 | 3 | BIT(1) | WDFKWTALNF | 1 indicates window title alignment value is in a program-to-system field. 0 indicates window title alignment value is in the parameter. |
| 5 | 5 | 4 | BIT(1) | WDFKWTPOS | 1 indicates window title goes in the bottom border. 0 indicates window title goes in the top border. |
| 5 | 5 | 5 | BIT(3) | * | Reserved. |
| 6 | 6 | BIN(15) | WDFKWTCLRPF | Buffer displacement to field that contains the color. | |
| 6 | 6 | CHAR(1) | * | Reserved. | |
| 7 | 7 | CHAR(1) | WDFKWTCOLOR | Value for *COLOR. X'00' indicates not specified, X'3A' indicates BLU, X'20' indicates GRN, X'22' indicates WHT, X'28' indicates RED, X'30' indicates TRQ, X'32' indicates YLW, and X'38' indicates PNK. | |
| 8 | 8 | BIN(15) | WDFKWTDSPPF | Buffer displacement to the field that contains the attribute. | |
| 8 | 8 | CHAR(1) | * | Reserved. | |
| 9 | 9 | CHAR(1) | WDFKWTDSPA | Value for *DSPATR (combination of two or more of the values below). X'00' indicates no attribute, X'30' indicates (*DSPATR CS), X'28' indicates (*DSPATR BL), X'24' indicates (*DSPATR UL), X'22' indicates (*DSPATR HI), X'21' indicates (*DSPATR RI), and X'27' indicates (*DSPATR ND). | |
| 10 | A | BIN(15) | WDFKWTALGN | Buffer displacement to the field that contains the alignment. | |
| 10 | A | CHAR(1) | * | Reserved. | |
| 11 | B | CHAR(1) | WDFKWTALIGN | Value for alignment. X'00' indicates not specified, X'01' indicates *left specified, X'02' indicates *CENTER specified, and X'03' indicates *RIGHT specified. | |
| 12 | C | BIN(15) | WDFKWTTXTO | Buffer displacement to the field that contains the text if variable WDFKWTTXTF in this structure is on. Displacement is from structure QDFKWDWTTL (Window Title Structure (QDFKWDWTTL)). | |
| 14 | E | BIN(15) | WDFKWTTXTL | Length of the text. | |
| 15 | F | CHAR(10) | * | Reserved. | |
| 26 | 1A | CHAR(*) | WDFKWTTEXT | Text if entered on the parameter as a literal. | |
Mouse Button Structure (QDFKMB)
Mouse button structure. This structure is defined at variable WDFKMPEX in structure QDFKMRWP.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(1) | WDFKMBFLAGS | Miscellaneous flags that describe the type of information provided by this mouse button keyword. | |
| 0 | 0 | 0 | BIT(1) | WDFKMBTYPE | 1 indicates two event mouse button definition. 0 indicates single event mouse button definition. |
| 0 | 0 | 1 | BIT(1) | WDFKMBTCSR | 1 indicates move text cursor to mouse cursor. 0 indicates do not move text cursor to mouse cursor. |
| 0 | 0 | 2 | BIT(1) | WDFKMBQUE | 1 indicates queue if keyboard locked. 0 indicates do not queue if keyboard locked. |
| 0 | 0 | 3 | BIT(1) | WDFKMBKRB | 1 indicates marker box drawn. 0 indicates marker box not drawn. |
| 0 | 0 | 4 | BIT(4) | * | Reserved. |
| 1 | 1 | CHAR(1) | WDFKMBFIRST | Value for first event ID. X'01' indicates left button pressed, X'02' indicates left button released, X'03' indicates left button double-clicked, X'04' indicates right button pressed, X'05' indicates right button released, X'06' indicates right button double-clicked, X'07' indicates middle button pressed, X'08' indicates middle button released, X'09' indicates middle button double-clicked, X'0A' indicates shift left button pressed, X'0B' indicates shift left button released, X'0C' indicates shift left button double-clicked, X'0D' indicates shift right button pressed, X'0E' indicates shift right button released, X'0F' indicates shift right button double-clicked, X'10' indicates shift middle button pressed, X'11' indicates shift middle button released, and X'12' indicates shift middle button double-clicked. | |
| 2 | 2 | CHAR(1) | WDFKMBSECOND | Value for second event ID. X'01' indicates left button pressed, X'02' indicates left button released, X'03' indicates left button double-clicked, X'04' indicates right button pressed, X'05' indicates right button released, X'06' indicates right button double-clicked, X'07' indicates middle button pressed, X'08' indicates middle button released, X'09' indicates middle button double-clicked, X'0A' indicates shift left button pressed, X'0B' indicates shift left button released, X'0C' indicates shift left button double-clicked, X'0D' indicates shift right button pressed, X'0E' indicates shift right button released, X'0F' indicates shift right button double-clicked, X'10' indicates shift middle button pressed, X'11' indicates shift middle button released, and X'12' indicates shift middle button double-clicked. | |
| 3 | 3 | CHAR(1) | WDFKMBAID | AID code to be returned. X'31' through X'3C' indicates CA/CF01-12, X'70' through X'7F' indicates E00-E15, X'B1' through X'BC' indicates CA/CF13-24, X'BD' indicates CLEAR, X'F1' indicates ENTER, X'F3' indicates HELP, X'F4' indicates Roll Down, X'F5' indicates Roll Up, X'F6' indicates Print, and X'F8' indicates Home. | |
Category 18 (SFL Control Keywords)
The following table shows the keyword ID that corresponds to the following:
- The SFL control keywords that can be optioned
- The SFL control keywords processed by SFL and workstation
Not all keywords require a structure. There are no structures for keyword
IDs X'01', X'02', X'03', X'04', X'05', X'06', X'07', X'08', and X'09'.
| ID | Keyword | ID | Keyword |
|---|---|---|---|
| X'01' | SFLDSP | X'09' | SFLDROP |
| X'02' | SFLDSPCTL | X'0D' | SFLMSG |
| X'03' | SFLINZ | X'0E' | SFLMSGID |
| X'04' | SFLDLT | X'0F' | SFLEND(*MORE) |
| X'05' | SFLCLR | X'10' | SFLCSRRRN |
| X'06' | SFLEND | X'11' | SFLMODE |
| X'07' | SFLNXTCHG | X'12' | SFLEND(*SCRBAR) |
| X'08' | SFLFOLD |
SFL Keyword Structure (QDFKSCSF)
SFL keyword structure. The displacement to this structure from the beginning
of the appropriate section (file, record, or field) is at variable WDFFCAOF in structure QDFFCCOA.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFKSCS | Number of keywords to follow. | |
| 2 | 2 | CHAR(*) | WDFKSCSE | SFL keyword entries (see structure QDFKSCCP, SFL Keyword Entry (QDFKSCCP)). | |
SFL Keyword Entry (QDFKSCCP)
SFL keyword entry. This structure is defined at variable WDFKSCSE in structure QDFKSCSF.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(1) | WDFKSCID | Keyword ID. | |
| 1 | 1 | BIN(15) | WDFKSCIN | Index into selection table. 1 indicates not optioned. | |
| 3 | 3 | CHAR(*) | WDFKSCEX | Extra remaining portion of this category. | |
SFLMSG and SFLMSGID Keyword Structure (QDFKSCSM)
Structure for SFLMSG and SFLMSGID keywords. Use this structure for a
category 18 keyword that has a keyword ID of X'0D' or X'0E'. This structure is
defined at variable WDFKSCEX in structure
QDFKSCCP.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFKSCRS | Response indicator minus one for files with INDARA keyword. Response indicator input buffer displacement for those without INDARA keyword. In either case, -1 represents no response indicator is specified. For SFLMSGID, this field contains hexadecimal zeros. | |
| 2 | 2 | CHAR(1) | WDFKSCTY | Parameter type (for SFLMSG). X'00' indicates character, X'08' indicates DBCS. | |
| 3 | 3 | BIN(15) | WDFKSCLN | Length of data to follow. | |
| 5 | 5 | CHAR(*) | WDFKSCTX | Parameters of text or data. | |
SFLMSGID Keyword Structure (QDFKSCSI)
SFLMSGID keyword structure. Use this structure for a category 18 keyword
that has a keyword ID of X'0E'. The first three fields are specified. If the
user does not specify a library, *LIBL is the default. This structure is
defined at variable WDFKSCTX in structure
QDFKSCSM.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(7) | WDFKSCMI | Message ID. | |
| 7 | 7 | CHAR(10) | WDFKSCMF | Message file name. | |
| 17 | 11 | CHAR(10) | WDFKSCML | Message library name. | |
| 27 | 1B | BIN(15) | WDFKSCDL | Message data field length. | |
| 29 | 1D | BIN(15) | WDFKSCMO | Output buffer displacement to message data field. | |
SFLEND(*MORE) Keyword Structure (QDFKSFLM)
SFLEND(*MORE) keyword structure. Use this structure for a category 18
keyword that has a keyword ID of X'0F'. This structure is defined at variable
WDFKSCEX in structure QDFKSCCP.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(12) | WDFKMORE | Text to be used for More.... | |
| 12 | C | CHAR(12) | WDFKBOTT | Text to be used for Bottom. | |
SFLEND(*SCRBAR) Keyword Structure (QDFKSFLS)
SFLEND(*SCRBAR) keyword structure. Use this structure for a category 18
keyword that has a keyword ID of X'12'. This structure is defined at variable
WDFKSCEX in structure QDFKSCCP.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(1) | WDFKSFLENDSPM | Second parameter value for SFLEND(*SCRBAR). X'00' indicates *SCRBAR, X'01' indicates *MORE, and X'02' indicates *PLUS. | |
| 1 | 1 | CHAR(12) | WDFKSFLMORE | Text to be used for More.... | |
| 13 | D | CHAR(12) | WDFKSFLBOTT | Text to be used for Bottom. | |
SFLCSRRRN Keyword Structure (QDFKCSRRRN)
SFLCSRRRN keyword structure. Use this structure for a category 18 keyword
that has a keyword ID of X'10'. This structure is defined at variable WDFKSCEX in structure QDFKSCCP.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFKCSRNO | Displacement into input buffer to the hidden field containing the subfile relative record number of where the cursor is located. | |
SFLMODE Keyword Structure (QDFKMODE)
SFLMODE keyword structure. Use this structure for a category 18 keyword that
has a keyword ID of X'11'. This structure is defined at variable WDFKSCEX in structure QDFKSCCP.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFKSCMDO | Displacement into input buffer to the hidden field containing the mode of the subfile. If set to 0, the MODE keyword was not specified. | |
Category 20 (Screen-Attribute-Related Keywords)
The following table shows the keyword ID that corresponds to the
screen-attribute-related keywords. None of these keyword IDs require a
structure.
| ID | Keyword | ID | Keyword |
|---|---|---|---|
| X'01' | COLOR | X'07' | DSPATR(HI) |
| X'04' | DSPATR(CS) | X'08' | DSPATR(RI) |
| X'05' | DSPATR(BL) | X'09' | DSPATR(ND) |
| X'06' | DSPATR(UL) | X'0A' | DSPATR(PC) |
Screen Attribute Keyword Structure (QDFKSASA)
Structure for screen attribute keywords. The displacement to this structure
from the beginning of the appropriate section (file, record, or field) is at
variable WDFFCAOF in structure QDFFCCOA.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFKSAS | Number of keyword entries to follow. | |
| 2 | 2 | CHAR(*) | WDFKSASE | Screen attribute keywords (see structure QDFKSAPM, Screen Attribute Keyword Array (QDFKSAPM)). | |
Screen Attribute Keyword Array (QDFKSAPM)
Array of screen attribute keywords. This structure is defined at variable WDFKSASE in structure QDFKSASA. The structure is
ARRAY(*).
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(1) | WDFKSAIA | Keyword ID. | |
| 1 | 1 | BIN(15) | WDFKSAII | Index into selection table. For color keywords, 1 indicates keyword is not optioned. Unoptioned DSPATR keywords are not in this category but are indicated in the screen attribute variable WDFFSA in structure QDFFFDPD. | |
| 3 | 3 | CHAR(1) | WDFKSAOA | OR value color. X'20' indicates GRN, X'22' indicates WHT, X'28' indicates RED, X'30' indicates TRQ, X'32' indicates YLW, X'38' indicates PNK, and X'3A' indicates BLU. DSPATR. X'30' indicates CS, X'28' indicates BL, X'24' indicates UL, X'22' indicates HI, X'21' indicates RI, and X'27' indicates ND. | |
Category 21 Keywords
The following table shows the keyword ID that corresponds to category 21 keywords. All of these keyword IDs require a structure.
| ID | Keyword |
|---|---|
| X'01' | DSPATR(PR) |
| X'02' | DUP |
| X'03' | DSPATR(MDT) |
| X'04' | AUTO(RA) |
| X'05' | CHECK(ME) |
FFW and FCW Keyword Structure (QDFKFFWR)
Structure for field format word (FFW) and field control word (FCW) keywords. The displacement to this structure from the beginning of the section is an entry in the table at variable WDFFCAOF in structure QDFFCCOA.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFKFWS | Number of keywords to follow. | |
| 2 | 2 | CHAR(*) | WDFKFWEN | FFW keyword entries (see structure QDFKCHKP, FFW Keyword Structure (QDFKCHKP)). | |
FFW Keyword Structure (QDFKCHKP)
Structure for FFW-related keywords. Use this structure for category 21
keywords that have keyword IDs of X'01', X'02', X'03', X'04', and X'05'. This
structure is defined at variable WDFKFWEN in
structure QDFKFFWR. The structure is ARRAY(*).
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(1) | WDFKFWID | Keyword ID. | |
| 1 | 1 | BIN(15) | WDFKFWIN | Index into selection table. 1 indicates keyword is not optioned. Keywords DSPATR(PR | MDT), DUP, AUTO(RA), and CHECK(ME), which are not optioned, are not in this category but are indicated in the FFW WDFFFWFW VARIABLE in structure QDFFFDIC. | |
| 3 | 3 | CHAR(2) | WDFKFWOV | OR value for FFW. X'6000' indicates DSPATR(PR), X'5000' indicates DUP, X'4800' indicates DSPATR(MDT), X'4080' indicates AUTO(RA), X'4008' indicates CHECK(ME). | |
Category 22 (Miscellaneous Field-Level Keywords)
The following table shows the keyword ID that corresponds to miscellaneous
field-level keywords. Not all keywords require a structure. There are no
structures for keyword IDs X'01', X'02', X'03', X'04', X'05', X'06' and
X'07'.
| ID | Keyword | ID | Keyword |
|---|---|---|---|
| X'01' | PUTRETAIN | X'10' | MSGID |
| X'02' | OVRDTA | X'15' | ERRMSG |
| X'03' | OVRATR | X'16' | ERRMSGID |
| X'04' | BLANKS | X'17' | DSPATR(PFLD) |
| X'05' | CHANGE | X'18' | DATTIMFMT |
| X'06' | DUP | X'19' | DATTIMSEP |
| X'07' | DUP | X'1A' | DATE (special value) |
| X'1B' | MAPVAL |
Miscellaneous Field-Level Keyword Structure (QDFKMFDK)
Miscellaneous field-level keywords. The displacement to this structure from
the beginning of the appropriate section (file, record, or field) is at
variable WDFFCAOF in structure QDFFCCOA.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFKMFS | Number of keywords to follow. | |
| 2 | 2 | BIN(15) | WDFKMFNO | Index into field index table of next field that has either ERRMSG or ERRMSGID. 0, if this the last one in the record or none exist. | |
| 4 | 4 | CHAR(*) | WDFKMFEN | Field-level keyword entry (see structure QDFKMFDP, Field-Level Keyword Structure (QDFKMFDP)). | |
Field-Level Keyword Structure (QDFKMFDP)
Field-level keyword parameters. The number of keyword parameters is
contained in variable WDFKMFS in structure QDFKMFDK. This structure is defined
at variable WDFKMFEN in structure QDFKMFDK.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(1) | WDFKMFID | Keyword ID. | |
| 1 | 1 | BIN(15) | WDFKMFIN | Index into selection table. 1 indicates keyword is not optioned. | |
| 3 | 3 | CHAR(*) | WDFKMFEX | Extra remaining portion of this category. | |
Response Indicator Structure (QDFKMFRS)
Response indicator. This structure is defined at variable WDFKMFEX in structure QDFKMFDP.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFKMFRP | Response indicator minus one for files with INDARA keyword. Response indicator input buffer displacement for those without INDARA. In either case, -1 represents no response indicator specified. For ERRMSGID, this field contains hexadecimal zeros. | |
| 2 | 2 | CHAR(*) | WDFKMFEE | ERRMSG and ERRMSGID data. | |
ERRMSG and ERRMSGID Keyword Structure (QDFKMFEM)
Structure for ERRMSG and ERRMSGID keywords. Use this structure for category
22 keywords that have keyword IDs of X'15' and X'16'. This structure is defined
at variable WDFKMFEE in structure QDFKMFRS.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(1) | WDFKMFTP | Type of parameter (for ERRMSG). X'00' indicates character, X'08' indicates DBCS. | |
| 1 | 1 | BIN(15) | WDFKMFEL | Length of data to follow. | |
| 3 | 3 | CHAR(*) | WDFKMFTX | ERRMSG and ERRMSGID data. | |
ERRMSGID Keyword Structure (QDFKMFSI)
ERRMSGID keyword structure. Use this structure for category 22 keywords that
have a keyword ID of X'16'. The first three fields are specified. If the user
does not specify library, *LIBL is the default. This structure is defined at
variable WDFKMFTX in structure QDFKMFEM.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(7) | WDFKMFMI | Message ID. | |
| 7 | 7 | CHAR(10) | WDFKMFMF | Message file name. | |
| 17 | 11 | CHAR(10) | WDFKMFML | Message library name. | |
| 27 | 1B | BIN(15) | WDFKMFDL | Message data field length. | |
| 29 | 1D | BIN(15) | WDFKMFMO | Output buffer displacement to message data field. | |
MSGID Keyword Common Structure (QDFKMFMV)
MSGID keyword structure. Use this structure for category 22 keywords that
have a keyword ID of X'10'. This structure is defined at variable WDFKMFEX in structure QDFKMFDP.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(1) | WDFKMFMM | Mode of MSGID keyword. X'01' indicates prefix specified, X'02' indicates no prefix specified, X'03' indicates constant message ID, and X'04' indicates none. For mode 1 or 2, use this structure. For mode 3, use structure QDFKMFM3 (Type Three MSGID Keyword Structure (QDFKMFM3)). For mode 4, use structure QDFKMFM4 (Type Four MSGID Keyword Structure (QDFKMFM4)). | |
| 1 | 1 | CHAR(3) | WDFKMFMP | Message prefix. This field contains hexadecimal zeros when variable WDFKMFMM in this structure equals X'02'. When WDFKMFMM equals X'03', this field is the same value as variable WDFKMF1 in structure QDFKMFM3. | |
| 4 | 4 | BIN(15) | WDFKMFFL | Message file length. This is the length of the field that contains the message file name. This field is not set when the file is a constant or special value. | |
| 6 | 6 | CHAR(10) | WDFKMFFV | Message file name set when a constant or special value is specified for the message file. | |
| 16 | 10 | CHAR(10) | WDFKMFLV | Message file library name set when a constant or no library is specified for the message file. | |
| 26 | 1A | ARRAY(3) OF BIN(15) | WDFKMFB | Three output buffer displacements to the fields in the following order: (1) MSGID field, (2) message file field, and (3) message library field. For message file or message library, X'FFFF' indicates constants. When variable WDFKMFMM equals X'03', the MSGID field equals X'FFFF'. | |
| 32 | 20 | ARRAY(3) OF BIN(31) | WDFKMFNT | Indexes to a field in structure QDFFNTB (Field Name Table (QDFFNTB)) in the same order as variable WDFKMFB in this structure. If not specified, set to hexadecimal zeros. | |
| 43 | 2B | CHAR(*) | WDFKMFMX | Extension for type three MSGID keyword structure (only when variable WDFKMFMM equals X'03'). | |
Type Three MSGID Keyword Structure (QDFKMFM3)
Structure for MSGID keyword when variable WDFKMFMM in structure QDFKMFMV
equals X'03'. This structure is defined at variable
WDFKMFMX in structure QDFKMFMV.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(3) | WDFKMF1 | Constant message number. Message prefix (same as
WDFKMFMP in structure QDFKMFMV). |
|
| 3 | 3 | CHAR(4) | WDFKMF2 | Message ID. | |
Type Four MSGID Keyword Structure (QDFKMFM4)
Structure for MSGID(*NONE) keyword when variable
WDFKMFMM in structure QDFKMFMV equals X'04'. This structure is defined at
variable WDFKMFEX in structure QDFKMFDP.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(1) | WDFKMFD4 | Mode of MSGID keyword. MSGID(*NONE) equals X'04'. | |
DSPATR Keyword Structure (QDFKDFLD)
DSPATR keyword structure. Use this structure for a category 22 keyword that
has a keyword ID of X'17'. This structure is defined at variable WDFKMFEX in structure QDFKMFDP.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFKDFLO | Displacement to attribute field. | |
DATTIMFMT Keyword Structure (QDFK_DATTIM_Format)
The DATFMT or TIMFMT keyword structure. Use this category 22 keyword
structure for ID X'18'. This structure is defined at variable WDFKMFEX in structure QDFKMFDP.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) |
WDFK_DATTIM _Fmt |
Format used for a field with the date or time data type. X'01' indicates *JOB, X'02' indicates *MDY, X'03' indicates *DMY, X'04' indicates *YMD, X'05' indicates *JUL, X'06' indicates *ISO, X'07' indicates *USA, X'08' indicates *EUR, X'09' indicates *JIS, X'0A' indicates *HMS. | |
DATTIMSEP Keyword Structure (QDFK_DATTIM_Separator)
The DATSEP or TIMSEP keyword structure. Use this category 22 keyword
structure for ID X'19'. This structure is defined at variable WDFKMFEX in structure QDFKMFDP.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(1) |
WDFK_DATTIM _Sep |
Separator used for a field with the date or time data type. The separator can be a period (.), comma (,), slash (/), dash (-), colon (:), blank ( ) or (J) to indicate *JOB. | |
DATE Keyword Structure (QDFK_DATEP)
The DATE (with parameters) keyword structure. Use this category 22 keyword
structure for ID X'1A'. This structure is defined at variable WDFKMFEX in structure QDFKMFDP.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | 0 | BIT(1) | WDFK_DATE_SYS | If on, the *SYS parameter is specified on the DATE keyword. |
| 0 | 0 | 1 | BIT(1) | WDFK_DATE_YY | If on, the *YY parameter is specified on the DATE keyword. |
| 0 | 0 | 2 | BIT(1) |
WDFK_DATE _EDTCDEY |
If on, the EDTCDE(Y) keyword was specified with the DATE keyword. |
| 0 | 0 | 2 | BIT(5) | * | Reserved. |
MAPVAL Keyword Structure (QDFK_MAPVAL)
The MAPVAL keyword structure. Use this category 22 keyword structure for ID
X'1B'. This structure is defined at variable WDFKMFEX
in structure QDFKMFDP.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) |
WDFK_MAPVAL _Count |
Number of MAPVAL keyword parameters. | |
| 2 | 2 | BIN(15) |
WDFK_MAPVAL _Length |
Length of each MAPVAL keyword parameter. | |
| 4 | 4 | CHAR(*) |
WDFK_MAPVAL _Length |
List of MAPVAL keyword parameters. Length of this structure is WDFK_MAPVAL_Count * WDFK_MAPVAL_Length. | |
Category 23 (DFT Keyword)
The following table shows the keyword ID that corresponds to the DFT
keyword. Not all keywords require a structure. There are no structures for
keyword IDs X'01' and X'03'.
| ID | Keyword |
|---|---|
| X'01' | DFT |
| X'02' | MSGCON |
| X'03' | DFTVAL |
| X'04' | HTML |
Category 23 Keyword Structure (QDFKDFT)
Category 23 keyword structure. The displacement to this structure from the beginning of the appropriate section (file, record, or field) is at variable WDFFCAOF in structure QDFFCCOA.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFKDFS | Number of keywords to follow. | |
| 2 | 2 | CHAR(*) | WDFKDFPE | Category 23 parameter entries (see structure QDFKDFPM, Category 23 Keyword Parameters (QDFKDFPM)). | |
Category 23 Keyword Parameters (QDFKDFPM)
Category 23 keyword parameters. This structure is defined at variable WDFKDFPE in structure QDFKDFT. Displacements to
subsequent entries are calculated using variable WDFKDFLN in this structure.
The structure is ARRAY(*).
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(1) | WDFKDFID | Keyword ID. | |
| 1 | 1 | CHAR(1) | WDFKDFTY | Parameter type. X'00' indicates character, X'03' indicates graphic literal, and X'08' indicates DBCS. | |
| 2 | 2 | BIN(15) | WDFKDFIN | Index into selection table. 1 indicates keyword is not optioned. | |
| 4 | 4 | BIN(15) | WDFKDFLN | Length of data to follow. For the MSGCON keyword, this value is only the length of the message text. | |
| 6 | 6 | CHAR(*) | WDFKDFDF | Parameter for MSGCON keyword. | |
MSGCON Keyword Structure (QDFKDFMM)
MSGCON keyword structure. Use this structure for a category 23 keyword that
has a keyword ID of X'02'. All three fields are specified. This structure
follows variable WDFKDFDF in structure QDFKDFPM.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(7) | WDFKDFMI | Message ID. | |
| 7 | 7 | CHAR(10) | WDFKDFMF | Message file name. | |
| 17 | 11 | CHAR(10) | WDFKDFML | Message file library name. If the user does not specify library, *LIBL is the default. | |
HTML Keyword Structure (QDFKDFHTML)
HTML keyword structure. Use this structure for a category 23 keyword that
has a keyword ID of X'04'. This structure is defined at variable WDFKDFDF in structure QDFKDFPM.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(1) | WDFKDFHFLAG | Miscellaneous HTML tags | |
| 0 | 0 | 0 | BIT(1) | WDFKDFHPFLD | If the bit is set on, then a program-to-system field was specified on the HTML keyword. |
| 0 | 0 | 1 | BIT(7) | * | Reserved. |
| 1 | 1 | BIN(15) | WDFKDFHLEN | Length of HTML text string or program-to-system field length. | |
| 3 | 3 | BIN(15) | WDFKDFHOFF | Offset to the program-to-system field from the start of the output buffer. This field is set to zero if a program-to-system field is not used. | |
| 5 | 5 | CHAR(*) | WDFKDFHTMLTEXT | HTML text string. The length of this field is given in WDFKDFHLEN. | |
Category 24 (Field-Level Editing and Time Keywords)
The following table shows the keyword ID that corresponds to the field-level editing and time keywords.
| ID | Keyword |
|---|---|
| X'01' | EDTWRD |
| X'02' | EDTCDE |
EDIT Keyword Structure (QDFKEDTR)
Structure for editing date and time type keywords. The displacement to this structure from the beginning of the appropriate section (file, record, and field) is at variable WDFFCAOF in structure QDFFCCOA.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFKEDS | Number of keywords to follow. | |
| 2 | 2 | CHAR(*) | WDFKEDKW | EDIT keyword parameters (see structure QDFKEDTP, EDIT Keyword Structure (QDFKEDTP)). | |
EDIT Keyword Structure (QDFKEDTP)
EDIT keyword structure. Use this structure for category 24 keywords that
have keyword IDs of X'01' and X'02'. This structure is defined at variable WDFKEDKW in structure QDFKEDTR. The structure is
ARRAY(*).
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(1) | WDFKEDID | Keyword ID. | |
| 1 | 1 | CHAR(1) | WDFKEDSY | Zero suppress or fill character for the EDTCDE keyword. | |
| 2 | 2 | BIN(15) | WDFKEDML | Length of the edit mask. | |
| 4 | 4 | CHAR(1) | * | Reserved. | |
| 5 | 5 | CHAR(*) | WDFKEDMS | The edit mask for the EDTCDE and EDTWRD keywords. | |
Category 25 (GET Validation Keywords)
The following table shows the keyword ID that corresponds to the GET validation keywords.
| ID | Keyword | ID | Keyword | ID | Keyword |
|---|---|---|---|---|---|
| X'01' | RANGE | X'07' | CMP(LE) | X'0D' | CHECK(M11) |
| X'02' | VALUES | X'08' | CMP(LT) | X'0E' | CHECK(VN) |
| X'03' | CMP(GT) | X'09' | CMP(NL) | X'0F' | CHECK(VNE) |
| X'04' | CMP(GE) | X'0A' | CMP(NG) | X'10' | CHECK(M10F) |
| X'05' | CMP(EQ) | X'0B' | CHKMSGID | X'11' | CHECK(M11F) |
| X'06' | CMP(NE) | X'0C' | CHECK(M10) |
Validity Checking Keyword Structure (QDFKVAKW)
Structure for validity-checking type keywords. The displacement to this structure from the beginning of the appropriate section (file, record, or field) is at variable WDFFCAOF in structure QDFFCCOA.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFKVAL | Number of validity checking structures to follow. This value is 1. If the CHKMSGID keyword is present, variable WDFKCMID in structure QDFKVARL is set on and structure QDFKCKMI (CHKMSGID Keyword Structure (QDFKCKMI)) is present. | |
| 2 | 2 | CHAR(*) | WDFKVACK | Validity checking keywords (see structure QDFKVARL, Validity Checking Keywords (QDFKVARL)). | |
Validity Checking Keywords (QDFKVARL)
Validity-checking type keywords. Use this structure for category 25 keywords
that have keyword IDs of X'01' through X'11'. This structure is defined at
variable WDFKVACK in structure QDFKVAKW.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(1) | WDFKVALC | Miscellaneous flags. | |
| 0 | 0 | 0 | BIT(1) | WDFKM10F | If on, CHECK(M10F) keyword is specified. |
| 0 | 0 | 1 | BIT(1) | WDFKM11F | If on, CHECK(M11F) keyword is specified. |
| 0 | 0 | 2 | BIT(1) | WDFKCHVN | If on, CHECK(VN) keyword is specified. |
| 0 | 0 | 3 | BIT(1) | WDFKCHVE | If on, CHECK(VNE) keyword is specified. f |
| 0 | 0 | 4 | BIT(1) | WDFKCMID | If on, CHKMSGID keyword is specified. The structure QDFKCKMI (CHKMSGID Keyword Structure (QDFKCKMI)) is present. |
| 0 | 0 | 5 | BIT(1) | WDFKM10 | If on, CHECK(M10) keyword is specified. |
| 0 | 0 | 6 | BIT(1) | WDFKM11 | If on, CHECK(M11) keyword is specified. |
| 0 | 0 | 7 | BIT(1) | * | Reserved. |
| 1 | 1 | CHAR(1) | WDFKVALB | Flags for CMP, RANGE, and VALUE keywords. | |
| 1 | 1 | 0 | BIT(4) | WDFKVAL | B'0000' indicates NONE, B'0001' indicates RANGE,
B'0010' indicates VALUE, B'0011' indicates CMP(GT), B'0100' indicates CMP(GE or
NL), B'0101' indicates CMP(EQ), B'0110' indicates CMP(NE), B'0111' indicates
CMP(LE or NG), and B'1000' indicates CMP(LT). |
| 1 | 1 | 4 | BIT(4) | * | Reserved. |
| 2 | 2 | CHAR(1) | * | Reserved. | |
| 3 | 3 | CHAR(1) | WDFKVATP | Type of parameters. If a parameter has graphic literals, this value is X'03'. If any parameter has DBCS literals, this value is X'08'. Otherwise, this field contains 0. | |
| 4 | 4 | BIN(15) | WDFKLAP | Number of parameters. | |
| 6 | 6 | BIN(15) | WDFKLATP | Total length of parameters. (Each parameter length is WDFFPLEN in structure QDFFFNAM.) | |
| 8 | 8 | CHAR(*) | WDFKAPRM | Validity checking keywords (see structure QDFKCKMI, CHKMSGID Keyword Structure (QDFKCKMI)). This structure is present if variable WDFKCMID in this structure is on. | |
CHKMSGID Keyword Structure (QDFKCKMI)
CHKMSGID keyword structure. This structure is present if variable WDFKCMID
in structure QDFKVARL is on. This structure is defined at variable WDFKAPRM in structure QDFKVARL.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(7) | WDFKCKMD | Message identifier. | |
| 7 | 7 | CHAR(10) | WDFKCKMF | Message file name. | |
| 17 | 11 | CHAR(10) | WDFKCKML | Message file library name. | |
| 27 | 1B | BIN(15) | WDFKCKDL | Message data length. Length of field that contains message data name. If no message data name exists, this is set to 0. | |
| 29 | 1D | BIN(15) | WDFKCKB | Output buffer displacement to message data field. | |
Category 26 (Field-Level Keywords for CUA Constructs)
The following table shows the keyword ID that corresponds to field-level keywords for Common User Access® (CUA®) constructs. All of these keyword IDs require a structure.
Note: CHCFLD is generated internally whenever the CHOICE,
MNUBARCHC, or PSHBTNCHC keyword is specified.
| ID | Keyword | ID | Keyword |
|---|---|---|---|
| X'01' | CHCFLD | X'06' | ENTFLDATR |
| X'02' | MNUBARSEP | X'07' | FLDCSRPRG |
| X'03' | CHCAVAIL | X'08' | CNTFLD |
| X'04' | CHCSLT | X'09' | EDTMSK |
| X'05' | CHCUNAVAIL |
Field-Level CUA Keyword Structure (QDFKFCPR)
Structure for field-level CUA keywords with parameters. The displacement to
this structure from the beginning of the appropriate section (file, record, or
field) is at variable WDFFCAOF in structure
QDFFCCOA.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFKFCS | Number of keywords to follow. | |
| 2 | 2 | CHAR(*) | WDFKFCKW | Field-level CUA keywords (see structure QDFKFC, Field-Level CUA Keywords (QDFKFC)). | |
Field-Level CUA Keywords (QDFKFC)
CUA keyword structure. This structure is defined at variable WDFKFCKW in structure QDFKFCPR. The structure is
ARRAY(*).
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(1) | WDFKFCID | Keyword ID. | |
| 1 | 1 | BIN(15) | WDFKFCIN | Index into selection table. 1 indicates keyword is not optioned. | |
| 3 | 3 | BIN(15) | WDFKFCLN | Length of parameter for keyword. | |
| 5 | 5 | CHAR(*) | WDFKFCEX | Extra remaining portion for keywords. | |
CHCFLD Keyword Structure (QDFKCHC)
CHCFLD keyword structure. Use this structure for a category 26 keyword that
has a keyword ID of X'01'. This structure is defined at variable WDFKFCEX in structure QDFKFC.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFKCHCCT | Number of choice entries to follow. | |
| 2 | 2 | CHAR(10) | WDFKCHCFN | Name of the choice field. | |
| Note: The following two fields are maximum dimensions of the choice field. Set only for single- and multiple-choice selection fields and push-button fields. | |||||
| 12 | C | BIN(15) | WDFKCHCR | Maximum number of rows. | |
| 14 | E | BIN(15) | WDFKCHCC | Maximum number of columns. | |
| Note: The following two fields are selection characters to be used for multiple-choice selection fields. | |||||
| 16 | 10 | CHAR(1) | WDFKSELCHAR1 | First character to be used. | |
| 17 | 11 | CHAR(1) | WDFKSELCHAR2 | Second character to be used. | |
| 18 | 12 | CHAR(1) | * | Reserved. | |
| 19 | 13 | CHAR(*) | WDFKCHCS | Choice entries. | |
CHCFLD Keyword Header Expansion Structure (QDFKCHCHDREXP)
CHCFLD header expansion structure. If bit
WDFFCHCHDHEXP in structure QDFFXFDP is on, this structure is used. This
structure is defined at variable WDFKCHCS in
structure QDFKCHC.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFKCHCEXPLEN | Length of the CHCFLD header expansion area. | |
| 2 | 2 | BIN(15) | WDFKROWCOL | Value with either the *NUMROW or *NUMCOL parameter. Valid only if variable WDFKHORIZ in this structure is on. | |
| 4 | 4 | BIN(15) | WDFKGUTTER | Value with the *GUTTER parameter. | |
| 6 | 6 | CHAR(2) | WDFKFLAGS | Miscellaneous flags to describe how the choice fields were specified. | |
| 6 | 6 | 0 | BIT(1) | WDFKRSTCSR | If on, *RSTCSR parameter is specified on the SNGCHCFLD, MLTCHCFLD, or PSHBTNFLD keyword. |
| 6 | 6 | 1 | BIT(1) | WDFKNORSTCSR | If on, *NORSTCSR parameter is specified on the SNGCHCFLD, MLTCHCFLD, or PSHBTNFLD keyword. |
| 6 | 6 | 2 | BIT(1) | * | Reserved. |
| 6 | 6 | 3 | BIT(1) | WDFKSLTIND | If on, *SLTIND parameter is specified on the SNGCHCFLD or MLTCHCFLD keyword. |
| 6 | 6 | 4 | BIT(1) | WDFKNOSLTIND | If on, *NOSLTIND parameter is specified on the SNGCHCFLD or MLTCHCFLD keyword. |
| 6 | 6 | 5 | BIT(1) | * | Reserved. |
| 6 | 6 | 6 | BIT(1) | WDFKAUTOSLT | If on, *AUTOSLT parameter is specified on the SNGCHCFLD keyword. |
| 6 | 6 | 7 | BIT(1) | WDFKAUTOSLTEN | If on, *AUTOSLTENH parameter is specified on the SNGCHCFLD keyword. |
| 6 | 6 | 8 | BIT(1) | WDFKNOAUTOSLT | If on, *NOAUTOSLT parameter is specified on the SNGCHCFLD keyword. |
| 6 | 6 | 9 | BIT(1) | WDFKHORIZ | If on, *NUMCOL or *NUMROW parameter is specified on the SNGCHCFLD, MLTCHCFLD, or PSHBTNFLD keyword. |
| 6 | 6 | A | BIT(1) | WDFKCOLMAJOR | If on, *NUMCOL parameter is specified on the SNGCHCFLD, MLTCHCFLD, or PSHBTNFLD keyword. |
| 6 | 6 | B | BIT(1) | WDFKAUTOENT | If on, *AUTOENT parameter is specified on the SNGCHCFLD keyword. |
| 6 | 6 | C | BIT(1) | WDFKAUTOENTNN | If on, *AUTOENTNN parameter is specified on the SNGCHCFLD keyword. |
| 6 | 6 | D | BIT(1) | WDFKNOAUTOENT | If on, *NOAUTOENT parameter is specified on the SNGCHCFLD keyword. |
| 6 | 6 | E | BIT(2) | * | Reserved. |
| 7 | 7 | CHAR(10) | * | Reserved. | |
Choice Entry Structure (QDFKCHCE)
Choice entry structure. Use this structure for a category 26 keyword that
has a keyword ID of X'01'. The number of entries in this structure is defined
by variable WDFKCHCCT in structure QDFKCHC. This structure is defined at
variable WDFKCHCS in structure QDFKCHC. The
structure is ARRAY(*).
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(1) | * | Reserved. | |
| 1 | 1 | BIN(15) | WDFKCLEN | Length of this entry. Displacement to the subsequent choice entry. | |
| 3 | 3 | CHAR(1) | WDFKCFLG | Flags for choice entry. | |
| 3 | 3 | 0 | BIT(1) | WDFKCCTXT | On indicates choice text structure is specified; off indicates choice text is in a program-to-system field. |
| 3 | 3 | 1 | BIT(1) | WDFKCRTN | If on, return control specified is set only for a menu bar choice. |
| 3 | 3 | 2 | BIT(1) | WDFKCSPC | If on, *SPACEB parameter is specified on the CHOICE or PCHBTNCHC keyword. |
| 3 | 3 | 3 | BIT(1) | WDFKCPBC | If on, command key specified on choice. |
| 3 | 3 | 4 | BIT(4) | * | Reserved. |
| 4 | 4 | CHAR(2) | WDFKC | Choice number. | |
| 6 | 6 | BIN(15) | WDFKCINX26 | Index into selection string for this choice. | |
| 8 | 8 | BIN(15) | WDFKCTXTO | Displacement to choice text. If variable WDFKCCTXT is on, this is a displacement to the choice text structure (see structure QDFKCTXT, Choice Text Structure (QDFKCTXT)). If WDFKCCTXT is off, this is a buffer displacement to the field containing the choice text. | |
| 10 | A | BIN(15) | WDFKCTXTL | Choice text length. If choice text string is specified, this is the length of the text including trailing blanks. If choice text is a program-to-system field, this is the length of the program-to-system field. | |
| 12 | C | BIN(15) | WDFKCMSGO | Displacement to CHCCTL keyword structure (see structure QDFKCMSG, CHCCTL Keyword Structure (QDFKCMSG)). This is set only for a selection field choice (single or multiple). 0 indicates no message is specified. | |
| 14 | E | BIN(15) | WDFKCACCO | Displacement to the accelerator text structure (see structure QDFKCACC, CHCACCEL Keyword Structure (QDFKCACC)). 0 indicates accelerator text is not specified. | |
| 16 | 10 | CHAR(10) | WDFKCPRCD | Name of pull-down record. Set only for a menu bar choice. | |
| 16 | 10 | CHAR(1) | WDFKCPBCAID | AID code specified on the push button choice. X'31' through X'3C' indicates CA/CF01-12, X'70' through X'7F' indicates E00-E15, X'B1' through X'BC' indicates CA/CF13-24, X'BD' indicates CLEAR, X'F1' indicates ENTER, X'F3' indicates HELP, X'F4' indicates Roll Down, X'F5' indicates Roll Up, X'F6' indicates Print, and X'F8' indicates Home. | |
| 17 | 11 | CHAR(9) | * | Reserved. | |
| 26 | 1A | BIN(15) | WDFKCRTNO | Buffer displacement to the menu bar return field (see structure QDFKMBSEPS, MNUBARSEP Keyword Structure (QDFKMBSEPS)). Set only for a menu bar choice. -1 indicates no return field is specified. | |
| 28 | 1C | BIN(15) | WDFKCRTNL | Length of the return field. | |
| 30 | 1E | BIN(15) | WDFKCCTLO | Buffer displacement to the choice control field (see structure QDFKCMSG, CHCCTL Keyword Structure (QDFKCMSG)). This is in the output buffer. -1 indicates no control field is specified. | |
| 32 | 20 | BIN(15) | WDFKCCTLIO | Buffer displacement to the choice control field (see structure QDFKCMSG, CHCCTL Keyword Structure (QDFKCMSG)). This is in the input buffer. -1 indicates no control field is specified. | |
| 34 | 22 | CHAR(*) | WDFKCV | Additional structures. | |
Choice Text Structure (QDFKCTXT)
Choice text structure. The length of the text is in the fixed choice entry
string (variable WDFKCTXTL in structure QDFKCHCE).
The displacement to this structure from the beginning of structure QDFKCHCE is
at variable WDFKCTXTO in QDFKCHCE.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFKCMNEM | Position of the mnemonic. 0 indicates no mnemonic is specified. | |
| 2 | 2 | CHAR(*) | WDFKCTXTT | Choice text (including trailing blanks). | |
CHCACCEL Keyword Structure (QDFKCACC)
CHCACCEL keyword structure. The displacement to this structure from the
beginning of structure QDFKCHCE is at variable
WDFKCACCO in QDFKCHCE.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFKCACCSL | Length of accelerator structure. | |
| 2 | 2 | BIN(15) | WDFKCACCL | Length of text or variable for accelerator. | |
| 4 | 4 | BIN(15) | WDFKCACCFO | Displacement into the output buffer for the accelerator program-to-system field. -1 indicates no accelerator program-to-system field is specified. | |
| 6 | 6 | CHAR(*) | WDFKCACCT | Accelerator text. | |
CHCCTL Keyword Structure (QDFKCMSG)
CHCCTL keyword structure. The displacement to this structure from the
beginning of structure QDFKCHCE is at variable
WDFKCCTLO in QDFKCHCE.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(1) | WDFKCMFLG | Message flags. | |
| 0 | 0 | 0 | BIT(1) | WDFKCMIDP | On indicates the message ID is the buffer displacement to program-to-system field; off indicates the actual message ID is specified. |
| 0 | 0 | 1 | BIT(1) | WDFKCMFLP | On indicates the message file is the buffer displacement to program-to-system field; off indicates the actual message file is specified. |
| 0 | 0 | 2 | BIT(1) | WDFKCMLBP | On indicates the message file library is the buffer displacement to program-to-system field; off indicates the actual message library is specified. |
| 0 | 0 | 3 | BIT(5) | * | Reserved. |
| 1 | 1 | CHAR(7) | WDFKCMID26 | Message ID. | |
| 1 | 1 | BIN(15) | WDFKMIDO | Buffer displacement to field that contains the message ID. | |
| 3 | 3 | CHAR(5) | * | Reserved. | |
| 8 | 8 | CHAR(10) | WDFKCMFL | Message file name. | |
| 8 | 8 | BIN(15) | WDFKCMFLO | Buffer displacement to field that contains the message file. | |
| 10 | A | CHAR(8) | * | Reserved. | |
| 18 | 12 | CHAR(10) | WDFKCMLB | Message file library name. | |
| 18 | 12 | BIN(15) | WDFKCMLBO | Buffer displacement to field that contains the message library. | |
| 20 | 14 | CHAR(8) | * | Reserved. | |
MNUBARSEP Keyword Structure (QDFKMBSEPS)
MNUBARSEP keyword structure. Use this structure for a category 26 keyword
that has a keyword ID of X'02'. This structure is defined at variable WDFKFCEX in structure QDFKFC.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(1) | WDFKMBSEPF | MNUBARSEP keyword flags. | |
| 0 | 0 | 0 | BIT(1) | WDFKMBSCP | On indicates the color is specified in a
program-to-system field; off indicates the actual color is specified.
Note: If on, use variable WDFKMBSCO; otherwise, use variable WDFKMBSCLR. |
| 0 | 0 | 1 | BIT(1) | WDFKMBSAP | On indicates the display attribute is specified
in a program-to-system field; off indicates the actual attribute is specified.
Note: If on, use variable WDFKMBSAO; otherwise, use variable WDFKMBSATR. |
| 0 | 0 | 2 | BIT(1) | WDFKMBSHP | On indicates the character is specified in a
program-to-system field; off indicates the actual character is specified.
Note: If on, use variable WDFKMBSCHO; otherwise, use variable WDFKMBSCHR. |
| 0 | 0 | 3 | BIT(5) | * | Reserved. |
| 1 | 1 | BIN(15) | WDFKMBSCO | Buffer displacement to field that contains the color. | |
| 1 | 1 | CHAR(1) | WDFKMBSCLR | Actual value for *COLOR. X'00' indicates not specified, X'3A' indicates BLU, X'20' indicates GRN, X'22' indicates WHT, X'28' indicates RED, X'30' indicates TRQ, X'32' indicates YLW, and X'38' indicates PNK. | |
| 2 | 2 | CHAR(1) | * | Reserved. | |
| 3 | 3 | BIN(15) | WDFKMBSAO | Buffer displacement to field that contains the attribute. | |
| 3 | 3 | CHAR(1) | WDFKMBSATR | Actual value for *DSPATR. Combination of two or more of these values: X'00' indicates no attribute, X'30' indicates (*DSPATR CS), X'28' indicates (*DSPATR BL), X'24' indicates (*DSPATR UL), X'22' indicates (*DSPATR HI), X'21' indicates (*DSPATR RI), and X'27' indicates (*DSPATR ND). If multiple values are specified, they are ORed together. | |
| 4 | 4 | CHAR(1) | * | Reserved. | |
| 5 | 5 | BIN(15) | WDFKMBSCHO | Buffer displacement to field that contains the separator character. | |
| 5 | 5 | CHAR(1) | WDFKMBSCHR | Actual separator character. X'00' indicates not specified. | |
| 6 | 6 | CHAR(1) | * | Reserved. | |
Choice Keywords Structure (QDFKCHCX)
Structure for CHCAVAIL, CHCSLT, and CHCUNAVAIL keywords. Use this structure
for category 26 keywords that have keyword IDs of X'03', X'04', and X'05'. This
structure is defined at variable WDFKFCEX in
structure QDFKFC.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(1) | * | Reserved. | |
| 1 | 1 | CHAR(1) | WDFKCHCCLR | Color (from the MNUBARSEP keyword). | |
| 2 | 2 | CHAR(1) | * | Reserved. | |
| 3 | 3 | CHAR(1) | WDFKCHCATR | Display attribute. Combination of two or more of these values: X'00' indicates no attribute, X'30' indicates (*DSPATR CS), X'28' indicates (*DSPATR BL), X'24' indicates (*DSPATR UL), X'22' indicates (*DSPATR HI), X'21' indicates (*DSPATR RI), and X'27' indicates (*DSPATR ND). | |
| 4 | 4 | CHAR(1) | * | Reserved. | |
ENTFLDATR Keyword Structure (QDFKEFATR)
ENTFLDATR keyword structure. Use this structure for a category 26 keyword
that has a keyword ID of X'06'. This structure is defined at variable WDFKFCEX in structure QDFKFC.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(1) | WDFKEFATRF | Entry field attribute flags. | |
| 0 | 0 | 0 | BIT(1) | WDFKEFACP | On indicates the color is a program-to-system field; off indicates the actual color is specified. |
| 0 | 0 | 1 | BIT(1) | WDFKEFAAP | On indicates the attribute is a program-to-system field; off indicates the actual attribute is specified. |
| 0 | 0 | 2 | BIT(1) | WDFKEFACV | On indicates the cursor is visible; off indicates the cursor is invisible. |
| 0 | 0 | 3 | BIT(5) | * | Reserved. |
| 1 | 1 | CHAR(1) | WDFKEFACLR | Actual color. X'00' indicate no color is specified. | |
| 2 | 2 | CHAR(1) | * | Reserved. | |
| 3 | 3 | CHAR(1) | WDFKEFAATR | Actual attribute. X'00' indicate no attribute is specified. | |
| 4 | 4 | CHAR(1) | * | Reserved. | |
FLDCSRPRG Keyword Structure (QDFKFLDCP)
FLDCSRPRG keyword structure. Use this structure for a category 26 keyword
that has a keyword ID of X'07'. This structure is defined at variable WDFKFCEX in structure QDFKFC.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFKFCPFLDNUM | Field number. | |
| 2 | 2 | CHAR(1) | * | Reserved. | |
CNTFLD Keyword Structure (QDFKCNTFLD)
CNTFLD keyword structure. Use this structure for a category 26 keyword that
has a keyword ID of X'08'. This structure is defined at variable WDFKFCEX in structure QDFKFC.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFKCNTFLDNUM | Width of segment. | |
| 2 | 2 | CHAR(1) | * | Reserved. | |
EDTMSK Keyword Structure (QDFKEDTMSK)
EDTMSK keyword structure. Use this structure for a category 26 keyword that
has a keyword ID of X'09'. This structure is defined at variable WDFKFCEX in structure QDFKFC.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFKEDMNUM | Number of segments. | |
| 2 | 2 | CHAR(*) | WDFKEDMSEG | EDTMSK keyword segment structure (see structure QDFKEDTSEG, EDTMSK Keyword Segment Structure (QDFKEDTSEG)). | |
EDTMSK Keyword Segment Structure (QDFKEDTSEG)
Segment structure for EDTMSK keyword. This structure is defined at variable
WDFKEDMSEG in structure QDFKEDTMSK.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFKEDMPOS | Position of segment. | |
| 2 | 2 | BIN(15) | WDFKEDMLEN | Length of segment. | |
SFLCHCCTL Message Structure (QDFKSMSG)
SFLCHCCTL message structure. This structure is defined at variable WDFKFCEX in structure QDFKFC.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(1) | WDFKSMFLG | Flags for SFLCHCCTL keyword. | |
| 0 | 0 | 0 | BIT(1) | WDFKSMIDP | If on, message ID is buffer displacement to program-to-system field. |
| 0 | 0 | 1 | BIT(1) | WDFKSMFLP | If on, message file is buffer displacement to program-to-system field. |
| 0 | 0 | 2 | BIT(1) | WDFKSMLBP | If on, message library is buffer displacement to program-to-system field. |
| 0 | 0 | 3 | BIT(5) | * | Reserved. |
| 1 | 1 | CHAR(7) | WDFKSMID | Message ID. | |
| 1 | 1 | BIN(15) | WDFKSMIDO | Output buffer displacement to the field containing the message ID. | |
| 3 | 3 | CHAR(5) | * | Reserved. | |
| 8 | 8 | CHAR(10) | WDFKSMFL | Message file name. | |
| 8 | 8 | BIN(15) | WDFKSMFLO | Output buffer displacement to the field containing the message file name. | |
| 10 | A | CHAR(8) | * | Reserved. | |
| 18 | 12 | CHAR(10) | WDFKSMLB | Message library name. | |
| 18 | 12 | BIN(15) | WDFKSMLBO | Output buffer displacement to the field containing the message library name. | |
| 20 | 14 | CHAR(8) | * | Reserved. | |
Category 27 Keywords (Record-Level Grid Keywords with Parameters)
The following table shows the keyword ID that corresponds to category 27 keywords. All of these keyword IDs require a structure.
| ID | Keyword |
|---|---|
| X'01' | GRDATR |
| X'02' | GRDCLR |
| X'03' | GRDBOX |
| X'04' | GRDLIN |
Record-Level Grid Keywords with Parameters Structure (QDFKGRPR)
Record-level grid keywords with parameters. The displacement to this structure from the beginning of the appropriate section (file, record, or field) is at variable WDFFCAOF in structure QDFFCCOA.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFKPCNT | Number of keywords to follow. | |
| 2 | 2 | CHAR(*) | WDFKGRKW | Category 27 parameter entries (see structure QDFKGRWP, Record-Level Grid Keywords (QDFKGRWP)). | |
Record-Level Grid Keywords (QDFKGRWP)
Record-level grid keywords. This structure is defined at variable wdfkgrkw in structure QDFKGRPR.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(1) | WDFKGPID | Keyword ID. | |
| 1 | 1 | BIN(15) | WDFKGPIN | Index into selection table. 1 indicates keyword is not optioned. | |
| 3 | 3 | BIN(15) | WDFKGPLN | Length of parameter for keyword. | |
| 5 | 5 | CHAR(*) | WDFKGPEX | Extra remaining portion for keywords. Actual length is in variable WDFKMPLN in structure QDFKMRWP. | |
GRDATR Parameters (QDFKGRDATR)
GRDATR parameters. Use this structure for category 27 keywords that have a
keyword ID of X'01'. The structure is defined at variable WDFKGPEX in structure QDFKGRWP.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFKGCLRO | Buffer displacement to program-to-system field for color. | |
| 0 | 0 | CHAR(1) | WDFKGCLOR | Color parameter. X'FE' indicates not specified. | |
| 1 | 1 | CHAR(1) | * | Reserved. | |
| 2 | 2 | BIN(15) | WDFKGLNTO | Buffer displacement to program-to-system field for line type. | |
| 2 | 2 | CHAR(1) | WDFKGLT | Line type. X'FE' indicates not specified. | |
| 3 | 3 | CHAR(1) | * | Reserved. | |
| 4 | 4 | CHAR(1) | WDFKGCBIT | Miscellaneous flags. | |
| 4 | 4 | 0 | BIT(1) | WDFKGCLRP | If on, program-to-system field was used for color. |
| 4 | 4 | 1 | BIT(1) | WDFKGLNTP | If on, program-to-system field was used for line type. |
| 4 | 4 | 2 | BIT(6) | * | Reserved. |
GRDCLR Parameters Structure (QDFKGRDCLR)
GRDCLR parameters structure. Use this structure for category 27 keywords
that have a keyword ID of X'02'. The structure is defined at variable WDFKGPEX in structure QDFKGRWP. The structure is
ARRAY(*).
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(1) | WDFGCFLG | Miscellaneous flags. | |
| 0 | 0 | 0 | BIT(1) | WDFKGCSRP | If on, program-to-system field was used for
start-row.
Note: If on, use variable WDFKGCSRO; otherwise, use variable WDFKGCSROW. |
| 0 | 0 | 1 | BIT(1) | WDFKGCSCP | If on, program-to-system field was used for
start-column.
Note: If on, use variable WDFKGCSCO; otherwise, use variable WDFKGCSCOL. |
| 0 | 0 | 2 | BIT(1) | WDFKGCDP | If on, program-to-system field was used for
depth.
Note: If on, use variable WDFKGCDEO; otherwise, use variable WDFKGCDEP. |
| 0 | 0 | 3 | BIT(1) | WDFKGCWP | If on, program-to-system field was used for
width.
Note: If on, use variable WDFKGCWIO; otherwise, use variable WDFKGCWID. |
| 0 | 0 | 4 | BIT(1) | WDFKGCNP | If on, no parameters are specified on keyword. Clear all grid lines. |
| 0 | 0 | 5 | Bit(3) | * | Extra bits. |
| 1 | 1 | BIN(15) | WDFKGCSROW | Start row. | |
| 1 | 1 | BIN(15) | WDFKGCSRO | Buffer displacement to program-to-system field for row. | |
| 3 | 3 | BIN(15) | WDFKGCSCOL | Start column. | |
| 3 | 3 | BIN(15) | WDFKGCSCO | Buffer displacement to program-to-system field for column. | |
| 5 | 5 | BIN(15) | WDFKGCDEP | Depth. | |
| 5 | 5 | BIN(15) | WDFKGCDEO | Buffer displacement to program-to-system field for depth. | |
| 7 | 7 | BIN(15) | WDFKGCWID | Width. | |
| 7 | 7 | BIN(15) | WDFKGCWIO | Buffer displacement to program-to-system field for width. | |
GRDBOX Parameters (QDFKGRDBOX)
GRDBOX parameters. Use this structure for category 27 keywords that have a
keyword ID of X'03'. The structure is defined at variable WDFKGPEX in structure QDFKGRWP.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(1) | WDFKGBBIT | Miscellaneous flags. | |
| 0 | 0 | 0 | BIT(1) | WDFKGBHZP | If on, program-to-system field was used for HRZ
rule *TYPE parameter.
Note: If on, use variable WDFKGBHZO; otherwise, use variable WDFKGHZV. |
| 0 | 0 | 1 | BIT(1) | WDFKGBVTP | If on, program-to-system field was used for VRT
rule *TYPE parameter.
Note: If on, use variable WDFKGBVTO; otherwise, use variable WDFKGVTV. |
| 0 | 0 | 2 | BIT(1) | WDFKGBCLP | If on, program-to-system field was used for
color.
Note: If on, use variable WDFKGBCLO; otherwise, use variable WDFKGBCLR. |
| 0 | 0 | 3 | BIT(1) | WDFKGBLTP | If on, program-to-system field was used for line
type.
Note: If on, use variable WDFKGBLTO; otherwise, use variable WDFKGBLNT. |
| 0 | 0 | 4 | BIT(4) | * | Reserved. |
| 1 | 1 | CHAR(1) | WDFKGBTOB | Type of box. X'04' indicates not specified or PLAIN, X'05' indicates HRZ, X'06' indicates VRT, and X'07' indicates HRZVRT. | |
| 2 | 2 | BIN(15) | WDFKGBHZO | Buffer displacement to program-to-system field for horizontal rule on *TYPE parameter. | |
| 2 | 2 | BIN(15) | WDFKGHZV | Horizontal rule value. X'01' indicates not specified. | |
| 4 | 4 | BIN(15) | WDFKGBVTO | Buffer displacement to program-to-system field for vertical rule on *TYPE parameter. | |
| 4 | 4 | BIN(15) | WDFKGVTV | Vertical rule value. X'01' indicates not specified. | |
| 6 | 6 | BIN(15) | WDFKGBCLO | Buffer displacement to program-to-system field for color. | |
| 6 | 6 | CHAR(1) | WDFKGBCLR | Color parameter. X'FE' indicates not specified. | |
| 7 | 7 | CHAR(1) | * | Reserved. | |
| 8 | 8 | BIN(15) | WDFKGBLTO | Buffer displacement to program-to-system field for line type. | |
| 8 | 8 | CHAR(1) | WDFKGBLNT | Line type. X'00' indicates not specified. | |
| 9 | 9 | CHAR(1) | * | Reserved. | |
| 10 | A | BIN(15) | WDFKGBCTLO | Buffer displacement to program-to-system field for *CONTROL parameter. -1 indicates not specified. | |
| 12 | C | CHAR(*) | WDFKGBOXD | Array for parameters that are display-size dependent. There is one entry for each display size for the file (see structure QDFKGBOXDFM, GRDBOX Parameter Entry Structure (QDFKGBOXDFM)). | |
GRDBOX Parameter Entry Structure (QDFKGBOXDFM)
GRDBOX parameter entry structure. The number of entries in this structure is
defined by variable WDFFSCR in structure QDFFBASE.
This structure is defined at variable WDFKGBOXD in
structure QDFKGRDBOX. This structure is ARRAY(*).
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(1) | WDFKGBFLG | Miscellaneous flags. | |
| 0 | 0 | 0 | BIT(1) | WDFKGBSRP | If on, program-to-system field was used for
start-row.
Note: If on, use variable WDFKGBSRO; otherwise, use variable WDFKGBSROW. |
| 0 | 0 | 1 | BIT(1) | WDFKGBSCP | If on, program-to-system field was used for
start-column.
Note: If on, use variable WDFKGBSCO ; otherwise, use variable WDFKGBSCOL. |
| 0 | 0 | 2 | BIT(1) | WDFKGBDP | If on, program-to-system field was used for
depth.
Note: If on, use variable WDFKGBDEO; otherwise, use variable WDFKGBDEP. |
| 0 | 0 | 3 | BIT(1) | WDFKGBWP | If on, program-to-system field was used for
width.
Note: If on, use variable WDFKGBWIO; otherwise, use variable WDFKGBWID. |
| 0 | 0 | 4 | BIT(4) | * | Reserved. |
| 1 | 1 | BIN(15) | WDFKGBSROW | Start row, | |
| 1 | 1 | BIN(15) | WDFKGBSRO | Buffer displacement to program-to-system field for row. | |
| 3 | 3 | BIN(15) | WDFKGBSCOL | Start column. | |
| 3 | 3 | BIN(15) | WDFKGBSCO | Buffer displacement to program-to-system field for column. | |
| 5 | 5 | BIN(15) | WDFKGBDEP | Depth. | |
| 5 | 5 | BIN(15) | WDFKGBDEO | Buffer displacement to program-to-system field for depth. | |
| 7 | 7 | BIN(15) | WDFKGBWID | Width. | |
| 7 | 7 | BIN(15) | WDFKGBWIO | Buffer displacement to program-to-system field for width. | |
GRDLIN Parameters Structure (QDFKGRDLIN)
GRDLIN parameters structure. Use this structure for category 27 keywords
that have a keyword ID of X'04'. The structure is defined at variable WDFKGPEX in structure QDFKGRWP.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(1) | WDFKGLBIT | Miscellaneous flags. | |
| 0 | 0 | 0 | BIT(1) | WDFKGLIVP | If on, program-to-system field was used for
interval on *TYPE parameter.
Note: If on, use variable WDFKGLINO; otherwise, use variable WDFKGLINT. |
| 0 | 0 | 1 | BIT(1) | WDFKGLRPP | If on, program-to-system field was used for
repeat on *TYPE parameter.
Note: If on, use variable WDFKGLRPO; otherwise, use variable WDFKGLRPT. |
| 0 | 0 | 2 | BIT(1) | WDFKGLCLP | If on, program-to-system field was used for
color.
Note: If on, use variable WDFKGLCLO; otherwise, use variable WDFKGLCLR. |
| 0 | 0 | 3 | BIT(1) | WDFKGLLTP | If on, program-to-system field was used for line
type.
Note: If on, use variable WDFKGLLTO; otherwise, use variable WDFKGLLNT. |
| 0 | 0 | 4 | BIT(4) | * | Reserved. |
| 1 | 1 | CHAR(1) | WDFKGLTYPL | Type of line. X'00' indicates UPPER or not specified, X'01' indicates LOWER, X'02' indicates left, and X'03' indicates RIGHT. | |
| 2 | 2 | BIN(15) | WDFKGLINO | Buffer displacement to program-to-system field for interval. | |
| 2 | 2 | BIN(15) | WDFKGLINT | Interval. Set to 1 if not specified. | |
| 4 | 4 | BIN(15) | WDFKGLRPO | Buffer displacement to program-to-system field for repeat. | |
| 4 | 4 | BIN(15) | WDFKGLRPT | Repeat. Set to 1 if not specified. | |
| 6 | 6 | BIN(15) | WDFKGLCLO | Buffer displacement to program-to-system field for color. | |
| 6 | 6 | CHAR(1) | WDFKGLCLR | Color parameter. X'FE' indicates not specified. | |
| 7 | 7 | CHAR(1) | * | Reserved. | |
| 8 | 8 | BIN(15) | WDFKGLLTO | Buffer displacement to program-to-system field for line type. | |
| 8 | 8 | CHAR(1) | WDFKGLLNT | Line type. X'FE' indicates not specified. | |
| 9 | 9 | CHAR(1) | * | Reserved. | |
| 10 | A | BIN(15) | WDFKGLCTLO | Buffer displacement to program-to-system field for *CONTROL parameter. -1 indicates not specified. | |
| 12 | C | CHAR(*) | WDFKGLIND | Array for parameters that are display-size dependent (see structure QDFKGLINDFM, GRDLIN Parameter Entry Structure (QDFKGLINDFM)). | |
GRDLIN Parameter Entry Structure (QDFKGLINDFM)
GRDLIN parameter entry structure. The number of entries in this structure is
defined by variable WDFFSCR in structure QDFFBASE.
This structure is defined at variable WDFKGLIND in
structure QDFKGRDLIN. This structure is ARRAY(*).
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(1) | WDFKGLMISC | Miscellaneous flags. | |
| 0 | 0 | 0 | BIT(1) | WDFKGLSRP | If on, program-to-system field was used for
start-row.
Note: If on, use variable WDFKGLSRO; otherwise, use variable WDFKGLSROW. |
| 0 | 0 | 1 | BIT(1) | WDFKGLSCP | If on, program-to-system field was used for
start-column.
Note: If on, use variable WDFKGLSCO; otherwise, use variable WDFKGLSCOL. |
| 0 | 0 | 2 | BIT(1) | WDFKGLLTH | If on, program-to-system field was used for
length.
Note: If on, use variable WDFKGLLNO ; otherwise, use variable WDFKGLLEN. |
| 0 | 0 | 3 | Bit(5) | * | Reserved. |
| 1 | 1 | BIN(15) | WDFKGLSROW | Start row. | |
| 1 | 1 | BIN(15) | WDFKGLSRO | Buffer displacement to program-to-system field for row. | |
| 3 | 3 | BIN(15) | WDFKGLSCOL | Start column. | |
| 3 | 3 | BIN(15) | WDFKGLSCO | Buffer displacement to program-to-system field for column. | |
| 5 | 5 | BIN(15) | WDFKGLLEN | Length. | |
| 5 | 5 | BIN(15) | WDFKGLLNO | Buffer displacement to program-to-system field for length. | |
Where-Used Formats
Where-Used Section shows the where-used section of the overview figure (DSPF0100 Format).
Where-Used Section
Where-Used File-Level Information Structure (QDFWFLEI)
The tables in this section can be used to map to the row-column table to determine the corresponding entry in the applicable keyword table. (For the row-column table, see structure QDFFRCTB on Row-Column Table (QDFFRCTB).) The where-used entries appear from left to right and top to bottom. The keyword entries appear in the same order as defined by the user.
File level information. The displacement to this structure from the
beginning of structure QDFFINFO is at variable WDFFWUOF in QDFFINFO.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFWXLEN | Length of the file section. This is also a displacement from this structure to the first record section defined by structure QDFWRCDI (Where-Used Record Information Structure (QDFWRCDI)). 0 indicates internally defined files or where no record- or field-level sections exist. | |
| 2 | 2 | BIN(15) | WDFWXOKW | Displacement to a keyword area structure from this structure. 0, if none (see structure QDFWKWDA, Keyword Area Structure (QDFWKWDA)). | |
| 4 | 4 | BIN(31) | WDFWWULN | Length of the where-used section. | |
| 8 | 8 | BIN(31) | WDFWNTBO | Displacement from this structure to the name table defined by structure QDFFNTBL (Name Table Structure (QDFFNTBL)). 0 indicates the name table is not present. | |
| 12 | C | BIN(15) | WDFWXIN | Number of indicator table entries (see variable WDFWINDX in this structure). | |
| 14 | E | CHAR(4) | * | Reserved. | |
| 18 | 12 | CHAR(*) | WDFWINDX | Indicator table entry structure containing the file-level indicator entries. Each entry is defined by structure QDFWITBE (page Indicator Table Entry Structure (QDFWITBE)). | |
Where-Used Record Information Structure (QDFWRCDI)
Record-level information. The displacement to this structure from the beginning of structure QDFWFLEI is at variable WDFWXLEN in QDFWFLEI. Displacements to subsequent structures are calculated using WDFWNXTR in this structure.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFWRLEN | Length of record-level where-used section. Also, this is the displacement from this structure to the first field if there is one in structure QDFWFLDI (Where-Used Field Information Structure (QDFWFLDI)). | |
| 2 | 2 | BIN(15) | WDFWROKW | Displacement to a keyword area structure from this structure (see structure QDFWKWDA, Keyword Area Structure (QDFWKWDA)). 0 indicates no where-used keywords. | |
| 4 | 4 | BIN(31) | WDFWNXTR | Length of entire where-used section for this record. This is also the displacement from this record to the next record entry. | |
| 8 | 8 | BIN(15) | WDFWRIN | Number of indicator table entries (see variable WDFWINDR in this structure). | |
| 10 | A | CHAR(2) | * | Reserved. | |
| 12 | C | CHAR(*) | WDFWINDR | Indicator table containing the record-level indicator entries. These entries with the file indicator table are all the indicators (optioned and response) that are valid for this record. Each entry is defined by structure QDFWITBE (Indicator Table Entry Structure (QDFWITBE)). | |
Where-Used Field Information Structure (QDFWFLDI)
Field-level information (including constants). The displacement to this
structure from the beginning of structure QDFWRCDI is at variable WDFWRLEN in QDFWRCDI. Displacements to subsequent structures
are calculated using WDFWFLDL in this structure.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFWFLDL | Length of field-level where-used section. Also, this is the displacement from this structure to the next field, if there is one. | |
| 2 | 2 | BIN(15) | WDFWFOKW | Displacement to where-used keywords from this structure. 0, if none (see structure QDFWKWDA, Keyword Area Structure (QDFWKWDA)). | |
| 4 | 4 | BIN(15) | WDFWRRDX | Index into field indexing table (see structure QDFFFITB, Field Indexing Table (QDFFFITB)) for this field. | |
| 6 | 6 | BIN(31) | WDFWNMEI | Index into the name table (see structure QDFFNTBL, Name Table Structure (QDFFNTBL)) for this field. 0 indicates constants. | |
| 10 | A | BIN(15) | WDFWLFLD | Specified length of field (DDS field length). For floating-point fields, variable WDFWLFLD equals variable WDFFDLEN minus 7. | |
| 12 | C | CHAR(1) | WDFWFFLG | Keyword flags. | |
| 12 | C | 0 | BIT(1) | WDFWRFFD | If on, REFFLD keyword is specified. |
| 12 | C | 1 | BIT(1) | WDFWMGDO | If on, MSGID keyword is specified on an output-only field. |
| 12 | C | 2 | BIT(1) | WDFWMGDB | If on MSGID keyword is specified on a both field. |
| 12 | C | 3 | BIT(5) | * | Reserved. |
| 13 | D | CHAR(1) | * | Reserved. | |
Indicator Table Entry Structure (QDFWITBE)
Indicator table entry. These entries are obtained from the keywords and
their values. This structure is defined at variable
WDFWINDX in structure QDFWFLEI and variable
WDFWINDR in structure QDFWRCDI.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(1) | WDFWINBR | Indicator number. | |
| 1 | 1 | CHAR(1) | WDFWIOBF | Output buffer displacement. X'FF' indicates not used as an option indicator. | |
| 2 | 2 | CHAR(1) | WDFWIIBF | Input buffer displacement X'FF' indicates not used as a response indicator. | |
| 3 | 3 | BIN(15) | WDFWITXT | Indicator text displacement. File-level displacement is from structure QDFWFLEI to the indicator text for this indicator. Record-level displacement is from structure QDFWRCDI to the indicator text for this indicator. The format of the text is an A-type parameter (see structure QDFWATYP, Variable Length Structure (QDFWATYP)). | |
Keyword Area Structure (QDFWKWDA)
Keyword area. For file-level keywords, this structure is defined at variable
WDFWXOKW in structure QDFWFLEI. For record-level
keywords, this structure is defined at variable
WDFWROKW in structure QDFWRCDI. For field-level keywords, this structure is
defined at variable WDFWFOKW in structure
QDFWFLDI.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFWKWDC | Keyword count.) | |
| 2 | 2 | CHAR(*) | WDFWKWDS | Keyword entries. | |
Keyword Entry Structure (QDFWATTR)
Keyword entries. Keyword Types shows the keyword types that correspond to the keyword entries and the specific structure that each keyword type uses. This figure also shows which keyword types do not require a structure.
Keyword Types
| Keyword Type | Structure QDFWATYP | Structure QDFWBTYP | No Structure |
|---|---|---|---|
| ALIAS | X'001D' | ||
| EDTWRD | X'007E' | ||
| EDTCDE | X'007F' | ||
| REF | X'00D8' | ||
| REFFLD | X'00D9' | ||
| TEXT | X'00DD' | ||
| SFLMSGKEY | X'0187' | ||
| SFLPGMQ | X'0186' | ||
| SFLRCDNBR | X'0197' | ||
| SFLROLVAL | X'0196' |
This structure is defined at variable WDFWKWDS in
structure QDFWKWDA. The structure is ARRAY(*).
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFWKTYP | Keyword type (see Keyword Types). | |
| 0 | 0 | CHAR(1) | * | Reserved. | |
| 1 | 1 | CHAR(1) | WDFWKWID | Where-used keyword ID. | |
| 2 | 2 | BIN(15) | WDFWKLEN | Length of this keyword and value. | |
| 4 | 4 | CHAR(*) | WDFWPRMS | Associated parameters. Use structure QDFWATYP (Variable Length Structure (QDFWATYP)) or structure QDFWBTYP (Multiple Variable Length Structure (QDFWBTYP)). (See Keyword Types.) | |
Variable Length Structure (QDFWATYP)
Variable length structure. This structure is defined at variable WDFWPRMS in structure QDFWATTR, or this structure is an
array defined at variable WDFWBPRM in structure
QDFWBTYP (where the number of entries is WDFWATS).
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFWALEN | Length of parameter. | |
| 2 | 2 | CHAR(1) | * | Reserved. | |
| 3 | 3 | CHAR(1) | WDFWPRMT | Parameter type. X'00' indicates character; X'08' indicates DBCS. | |
| 4 | 4 | CHAR(*) | WDFWAPRM | Parameter value. | |
Multiple Variable Length Structure (QDFWBTYP)
Multiple variable length structure. This structure is defined at variable WDFWPRMS in structure QDFWATTR.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(15) | WDFWATS | Number of variable length parameters. | |
| 2 | 2 | CHAR(*) | WDFWBPRM | Multiple variable length structures. Each parameter is defined by structure QDFWATYP, Variable Length Structure (QDFWATYP). | |
Reference Information Structure (QDFWRSTR)
Reference information. This structure is defined at variable WDFWAPRM in structure QDFWATYP.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | CHAR(1) | WDFWRFLG | Miscellaneous flags. | |
| 0 | 0 | 0 | BIT(1) | WDFWSRC | If on, source reference is specified. |
| 0 | 0 | 1 | BIT(5) | * | Reserved. |
| 0 | 0 | 6 | BIT(1) | WDFWDCHK | If on, validity checking is deleted. |
| 0 | 0 | 7 | BIT(1) | WDFWDEDT | If on, editing is deleted. |
| 1 | 1 | CHAR(1) | WDFWRCHG | Miscellaneous flags. | |
| 1 | 1 | 0 | BIT(1) | WDFWDUPE | If on, field is duplicated. |
| 1 | 1 | 1 | BIT(1) | WDFWNMEC | If on, name is changed. |
| 1 | 1 | 2 | BIT(1) | WDFWTYPC | If on, field type is changed. |
| 1 | 1 | 3 | BIT(1) | WDFWLENC | If on, field length is changed. |
| 1 | 1 | 4 | BIT(1) | WDFWDECC | If on, decimals are changed. |
| 1 | 1 | 5 | BIT(1) | WDFWEDTC | If on, editing is changed. |
| 1 | 1 | 6 | BIT(1) | WDFWVLCK | If on, validity checking is changed. |
| 1 | 1 | 7 | BIT(1) | WDFWOTHR | If on, other changes occurred. |
| 2 | 2 | BIN(31) | WDFWRFEI | Index into the name table for the file name being referred to (see structure QDFFNTBL, Name Table Structure (QDFFNTBL)). | |
| 6 | 6 | BIN(31) | WDFWRLBI | Index into the name table for the referenced library name (see structure QDFFNTBL, Name Table Structure (QDFFNTBL)). | |
| 10 | A | BIN(31) | WDFWRRFI | Index into the name table for the referenced format name (see structure QDFFNTBL, Name Table Structure (QDFFNTBL)). | |
| 14 | E | BIN(31) | WDFWRFDI | Index into the name table for the referenced field name (see structure QDFFNTBL, Name Table Structure (QDFFNTBL)). | |
Name Table Structure (QDFFNTBL)
Name table. Internally generated fields begin with *IN and end with 2
digits, such as, *IN03 and *IN27. The displacement to this structure from the
beginning of structure QDFWFLEI is at variable
WDFWNTBO in QDFWFLEI.
| Offset | Bit | Type | Variable Name | Field | |
|---|---|---|---|---|---|
| Dec | Hex | ||||
| 0 | 0 | BIN(31) | WDFFNMS | Number of names in the table. | |
| 4 | 4 | ARRAY(*) OF CHAR(10) | WDFFNMES | Name entries. | |
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPF0679 E | Object &1 is not a display file. |
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF3C19 E | Error occurred with receiver variable specified. |
| CPF3C21 E | Format name &1 is not valid. |
| CPF3C22 E | Cannot get information about file &1. |
| CPF3C24 E | Length of the receiver variable is not valid. |
| CPF3C90 E | Literal value cannot be changed. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
API introduced: V2R2