Exit Program for an Action List Option or Pull-Down Field Choice


  Required parameter group:

1 Structure level Input Binary(4)
2 Reserved Input Char(8)
3 Type of call Input Binary(4)
4 Application handle Input Char(8)
5 Panel name Input Char(10)
6 List name Input Char(10)
7 List entry handle Input Char(4)
8 Option number Input Binary(4)
9 Function qualifier Input Binary(4)
10 Action results Input Binary(4)
11 Pull-down field name Input Char(10)

  QSYSINC Member Name: EUIALEX


An exit program can be specified for an action list option using the USREXIT attribute of the list action (LISTACT) tag. The exit program is called immediately after the action specified on the ENTER, PROMPT, EXTENTER, or EXTPROMPT attribute of the LISTACT tag is processed.

An exit program for a pull-down field choice can be specified using the USREXIT attribute of the pull-down field choice (PDFLDC) tag. The exit program is called immediately after the action specified on the ACTION attribute of the PDFLDC tag is processed.

Normally, this exit program adds, updates, or removes a list entry for the application when the action list option or pull-down choice action is a command string. The exit program should not change list entries other than the one currently being processed. If it does, remaining UIM list processing may not perform as expected. If the exit program changes the current entry for the list by adding a new entry to the list, the exit program should reset the current entry to the one currently being processed before returning control to the UIM. If the exit program does not do this, remaining UIM list processing may not perform as expected.

Escape messages received by the UIM from the exit program cause the UIM to stop list processing, and display the messages when the panel is reshown. If the dialog variable identifying the exit program is null (for a pointer variable) or blanks (for a character variable), no exception is reported by the UIM and processing continues as if the USREXIT attribute is not specified.

The cancel and exit 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 cancel and exit flags should not be turned on by the exit program.


Single Parameter Interface

QSYSINC Member Name: EUIALEX

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:

5 The exit program is called for an action list option or pull-down choice when ACTFOR=LIST is specified on the PDFLDC tag.

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.

List name
CHAR(10); positions 35-44

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

List entry handle
CHAR(4); positions 45-48

The handle of the list entry being processed by the UIM. The following value may be used:

EXTE Processes the extended action entry.

Option number
BINARY(4); positions 49-52

The option number of the list action or pull-down choice being processed for the specified list entry.

Function qualifier
BINARY(4); positions 53-56

Set to one of the following values:

0 Performs the action specified on the ENTER or EXTENTER attribute of the list action (LISTACT) tag or the ACTION attribute of the PDFLDC tag.
-10 Performs the action specified on the PROMPT or EXTPROMPT attribute of the LISTACT tag.

Action results
BINARY(4); positions 57-60

Set to one of the following values, indicating whether or not the list action or pull-down choice was successful:

0 The list action or pull-down choice is successful.
1 The list action or pull-down choice is unsuccessful.

A list action or pull-down choice is considered unsuccessful if any of the following occurs:

Conversely, the list action is successful if none of the above occur.


Pull-down field name
CHAR(10); positions 61-70

The pull-down field name from which the pull-down choice is selected. If the pull-down choice does not have a name, this field is set to blanks.

When the action being processed is not a pull-down choice, this field is set to blanks.

This field is available only when the structure level field is set to two or greater.


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 List name Input Char(10)
5 List entry handle Input Char(4)
6 Option number Input Binary(4)
7 Function qualifier Input Binary(4)
8 Action results Input Binary(4)

  Additional parameter for interface level 2:

9 Pull-down field name Input Char(10)


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