Exit Program for an Incomplete List
Required Parameter Group for Single Parameter Interface:
| 1 | Incomplete list information | Input | Char(*) |
QSYSINC Member Name: EUIILEX
Required Parameter Group for Multiple Parameter Interface:
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) |
Interface Level 2:
No additional parameters are required for interface level 2.
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.
Authorities and Locks
None.
Required Parameter Group
- Incomplete list 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:
6 Processes an incomplete list exit program.
- Application handle
- INPUT; CHAR(8)
The application handle of the application that is currently being processed by the UIM.
- List name
- INPUT; CHAR(10)
The name of the list that is currently being processed by the UIM.
- Incomplete list direction
- INPUT; BINARY(4)
The direction from the current list entry in which additional entries must be added. Here are the possible 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
- INPUT; BINARY(4)
The minimum number of entries that must be added to the list.
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) | Reserved |
| 34 | 22 | CHAR(10) | List name |
| 44 | 2C | BINARY(4) | Incomplete list direction |
| 48 | 30 | BINARY(4) | Number of entries required |
Field Descriptions
Application handle. The application handle of the application that is currently being processed by the UIM.
Incomplete list direction. The direction from the current list entry in which additional entries must be added. Here are the possible values:
| 0 | More list entries are required after the current list entry. |
| 1 | More list entries are required before the current list entry. |
List name. The name of the list that is currently being processed by the UIM.
Number of entries required. The minimum number of entries that must be added to the list.
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:
| 6 | Processes an incomplete list exit program. |
Exit program introduced: V2R2
[ Back to top | User Interface Manager APIs | APIs by category ]