Previous Topic: #MAPMOD SyntaxNext Topic: #MAPMOD Status Codes


#MAPMOD Parameters

MRB=

Specifies the storage area associated with the MRB of the map that is being modified. This storage area is of variable length according to the number of fields included in the map; it is copied into program variable storage by the #MRB statement.

map-request-block-pointer

A register that points to the MRB area or the symbolic name of that area.

Note: Map-request-block cannot be a register if the FIELD=field-name operand is also specified in the #MAPMOD statement.

TYPE=

Specifies whether the modifications are to be permanent or temporary.

PERM

(Default); specifies that modifications apply to all mapping mode I/O requests issued until the program terminates or until a subsequent #MAPMOD request overrides the requested revisions.

TEMP

Specifies that modifications will apply only to the next #MREQ request.

PLIST=

Indicates the location of the storage area in which the system will build the field parameter list specified by the FLIST parameter, described below.

SYSPLIST

(Default); is the symbolic name of the storage area in which the system will build the field parameter list.

parameter-value-list-pointer

A register that points to the area or the symbolic name of the area.

MRBLIST=

Indicates the location of the 20-fullword storage area that is substituted for the DC/UCF portion of SUBSCHEMA-CTRL. It is generated at the bottom of the first map request block in the program.

MRBPLIST

(Default) is the symbolic name of the storage area that will be substituted for the DC/UCF portion of SUBSCHEMA-CTRL.

mrb-parameter-list-pointer

A register that points to the area or the symbolic name of the area.

CURSOR=

Identifies the screen location at which the cursor will be positioned during output operations.

cursor-row,cursor-column

Specifies the row and column on the terminal screen to which the cursor will be moved. Cursor-row is a numeric literal indicating the row value. Cursor-column is a numeric literal indicating the column value.

field-name

Specifies the field to which the cursor will be moved. Field-name is the name of a map data field.

index-register

Optionally specifies the occurrence of the field if field-name is a multiply-occurring field. Index is either a register or the symbolic name of a user-defined field that contains the subscript or an absolute expression.

WCC=

Specifies the write-control character (WCC) options requested for the output operation. The WCC is a single byte transmitted with a screen during a #MREQ OUT, that indicates the functions that the 3270 control unit is to perform as it displays the information on the screen.

If a #MAPMOD request alters any WCC option, the system resets unspecified options to the following values:

Multiple WCC parameter values must be enclosed in parentheses and separated by commas.

RESETMDT/NOMDT

Specifies whether the modified data tags (MDTs) for the map fields will be reset to off automatically when the map is displayed. If RESETMDT is specified, the contents of variable fields are transmitted to storage only if the terminal operator modified the field or if the MDT has been set programmatically.

RESETMDT

States that the MDTs will be reset (turned off).

NOMDT

States that the MDTs will not be reset.

RESETKBD/NOKBD

Specifies whether the keyboard will be unlocked automatically when the map is displayed.

RESETKBD

States that the keyboard will be unlocked.

NOKBD

States that the keyboard will not be unlocked.

ALARM/NOALARM

Specifies whether the terminal audible alarm, if installed, will sound automatically when the map (for example, a screen that displays error messages), is displayed.

ALARM

States that the alarm will sound.

NOALARM

States that the alarm will not sound.

STARTPRT/NOPRT

(3280 printers only); specifies whether the contents of the terminal buffer will be printed automatically when the map is displayed.

STARTPRT

States that the contents of the terminal buffer will be printed.

NOPRT

States that the contents of the terminal buffer will not be printed.

NLCR/40CR/64CR/80CR

Specifies the characters-per-line formatting for 3280 printer output, meaningful only if the STARTPRT option, described above, has been specified.

NLCR

States that no line formatting will be performed on the printer output. Printing will begin on a new line only if the printer encounters new line (NL) and carriage control (CR) characters.

40CR

States that the contents of the 3280 print buffer will be printed at 40 characters per line.

64CR

States that the contents of the 3280 print buffer will be printed at 64 characters per line.

80CR

States that the contents of the 3280 print buffer will be printed at 80 characters per line.

FIELD/FLIST

Specifies one or more map fields to be modified. Choose one of these parameters to change field-specific options such as FOR, BACKSCN, OUTDATA, INDATA, JUSTIFY, PAD, EDIT, INPUT, and ATTR.

FIELD=

Specifies one map field to be modified.

FIELD

Specifies that one map field is to be modified.

field-name

Is the name of the map data field to be modified.

index

Specifies the occurrence of the field if field-name is a multiply-occurring field. Index is a register, the symbolic name of a user-defined field that contains the subscript, or an absolute expression.

FLIST=

Specifies a list of map fields to be modified or to be excluded from modification, as indicated by the FOR=FLIST and FOR=NOTFLIST parameters described below. The FLIST parameter values must be enclosed in parentheses. Each field specification must be coded on a separate line. Specify each field by using the following parameters.

field-name

Is the name of the map data field to be modified.

index-register

Specifies the occurrence of the field if field-name is a multiply-occurring field. Index-register is a register, the symbolic name of a user-defined field that contains the subscript, or an absolute expression.

FOR=

Specifies the map fields to be modified or excluded from modification:

ALL

Modifies all fields.

ERROR

Modifies those fields found to be in error during automatic editing.

CORRECT

Modifies those fields found to be correct during automatic editing.

CURRENT

Modifies only the field found to be current during automatic editing. The current field is the map field that was referenced in the last #MAPMOD or #MAPINQ request issued by the program. A #MAPMOD or #MAPINQ that specifies a field list does not establish currency.

