Exit Program for Application Formatted Data
Required Parameter Group for Single Parameter Interface:
| 1 | Application formatted data information | Input | Char(*) |
QSYSINC Member Name: EUIAFEX
Required Parameter Group for Multiple Parameter Interface:
Interface Level 1:
| 1 | Type of call | Input | Binary(4) |
| 2 | Application handle | Input | Char(8) |
| 3 | Panel name | Input | Char(10) |
| 4 | Panel bidirectional orientation | Input | Char(1) |
| 5 | Device code page | Input | Binary(4) |
Interface Level 2:
No additional parameters are required for interface level 2.
The exit program can update the data formatted by the application every time a panel is displayed, and returns control to the UIM through a normal return. The UIM then finishes formatting the panel and displays it. The area formatted by the application is displayed as defined by the contents of the dialog variable.
An application format exit program can be specified on the USREXIT attribute of the application formatted area (APPFMT) tag. This attribute specifies the name of a dialog variable identifying the program to call.
The UIM does not reevaluate conditions after the text area exit program is called; therefore, changing dialog variables that affect conditions has no effect during this display of the panel.
This exit program is called during the formatting of the panel whenever the panel is displayed. If the dialog variable identifying the program is nulls for a pointer variable or blanks for a character variable, no exception is reported and processing continues as if the USREXIT attribute is not specified.
The exit program can send messages to the UIM for display on the panel. To have the messages shown, the exit program must return control to the UIM by sending a CPF6A05 status or escape message. In this case, any messages sent to the UIM by the incomplete list exit program are shown when the panel is displayed. Otherwise, the exit program returns control to the UIM by doing a normal return.
The exit and cancel flags for the job are not reset before the exit program is called, and the flags are not checked after the exit program returns control to the UIM. Therefore, the exit and cancel flags should not be turned on by the exit program.
Authorities and Locks
None.
Required Parameter Group
- Application formatted data information
- INPUT; CHAR(*)
A structure that provides information related to the user request. For details, see Single Parameter Structure.
- Type of call
- INPUT; BINARY(4)
This parameter must be set to the following value:
7 The exit program is called to update the application formatted data.
- Application handle
- INPUT; CHAR(8)
The application handle of the application that is currently being processed by the UIM.
- Panel name
- INPUT; CHAR(10)
The name of the panel that is currently being processed by the UIM.
- Panel bidirectional orientation
- INPUT; CHAR(1)
Identifies the attribute orientation of the panel group. Here are the possible values:
N BIDI=NONE is specified or the default on the panel group (PNLGRP) tag. L BIDI=LTR is specified on the PNLGRP tag. R BIDI=RTL is specified on the PNLGRP tag.
- Device code page
- INPUT; BINARY(4)
The number of the code page of the requester's display device.
Single Parameter Structure
For detailed descriptions of the fields in this table, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Structure level |
| 4 | 4 | CHAR(8) | Reserved |
| 12 | C | BINARY(4) | Type of call |
| 16 | 10 | CHAR(8) | Application handle |
| 24 | 18 | CHAR(10) | Panel name |
| 34 | 22 | CHAR(1) | Panel bidirectional orientation |
| 35 | 23 | BINARY(4) | Device code page |
Field Descriptions
Application handle. The application handle of the application that is currently being processed by the UIM.
Device code page. The number of the code page of the requester's display device.
Panel bidirectional orientation. Identifies the attribute orientation of the panel group. Here are the possible values:
| N | BIDI=NONE is specified or the default on the panel group (PNLGRP) tag. |
| L | BIDI=LTR is specified on the PNLGRP tag. |
| R | BIDI=RTL is specified on the PNLGRP tag. |
Panel name. The name of the panel that is currently being processed by the UIM.
Reserved. A reserved field.
Structure level. The interface level supported by this structure, indicating which fields and values are available for the current interface level.
Type of call. This field must be set to the following value:
| 7 | The exit program is called to update the application formatted data. |
Exit program introduced: V2R2
[ Back to top | User Interface Manager APIs | APIs by category ]