MAP - BMS map object DSECT

     DESCRIPTIVE NAME = CICS/ESA BMS MAP OBJECT DSECT
                        DUAL LANGUAGE DSECT
           Licensed Materials - Property of IBM
            Restricted Materials of IBM 
           5655-Y04
           (C) Copyright IBM Corp. 1997, 1998 
     FUNCTION = DUAL LANGUAGE DSECT FOR THE BMS MAP OBJECT. CONTAINS
                SEPARATE SECTIONS FOR THE MAPSET HEADER, THE TAB MAP,
                THE MAP HEADER, THE MAPNAME ALIAS EXTENSION AREA, AND
                THE FIELD SPECIFICATION.
                THE MAP OBJECT IS BUILT BY THE MAP DEFINITION MACROS
                ON ASSEMBLING A MAP SPECIFYING SYSPARM=-MAP. IT IS
                STORED IN THE PROGRAM LIBRARY WITH A PPT ENTRY. IT IS
                LOADED INTO MAIN MEMORY BY DFHMCP.
                THE MAP OBJECT IS REFERENCED BY BMS MODULES.
     NOTES :
      DEPENDENCIES = S/370
      RESTRICTIONS = NONE
      MODULE TYPE = Control Block
     EXTERNAL REFERENCES = NONE
      MACROS = NONE
Table 1.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 12 DFHMAPDS DUMMY SECTION - MAP DESCRIPTION 
                    MAP SET SPECIFICATIONS
(0) CHARACTER 8 BMSNAME MAP SET NAME
(8) UNSIGNED 1 BMSTRL PAGE OVERFLOW TRAILER LENGTH
(9) CHARACTER 1 * RESERVED
(A) CHARACTER 2 BMSDELDM DEFAULT LDC MNEMONIC
(C) CHARACTER 0 BMSMSHEA MAP SET HEADER ENDING ADDRESS 
         TAB FORMAT MAP SPECIFICATIONS
Table 2.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 18 BMSTABM 
   FIELDS ARE SEQUENCE SENSITIVE WITH NORMAL MAP
(0) CHARACTER 1 BMSMTI MAP TYPE INDICATOR
(1) CHARACTER 3 * RESERVED
(4) BIT(8) 1 BMSTFMI TAB MAP INDICATOR
(4) 1... ....   *
(4) .1.. ....   BMSTFMV VERTICAL TAB MAP
(4) ..1. ....   BMSTFMH HORIZONTAL TAB MAP
(5) CHARACTER 3 * RESERVED
(8) CHARACTER 8 BMSTFN TAB MAP NAME
(10) HALFWORD 2 BMSTFL TAB MAP LENGTH
(12) CHARACTER 0 BMSTFEA ENDING ADDRESS 
                      MAP SPECIFICATIONS
Table 3.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 79 BMSMAPH 
   FIELDS ARE SEQUENCE SENSITIVE WITH TAB FORMAT MAP
