Programming Interface Information: This page documents intended Programming Interfaces that allow the customer to write programs to obtain the services of z/VM.

#### LWRD

Prolog

Control Block Contents
LWRD DSECT

Storage Layout

Cross Reference (Contains links to field and bit definitions)

#### LWRD Prolog

     Name       : LWRD
     Description: LINEWRT Data Descriptor
     DSECT      : LWRD
     Function   : LWRD is used to map an area of storage that
                  contains information on data output that is used
                  by the LINEWRT Macro with FORM=MULTIPLE.  This
                  descriptor DSECT has two formats.  It describes
                  either the positioning of the cursor within a
                  VSCREEN or the output that is to be written to a
                  VSCREEN.

#### LWRD Control Block Content

#### LWRD DSECT

    Hex   Dec Type/Val   Lng Label (dup)    Comments
    ---- ---- --------- ---- -------------- --------
    0000    0 Structure      LWRD           LINEWRT Data Descriptor
    0000    0 Address      4 LWRDNEXT       Pointer to next LINEWRT
                                            descriptor (LWRD)
    0004    4 Character    8 *              Reserved
    000C   12 Signed       4 LWRDLINE       Line number
    0010   16 Signed       4 LWRDCOL        Column number
    0014   20 Address      4 LWRDTXTA       Text address - for output LWRD
    0018   24 Signed       4 LWRDTXTL       Length of text for output LWRD
    001C   28 Signed       4 LWRDFLDL       Output length in vscreen - for
                                            output LWRD
    0020   32 Bitstring    1 LWRDFLG1       Flag byte #1 - for output LWRD
              1... ....      LWRDNTRF       X'80' LWRDNTRF X . No nulls
                                            translation
              .1.. ....      LWRDNOTR       X'40' LWRDNOTR .X . No user
                                            translation
              .... 1...      LWRDCSEF       X'08' LWRDCSEF . X Mixed or sbcs
                                            specified
              .... .1..      LWRDOUTF       X'04' LWRDOUTF . .X Field
                                            outlining spec'd
              .... ..1.      LWRDPRTY       X'02' LWRDPRTY . X. Priority
                                            write
              .... ...1      LWRDRESO       X'01' LWRDRESO . X Reserved area
                                            of vscreen
    0021   33 Bitstring    1 LWRDOUTL       Field outlining value
    0022   34 Bitstring    1 LWRDCSET       Mixed or sbcs field attribute
    0023   35 Character    6 *              Reserved
    0029   41 Bitstring    1 LWRDATTR       Attribute byte - for output LWRD
    002A   42 Bitstring    1 LWRDCOLR       Color byte - for output LWRD
    002B   43 Bitstring    1 LWRDEXHI       Extended highlighting byte-for
                                            output LWRD
    002C   44 Bitstring    1 LWRDPSS        PSS byte - for output LWRD
    002D   45 Bitstring    1 LWRDFLG2       Flag byte #2 - for output LWRD
              1... ....      LWRDPSSF       X'80' LWRDPSSF X . PSS is
                                            specified
              .1.. ....      LWRDEXHF       X'40' LWRDEXHF .X . Extended
                                            highlght is specified
              ..1. ....      LWRDCLRF       X'20' LWRDCLRF X. . Color is
                                            specified
              ...1 ....      LWRDDATF       X'10' LWRDDATF X . Update data
                                            buffer
              .... .1..      LWRDCRSF       X'04' LWRDCRSF . .X Position
                                            cursor within field
              .... ...1      LWRDPADF       X'01' LWRDPADF . X Padding with
                                            blanks
    002D   45 Bitstring    1 LWRDLCUR
              .... ..1.      LWRDSETC       X'02' LWRDSETC . X. Position
                                            cursor using curs LWRD
              .... ...1      LWRDRESC       X'01' LWRDRESC . X Reserved area
                                            of vscreen
    002E   46 Bitstring    1 LWRDTXT        Text writes a
                                            field,data,color,exthi,pss
               Valid text codes                                            */
              .... ....      LWRDFLDV       X'00' Define a field with default
                                            vscreen attr.
              .... ...1      LWRDFLDD       X'01' Define a field and use
                                            descriptor attr.
              .... ..1.      LWRDDATT       X'02' Text is data to write in
                                            pre-defined field
              .... ..11      LWRDCLRT       X'03' Text is color codes
              .... .1..      LWRDEXHT       X'04' Text is extended
                                            highlighting codes
              .... .1.1      LWRDPSST       X'05' Text is PSS codes
    002F   47 Bitstring    1 LWRDRC         Individual return code
               Valid return codes                                          */
              00000000       LWRDOK         0 Function executed successfully
              00000018       LWRDINVP       24 User did not specify
                                            descriptor correctly
              00000020       LWRDINVL       32 Specified line/column is
                                            outside vscreen
              00000068       LWRDNOST       104 Insufficient storage was
                                            available
              00000030       LWRDLEN        *-LWRD Length of LWRD
              00000006       LWRDDBSZ       (LWRDLEN+7)/8 Length in
                                            doublewords