NOCURNT

Modifies all the fields except the current field during automatic editing. The current field is the map field that was referenced in the last #MAPMOD or #MAPINQ request issued by the program. A #MAPMOD or #MAPINQ that specifies a field list does not establish currency.

FLIST

Modifies all the fields in the field list defined by the FLIST parameter above.

NOTFLIST

Modifies all fields except those in the field list defined by the FLIST parameter above.

BACKSCN=

Specifies whether the system is to backscan the specified field to remove trailing blanks before performing the map output operation.

YES

Requests that the system send all characters up to the last nonblank character to the terminal; fields remaining on the screen will contain whatever characters were present before the #MREQ request was issued. If the #MREQ request specifies the NEWPAGE option, the system erases the contents of all map data fields.

NO

Requests that the system leave in trailing blanks.

OUTDATA=

Indicates whether map fields will be set to the value of the corresponding variable-storage data fields.

YES

Specifies that the value of the variable storage field will be mapped out to the map field.

NO

Specifies that data from the record buffer as well as the attribute byte will not be mapped out.

ERASE

Requests that the system erase the map data fields.

ATTRIBUTE

Requests that the system transfer only the attribute byte from the record buffer to the map field.

INDATA=YES/NO

Indicates whether the map fields will be moved automatically to the corresponding variable-storage data fields (YES) or left unchanged (NO) during an input operation.

JUSTIFY=RIGHT/LEFT

Indicates whether the variable-storage field should be right or left justified on input.

PAD=

Indicates whether the alphanumeric variable-storage data field should be padded on input and defines the pad value or character:

NO

Does not pad the field.

pad-character

Pads the field with the specified pad character on the left if JUSTIFY=RIGHT is specified and on the right if JUSTIFY=LEFT is specified. Pad-character is a binary numeric literal pad-character value.

EDIT=ERROR/CORRECT

Explicitly sets the error flag on (ERROR) or off (CORRECT) for the specified map fields. If this parameter is specified, automatic editing must be enabled for the map and for the named map fields.

The ability to set the error flag enables programs to perform their own editing and validation in addition to that provided by the automatic editing feature.

INPUT=

Specifies whether the terminal operator will be required to add input in the specified map fields.

REQUIRED

Specifies that input is required. An error results if the terminal operator fails to enter data in a required field.

OPTIONAL

Specifies that input is optional. An error will not result if the terminal operator fails to enter data in an optional field.

ERRMSG
ACTIVE

(Default); enables display of the error message associated with the field.

SUPPRESS

Disables display of the error message associated with the field. If the map is redisplayed because of errors, the message defined for the map field will not be displayed even if the field contains edit errors. You typically enable display of a message only after specifying ERRMSG=SUPPRESS for the map in a previous #MAPMOD TYPE=PERM statement.

ATTR=

Specifies the 3270 and 3279 attributes for the named map fields. Multiple ATTR parameter values must be enclosed in parentheses and separated by commas. Only the named attributes will be modified in the MRB. ATTR options are.

SKIP

Requests that the system reposition the cursor automatically over the ma fields to the next unprotected field. When SKIP is specified, the named map fields are implicitly assigned the NUMERIC and PROTECT attributes (described below) automatically.

ALPHA/NUMERIC

Specifies whether the data input to the map fields by the terminal operator are alphanumeric (any character on the 3270 terminal keyboard) or numeric. ALPHA cannot be specified if SKIP has been specified.

PROTECT/UNPROT

Specifies whether or not map fields will be protected from data entry or modification by the terminal operator. UNPROT cannot be specified if SKIP has been specified.

DISPLAY/DARK/BRIGHT

Specifies how map fields are displayed.

DISPLAY

Specifies that the map fields will be displayed with normal intensity. DISPLAY cannot be specified if DETECT, described below, has been specified.

DARK

Specifies that the map fields will not be displayed. DARK cannot be specified if DETECT, described below, has been specified.

BRIGHT

Specifies that the map fields will be displayed with bright intensity. BRIGHT cannot be specified if DETECT, described below, has been specified.

DETECT

Specifies that the map fields will be light-pen-detectable. All fields assigned the BRIGHT attribute will automatically be detectable by a light pen.

MDT/NOMDT

Specifies whether MDTs are automatically set (turned on) for the map field when displayed.

MDT

Requests that the system automatically set the MDT for the map fields when displayed.

NOMDT

Requests that the system not automatically set the MDT for the map fields when displayed.

BLINK/NOBLINK

(3279 terminals only); specifies whether map fields will be displayed with blinking characters.

BLINK

Specifies that the fields characters will blink.

NOBLINK

Suppresses blinking.

REVERSE/NRMVIDEO

(3279 terminals only); specifies whether map fields will be displayed in reverse video; dark characters on a light background.

REVERSE

Indicates that map fields will be displayed in reverse video.

NRMVIDEO

Specifies that the map fields will be displayed in normal video; light characters on a dark background.

UNDERSCR/NOUNDER

(3279 terminals only); specifies whether the map fields are displayed with underlined characters.

UNDERSCR

Specifies that the map fields will be displayed with underlined characters.

NOUNDER

Specifies that the map fields will be displayed with nonunderlined characters.

NOCOLOR/BLUE/RED/PINK/GREEN/TURQUOIS/YELLOW/WHITE

(3279 terminals only); specifies that the map fields will be displayed with no color attribute or with one of the seven available color attributes.

Note: The BLINK/NOBLINK, REVERSE/NRMVIDEO, and UNDERSCR/NOUNDER options are mutually exclusive; the last attribute specified will override any previously specified attribute.