Exit Program for Application Formatted Data

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.


Single Parameter Interface

QSYSINC Member Name: EUIAFEX

Structure level
BINARY(4); positions 1-4

The interface level supported by this structure, indicating which fields and values are available for the current interface level.

Reserved
CHAR(8); positions 5-12

Type of call
BINARY(4); positions 13-16

Set to the following value:

7 The exit program is called to update the application formatted data.

Application handle
CHAR(8); positions 17-24

The application handle of the application currently being processed by the UIM.

Panel name
CHAR(10); positions 25-34

The name of the panel currently being processed by the UIM.

Panel bidirectional orientation
CHAR(1); positions 35-35

Identifies the attribute orientation of the panel group.

Set to one of the following 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
BINARY(4); positions 36-39

The number of the code page of the requester's display device.


Multiple Parameter Interface

The description of parameters listed in the following table is the same as the corresponding field in the structure for a single parameter interface. The positions listed for each field in the structure do not apply to the multiple parameter interface.


  Parameters for 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)

  No additional parameters are required for interface level 2.



Exit program introduced: V2R2
Top | User Interface Manager (UIM) APIs | APIs by category