FEPI RECEIVE FORMATTED

Function

This command is for SLU2 mode only.

FEPI RECEIVE FORMATTED receives data from a target. The data received into the application’s data area is a screen image. Full details about the data are given in Data formats.

FEPI RECEIVE FORMATTED completes after receiving the inbound data with ‘last in chain’, ‘end bracket’ or ‘change direction’ indicated. A time limit can be set for this command. For more details of ending conditions, see Ending status.

Syntax

Read syntax diagramSkip visual syntax diagramFEPI RECEIVE FORMATTED
 
>>-FEPI RECEIVE FORMATTED--CONVID(data-value)------------------->
 
>--+----------------------------------+------------------------->
   '-INTO(data-area)-| INTO options |-'
 
>--+-------------------+--+--------------------+---------------->
   '-ALARMSTATUS(cvda)-'  '-COLUMNS(data-area)-'
 
>--+-------------------+--+-----------------+------------------->
   '-CURSOR(data-area)-'  '-ENDSTATUS(cvda)-'
 
>--+-------------------+--+------------------+------------------>
   '-FIELDS(data-area)-'  '-LINES(data-area)-'
 
>--+------------------+--+---------------------+---------------><
   '-RESPSTATUS(cvda)-'  '-TIMEOUT(data-value)-'
 
INTO options:
 
|--+------------------------+--+--------------------+-----------|
   '-MAXFLENGTH(data-value)-'  '-FLENGTH(data-area)-'
 

Options

ALARMSTATUS(cvda)
returns a value that indicates whether the received data sounded the alarm. The relevant CVDA values are:
  • ALARM
  • NOALARM
COLUMNS(fullword binary data-area)
returns the number of columns in the screen image.
CONVID(8-character data-value)
specifies the ID of the conversation to use. The conversation must be owned by the task issuing the command.
CURSOR(fullword binary data-area)
returns the position of the cursor in the received screen image, expressed as an offset from the start of the screen image; offset zero is the top left-hand corner of the screen.
ENDSTATUS(cvda)
returns a value that indicates the ending status for the received data. The relevant CVDA values are:
Value
Meaning
CD
‘Change direction’ received.
EB
‘End bracket’received.
LIC
‘Last in chain’received.
For more details of ending status and how additional data is handled, see Ending status.
FIELDS(fullword binary data-area)
returns the number of fields in the screen image.
FLENGTH(fullword binary data-area)
returns the actual length of data received in the data area identified by the INTO option.
INTO(data-area)
specifies the data area in which the received data 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.
LINES(fullword binary data-area)
returns the number of lines in the screen image.
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.
RESPSTATUS(cvda)
returns a value that indicates the type of response that is required at the back-end system. The relevant CVDA values are:
Value
Meaning
DEFRESP1
Definite response 1 required.
DEFRESP2
Definite response 2 required.
DEFRESP3
Definite response 1 and definite response 2 required.
NONE
No response required.
TIMEOUT(fullword binary data-value)
specifies the maximum time in seconds that the command is to wait for the requested data to begin to arrive. If TIMEOUT is not specified or the specified time is zero, the command is not timed out.

Conditions

The INVREQ condition can have the following RESP2 values:

RESP2
Meaning
60
MAXFLENGTH value negative or more than maximum allowed for the current pool.
71
VTAM RECEIVE failed.
72
RECEIVE FORMATTED processing found invalid, or unexpected data while interpreting the 3270 data stream for a WRITE, ERASE/WRITE, ERASE/WRITE ALTERNATE, or WRITE STRUCTURED FIELD command code.
210
Command not allowed for SLU P mode.
212
Conversation has wrong data format.
213
Command timed out.
215
Session lost.
216
Error occurred on previous FEPI SEND.
221
FEPI RECEIVE not allowed at this point in the conversation.
224
Only FEPI ISSUE or FEPI FREE commands allowed at this point in the conversation.
230
SNA CLEAR command received.
231
SNA CANCEL command received.
232
SNA CHASE command received.
233
Exception response received.
234
Exception request received.
240
Conversation ID not owned by this task.
241
TIMEOUT value negative or not valid.
[[ Contents Previous Page | Next Page Index ]]