FEPI EXTRACT FIELD

Function

The command is for SLU2 mode only, and for formatted data only.

FEPI EXTRACT FIELD gets information about a field in the current character buffer of the simulated terminal. It can be issued at any point in the conversation. More than one FEPI EXTRACT FIELD command can be issued for a given field.

For information about field attributes and their values see 3270 Data Stream Programmer’s Reference. Symbolic names for the various attribute values are available in the DFHBMSCA copybook.

Syntax

Read syntax diagramSkip visual syntax diagramFEPI EXTRACT FIELD
 
>>-FEPI EXTRACT FIELD--CONVID(data-value)----------------------->
 
>--+-FIELDLOC(data-value)-+------------------------------------->
   '-FIELDNUM(data-value)-'
 
>--+----------------------------------+------------------------->
   '-INTO(data-area)-| INTO options |-'
 
>--+-----------------------+--+------------------+-------------->
   '-BACKGROUND(data-area)-'  '-COLOR(data-area)-'
 
>--+----------------------+--+--------------------+------------->
   '-FIELDATTR(data-area)-'  '-HILIGHT(data-area)-'
 
>--+-------------------------+--+-----------+------------------->
   '-INPUTCONTROL(data-area)-'  '-MDT(cvda)-'
 
>--+--------------------+--+---------------------+-------------->
   '-OUTLINE(data-area)-'  '-POSITION(data-area)-'
 
>--+---------------+--+---------------+--+-----------------+---->
   '-PROTECT(cvda)-'  '-PS(data-area)-'  '-SIZE(data-area)-'
 
>--+-------------------------+--+-----------------------+------><
   '-TRANSPARENCY(data-area)-'  '-VALIDATION(data-area)-'
 
INTO options:
 
|--+------------------------+--+--------------------+-----------|
   '-MAXFLENGTH(data-value)-'  '-FLENGTH(data-area)-'
 

Options

BACKGROUND(1-character data-area)
returns the background color attribute of the field.
COLOR(1-character data-area)
returns the foreground color attribute of the field.
CONVID(8-character data-value)
specifies the ID of the conversation for which information is wanted. The conversation must be owned by the task issuing the command.
FIELDATTR(1-character data-area)
returns the 3270 field attribute of the field.
FIELDLOC(fullword binary data-value)
specifies the location of the required field expressed as an offset from the start of the screen image; offset zero is the top left-hand corner of the screen. The location can refer to any character position in the field, including its attribute byte.
FIELDNUM(fullword binary data-value)
specifies the location of the required field expressed as a field number counting from the top left-hand corner of the screen. The first field is number 1, and starts at the top-left hand corner of the screen, whether or not there is an attribute in that position. The last field ends at the bottom right-hand corner of the screen, and does not wrap back to the top.
FLENGTH(fullword binary data-area)
returns the actual length of data received in the data area identified by the INTO option.
HILIGHT(1-character data-area)
returns the extended highlighting attribute of the field.
INPUTCONTROL(1-character data-area)
returns the DBCS input control attribute of the field.
INTO(data-area)
specifies the data area in which the data in the field is to be returned. The length of the area is specified by the MAXFLENGTH option, and the actual length of data written into the area is returned by the FLENGTH option.
MAXFLENGTH(fullword binary data-value)
specifies the maximum amount of data that can be returned; that is, the length of the data area identified by the INTO option. It must not be more than the maximum length allowed for the pool.
MDT(cvda)
returns a value that identifies the state of the modified data tag for the field. The relevant CVDA values are:
  • NOMDT
  • MDT
OUTLINE(1-character data-area)
returns the field outlining attribute of the field.
POSITION(fullword binary data-area)
returns the position of the field expressed as the offset of the first data byte from the start of the screen image; offset zero is the top left-hand corner of the screen.
PROTECT(cvda)
returns a value that indicates whether or not the field is protected. The relevant CVDA values are:
  • UNPROTECTED
  • PROTECTED
PS(1-character data-area)
returns the character set attribute of the field.
SIZE(fullword binary data-area)
returns the size of the field on the screen, excluding the field attribute byte, expressed as a number of bytes.
TRANSPARENCY(1-character data-area)
returns the transparency attribute of the field.
VALIDATION(1-character data-area)
returns the field validation attribute of the field.

Conditions

The INVREQ condition can have the following RESP2 values:

RESP2
Meaning
60
MAXFLENGTH value negative, zero, or more than the maximum allowed for the current pool.
70
FIELDLOC or FIELDNUM value negative or not valid.
210
Command not allowed for SLU P mode.
212
Conversation has wrong data format.
224
Only FEPI ISSUE or FEPI FREE commands allowed at this point in the conversation.
240
Conversation ID not owned by this task.
[[ Contents Previous Page | Next Page Index ]]