Exit Program for an Incomplete List

An exit program for handling an incomplete list is defined using the Set List Attributes (QUISETLA) API. A dialog variable is specified identifying the program to call.

The dialog variable cannot be blanks or nulls. The UIM cannot process an incomplete list without the exit program.

This exit allows an application to display part of a list without having to build the entire list. It must either add more entries or mark the list as complete in the direction being extended. If the list is not marked complete and fewer entries than the minimum requested by the UIM are added, the exit program is called again. If the list is not marked complete and no entries are added by the exit program, a CPF6A95 error is reported to the program that called the Display Panel (QUIDSPP), Get List Entry (QUIGETLE), Get List Multiple Entries (QUIGETLM), or Remove List Entry (QUIRMVLE) API.

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.

Sometimes the exit program for an incomplete list is called when no panel is displayed; such a call occurs when the QUIGETLE, the QUIGETLM, or the QUIRMVLE API is used. If no panel is displayed when the exit program sends a CPF6A05 status or escape message, any messages sent to the UIM by the exit program are moved to the program message queue for the program calling that API.

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: EUIILEX

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:

6 Processes an incomplete list exit program.

Application handle
CHAR(8); positions 17-24

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

Reserved
CHAR(10); positions 25-34

List name
CHAR(10); positions 35-44

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

Incomplete list direction
BINARY(4); positions 45-48

The direction from the current list entry in which additional entries must be added.

Set to one of the following values:

0 More list entries are required after the current list entry.
1 More list entries are required before the current list entry.

Number of entries required
BINARY(4); positions 49-52

The minimum number of entries that must be added to the list.


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 List name Input Char(10)
4 Incomplete list direction Input Binary(4)
5 Number of entries required 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