Exit Program for Text Area Data

The exit program can update the data in a text area every time a panel is displayed and returns control to the UIM through a normal return. The UIM will then finish formatting the panel and display it. The area formatted by the application is displayed as defined by the contents of the dialog variable or by the data pointed to by the dialog variable.

A text area exit program can be specified on the USREXIT attribute of the text area (TEXT) tag. This attribute specifies the name of a dialog variable identifying the program to call. The UIM calls the program when:

• The panel is displayed or redisplayed using display panel UIM functions.
• The user presses a key assigned to the PAGEUP, PAGEDOWN, MOVEtop, or ENTER dialog commands and the cursor position is such that the text area should be scrolled.

If the dialog variable identifying the program to call is null for a pointer variable or blanks for a character variable, escape message CPF6A14 is sent to the calling program. If the exit program returns control normally, any messages sent to the UIM by the exit program are displayed on the message line.

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.

The exit and cancel flags for the job are not reset before the exit program is called and the flag 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: EUITAEX

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:

11	The exit program is called to update the text area 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.

Function key pressed

BINARY(4); positions 35-38

The function key that is pressed:

0	A key other than F1-F24.
1-24	A function key (F1-F24) is pressed.

Function key qualifier

BINARY(4); positions 39-42

Provides information about why the user exit program is being called.

0	The exit program is called for the initial display or redisplay of the panel.
-1	A key assigned to the PAGEUP dialog command is pressed.
-2	A key assigned to the PAGEDOWN dialog command is pressed.
-3	A key assigned to the MOVEtop dialog command is pressed.
-4	A key assigned to the ENTER dialog command is pressed.

Text area width

BINARY(4); positions 43-46

The width of the text area within this panel to be formatted.

Text area depth

BINARY(4); positions 47-50

The depth of the text area within this panel to be formatted.

Panel bidirectional orientation

CHAR(1); positions 51-51

Identifies the attribute orientation of the panel group. Set one of the following values:

N	BIDI=NONE is specified or the default on the panel group (PNLGRP) tag.
L	BIDI=LTR is specified or the default on the PNLGRP tag.
R	BIDI=RTL is specified or the default on the PNLGRP tag.

Device code page

BINARY(4); positions 52-55

The number for 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.