(0) HALFWORD 2 BMSMHLL MAP HEADER LENGTH 0 FOR PRE1.7 MAPS X'8100' FOR TAB MAPS
(0) CHARACTER 1 BMSMT MAP TYPE CODE
(1) CHARACTER 1 * RESERVED
(2) CHARACTER 2 BMSIPR NAME OF INPUT PARTITION
(4) ADDRESS 4 BMSMDA MAP DATA ADDRESS
(4) CHARACTER 2 BMSOPR NAME OF OUTPUT PARTITION
(6) CHARACTER 2 BMSAPR NAME OF ACTIVE PARTITION
(8) CHARACTER 8 BMSMNAME MAP NAME
(10) HALFWORD 2 BMSMS MAP LENGTH, INCLUDING ANY MAP HEADER EXTENSION AREA
(12) HALFWORD 2 BMSMSSL IF BMSMODE(BMSMHEXT) IS SET ON THEN THIS IS THE OFFSET OF THE MAP HEADER EXTENSION AREA FROM THE START OF THE MAP HEADER. ON ENTRY TO DFHML1 IT HOLDS (NUMBER OF FIELDS)*10 AND DFHML1 USES THIS FIGURE OTHERWISE IT IS IGNORED
(14) HALFWORD 2 BMSMSI INPUT WORK AREA LENGTH
(16) HALFWORD 2 BMSMSO OUTPUT WORK AREA LENGTH
(18) CHARACTER 1 BMSMODE MAP DESCRIPTOR FLAG BYTE
(18) 1... ....   BMSMODO MODE = OUT
(18) .1.. ....   BMSMODI MODE = IN
(18) ..1. ....   BMSMHEXT THIS MAP OR MAP COPY HAS A MAP HEADER EXTENSION AREA
(18) ...1 ....   *
(18) .... 1...   BMSMODOF THIS MAP ELIGIBLE FOR OUTBOARD FORMATING, IF ON AT ASSEMBLY TIME. IF ON IN M32 - MAP IS USED FOR OUTBOARD FORMAT
(18) .... .1..   BMSMODOR THIS MAP (COPY) WHICH IS USED WITH AN OUTBOARD FORMAT HAS BEEN RELOCATED BY PBP. SET BY PBP, TESTED BY M32
(18) .... ..1.   BMSMODTC THIS MAP (COPY) ALSO CONTAINS A TIOA COPY
(18) .... ...1   BMSDATB DATA = BLOCK
(19) CHARACTER 1 BMSWCC 3270 WRITE CONTROL CHARACTER
(1A) HALFWORD 2 BMSCURSR 3270 CURSOR POSITION
(1C) CHARACTER 1 BMSMARG MAP MARGIN
(1C) 1... ....   *
(1C) .1.. ....   *
(1C) ..1. ....   *
(1C) ...1 ....   *
(1C) .... 1...   BMSMARBG JUSTIFY = BOTTOM
(1C) .... .1..   BMSMARGR JUSTIFY = RIGHT
(1C) .... ..1.   BMSMARGL JUSTIFY = LAST
(1C) .... ...1   BMSMARGF JUSTIFY = FIRST
(1D) UNSIGNED 1 BMSML MAP LENGTH - NUMBER OF LINES
(1E) UNSIGNED 1 BMSMW MAP WIDTH - NUMBER OF COLUMNS
(1F) UNSIGNED 1 BMSMSL MAP STARTING LINE NUMBER
(20) UNSIGNED 1 BMSMSC MAP STARTING COLUMN NUMBER
(21) CHARACTER 1 BMSMI MAP INDICATORS
(21) 1... ....   BMSMIXM EXTENDED ATTRS IN MAP
(21) .1.. ....   BMSMIXD EXTENDED ATTRS IN APPLICATION STRUCTURE
(21) ..1. ....   BMSMIAL 1 = ALIGNED MAP, 0 =UNALIGNED MAP
(21) ...1 ....   BMSMI16 MAP ASSEMBLED AT CICS/VS 1.6 OR LATER
(21) .... 1...   BMSMICL CURSOR IN FIELD IND REQD *
(21) .... .1..   BMSMIH HEADER MAP
(21) .... ..1.   BMSMIT TRAILER MAP
(21) .... ...1   BMSMIS FIELDS ARE NOT IN SEQUENCE
(22) CHARACTER 1 BMSMSTR2 TYPE REQUEST BYTE TWO FROM TCA
(23) CHARACTER 1 BMSMSTR3 TYPE REQUEST BYTE THREE FROM TCA
(23) 1... ....   *
(23) .1.. ....   *
(23) ..1. ....   BMSMSHON HONEOM REQD ON O/P MAPPING * (EXEC I/F ONLY)
(23) ...1 ....   *
(23) .... 1...   BMSMSTC CURSOR = NUMBER
(23) .... .1..   BMSMSTCW CTRL = ANY 3270 WCC
(24) CHARACTER 1 BMSMSTR4 TYPE REQUEST BYTE FOUR FROM TCA
(24) 1... ....   *
(24) .1.. ....   BMSMSTDN DATA = NO
(24) ..1. ....   BMSMSTRS TYPE = SAVE
(24) ...1 ....   *
(24) .... 1...   *
(24) .... .1..   BMSMSTRM TYPE = MAP
(24) .... ..1.   BMSMSTRE TYPE = ERASE
(24) .... ...1   BMSMSTRI TYPE = IN
(25) CHARACTER 1 BMSMSTR5 TYPE REQUEST BYTE FIVE FROM TCA
(25) 1... ....   BMSMSTRB TYPE = PAGEBLD
(25) .1.. ....   *
(25) ..1. ....   *
(25) ...1 ....   *
(25) .... 1...   *
(25) .... .1..   BMSMSTRO TYPE = OUT
(26) HALFWORD 2 BMSMSCP CURSOR POSITION FROM TCA
(26) HALFWORD 2 BMSDESCO offset of ADS descriptor in loaded mapset, if present
(28) CHARACTER 1 BMSMSWCC WRITE CONTROL CHARACTERS FROM TCA
(29) UNSIGNED 1 BMSATNO FOR EXTENDED FORMAT MAPS, THE NUMBER OF BYTES IN BMSMATTS AND BMSDATTS =12 FOR RELEASE 1.7
(29) CHARACTER 1 BMSMI2 MAP INDICATOR EXTENSION
(29) 1... ....   BMSMI2RM KANJI EXTENDED ATTRS IN MAP *
(29) .1.. ....   BMSMI2RD KANJI EXTENDED ATTRS IN APPLICATION STRUCTURE
(2A) CHARACTER 0 BMSMSEA MAP SPECIFICATION ENDING ADDRESS FOR PRE1.7 MAPS 
                         EXTENDED FORMAT MAPS
               FOLLOWING FIELDS ARE ADDED FOR CICS R1.7
      MAPS ASSEMBLED IN R170 AND AFTER WILL CONTAINS THESE FIELDS
                      IN THE MAP HEADER