#### LWRD Storage Layout

    *** LWRD - LINEWRT Data Descriptor
    *
    *     +---------------------------+---------------------------+
    *   0 |         LWRDNEXT          |///////////////////////////|
    *     +---------------------------+---------------------------+
    *   8 |///////////////////////////|         LWRDLINE          |
    *     +---------------------------+---------------------------+
    *  10 |         LWRDCOL           |         LWRDTXTA          |
    *     +---------------------------+---------------------------+
    *  18 |         LWRDTXTL          |         LWRDFLDL          |
    *     +------+------+------+------+---------------------------+
    *  20 |:DFLG1|:DOUTL|:DCSET|//////////////////////////////////|
    *     +------+------+------+------+------+------+-------------+
    *  28 |//////|:DATTR|:DCOLR|:DEXHI|:DPSS |:DFLG2| 2E
    *     +------+------+------+------+------+------+
    *
    *** LWRD - LINEWRT Data Descriptor

    *** Overlay for LWRDFLG2 in LWRD
    *
    *                                        +------+------+------+
    *  28 ...                             2D |:DLCUR|:DTXT |LWRDRC|
    *                                        +------+------+------+
    *  30
    *
    *** Overlay for LWRDFLG2 in LWRD

#### LWRD Cross Reference

    Symbol         Dspl Value
    -------------- ---- -----
    LWRDATTR       0029
    LWRDCLRF       002D 20
    LWRDCLRT       002E 03
    LWRDCOL        0010
    LWRDCOLR       002A
    LWRDCRSF       002D 04
    LWRDCSEF       0020 08
    LWRDCSET       0022
    LWRDDATF       002D 10
    LWRDDATT       002E 02
    LWRDDBSZ       002F 00000006
    LWRDEXHF       002D 40
    LWRDEXHI       002B
    LWRDEXHT       002E 04
    LWRDFLDD       002E 01
    LWRDFLDL       001C
    LWRDFLDV       002E 00
    LWRDFLG1       0020
    LWRDFLG2       002D
    LWRDINVL       002F 00000020
    LWRDINVP       002F 00000018
    LWRDLCUR       002D
    LWRDLEN        002F 00000030
    LWRDLINE       000C
    LWRDNEXT       0000
    LWRDNOST       002F 00000068
    LWRDNOTR       0020 40
    LWRDNTRF       0020 80
    LWRDOK         002F 00000000
    LWRDOUTF       0020 04
    LWRDOUTL       0021
    LWRDPADF       002D 01
    LWRDPRTY       0020 02
    LWRDPSS        002C
    LWRDPSSF       002D 80
    LWRDPSST       002E 05
    LWRDRC         002F
    LWRDRESC       002D 01
    LWRDRESO       0020 01
    LWRDSETC       002D 02
    LWRDTXT        002E
    LWRDTXTA       0014
    LWRDTXTL       0018

This information is based on z/VM V6R1.0.
Last updated on 23 Oct 2009 at 11:02:18 EDT.
Copyright IBM Corporation, 1990, 2008