(2A) ADDRESS 4 BMSMCA MAP CHAIN ADDRESS
(2E) HALFWORD 2 BMSMAL LENGTH OF ATTRIBUTES IN FIELD IN MAP
(30) HALFWORD 2 BMSDAL LENGTH OF ATTRIBUTES IN FIELD IN DATA STRUCTURE *
(32) CHARACTER 12 BMSMATTS MASK FOR ATTRIBUTES IN MAP FIELD: 00 - ATTR NOT IN FIELD NN - INDEX OF ATTR IN FLD *
(3E) CHARACTER 12 BMSDATTS MASK FOR ATTRIBUTES IN DATA STRUCTURE FIELD 00 - ATTR NOT IN FIELD NN - INDEX OF ATTR IN FLD *
(4A) UNSIGNED 1 BMSFLDSL LENGTH OF FIELD SEPARATOR 0 IF NOT SPECIFIED
(4B) CHARACTER 4 BMSFLDSP FIELD SEPARATOR UP TO FOUR CHARACTERS
(4F) CHARACTER 0 BMSXMSEA MAP SPECIFICATION ENDING ADDRESS FOR EXTENDED FORMAT MAPS 
                      FIELD SPECIFICATIONS
Table 4.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 12 BMSFLD
(0) CHARACTER 8 BMSFSL FIELD SPEC NO EXTATT
(0) HALFWORD 2 BMSFPP FIELD PAGE POSITION
(0) UNSIGNED 1 BMSFPP_BYTE1 FIELD PAGE BYTE1
(1) UNSIGNED 1 BMSFPP_BYTE2 FIELD PAGE BYTE2
(2) HALFWORD 2 BMSFL FIELD LENGTH
(4) CHARACTER 1 BMSFDFB FIELD DESCRIPTOR FLAG BYTE
(4) 1... ....   BMSFDCM CASE = MIXED
(4) .1.. ....   BMSFDGFE GROUP FIELD ENTRY
(4) ..1. ....   BMSFDGFD GROUP FIELD DESCRIPTOR
(4) ...1 ....   BMSFDPDA ATTRB = DET
(4) .... 1...   BMSFDJZ JUSTIFY = ZERO
(4) .... .1..   BMSFDJR JUSTIFY = RIGHT
(4) .... ..1.   BMSFDDD INITIAL = ANY USER INFORMATION
(4) .... ...1   BMSFDNF DSECT ENTRY EXISTS
(5) CHARACTER 1 BMSFA FIELD ATTRIBUTE
(6) HALFWORD 2 BMSFP FIELD POSITION
(8) CHARACTER 0 BMSFEA FIELD ENDING ADDRESS
(8) CHARACTER 4 BMSXATTR EXTENDED ATTRIBUTES
(8) CHARACTER 1 BMSFXC FIELD COLOR ATTRIBUTE
(9) CHARACTER 1 BMSFXP FIELD PSS ATTRIBUTE
(A) CHARACTER 1 BMSFXH FIELD HIGHLIGHT ATTRIBUTE
(B) CHARACTER 1 BMSFXV FIELD VALIDATION ATTRIBUTE
(C) CHARACTER 0 BMSFEAL FIELD END ADDRESS IF EXTENDED ATTRIBUTES INCLUDED 
                     ALIAS EXTENSION AREA
           THIS IS THE FIRST USE OF A MAP HEADER EXTENSION AREA. THIS
           FOLLOWS THE LAST FIELD IN A MAP, AND IS POINTED TO BY BMSMSS
           THE FLAG BMSMODE(BMSMHEXT) IS SET ON IF THIS AREA IS PRESENT
           THIS AREA CONTAINS A NUMBER OF EXTENSION RECORDS, EACH HEADE
           BY ONE BYTE LENGTH AND TYPE FIELDS. IT IS THUS EXTENDABLE.
           NOTE HOWEVER THAT THE CICS/VS 1.5 OBF CODE DOES NOT TEST THE
           EXTENSION RECORD TYPE AND LENGTH. ANY FURTHER USE OF THIS
           MAY REQUIRE REWORK OF THE OBF SUPPORT IN PBP AND M32.
           THE MAP ALIAS EXTENSION RECORD IS USED FOR PASSING THE NAMES
           OF OUTBOARD MAP-GROUP AND OUTBOARD FORMAT TO M32
Table 5.
Offset Hex Type Len Name (Dim) Description
(0) STRUCTURE 19 BMSALIAS
(0) UNSIGNED 1 BMSALLNG LENGTH OF ALIAS EXTENSION
(1) CHARACTER 1 BMSALTYP TYPE CODE FOR ALIAS EXTENSION
(1) 1... ....   *
(1) .1.. ....   *
(1) ..1. ....   *
(1) ...1 ....   *
(1) .... 1...   *
(1) .... .1..   *
(1) .... ..1.   *
(1) .... ...1   BMSALTEQ ALIAS EXTENSION TYPE CODE
(2) CHARACTER 8 BMSOGNME OUTBOARD MAP-GROUP NAME
(A) CHARACTER 8 BMSOFNME OUTBOARD FORMAT NAME
(12) CHARACTER 1 BMSOFFLG FLAG BYTE
(12) 1... ....   *
(12) .1.. ....   *
(12) ..1. ....   *
(12) ...1 ....   *
(12) .... 1...   *
(12) .... .1..   *
(12) .... ..1.   *
(12) .... ...1   BMSOFMGS MAP-GROUP NAME SUFFIXED
(13) CHARACTER 0 BMSALEND END OF ALIAS EXTENSION AREA

Constants

Table 6.
Len Type Value Name Description
1 HEX 81 BMSMTF INDICATING TAB MAP
1 HEX C0 BMSMODIO MODE = INOUT
1 HEX FF BMSMSLN LINE = NEXT
1 HEX FE BMSMSLS LINE = SAME
1 HEX FF BMSMSCN COLUMN = NEXT
1 HEX FE BMSMSCS COLUMN = SAME
1 HEX C0 BMSMSTDY DATA = YES