Exit Program for an Action List Option or Pull-Down Field Choice
Required Parameter Group for Single Parameter Interface:
| 1 | Action list or pull-down information | Input | Char(*) |
QSYSINC Member Name: EUIALEX
Required Parameter Group for Multiple Parameter Interface:
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) |
Interface Level 2:
| 9 | 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.
Authorities and Locks
None.
Required Parameter Group
- Action list or pull-down 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:
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
- INPUT; CHAR(8)
The application handle of the application that is currently being processed by the UIM.
- Panel name
- INPUT; CHAR(10)
The name of the panel 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.
- List entry handle
- INPUT; CHAR(4)
The handle of the list entry that is currently being processed by the UIM. The following value can be used:
EXTE Processes the extended action entry.
- Option number
- INPUT; BINARY(4)
The option number of the list action or pull-down choice that is currently being processed for the specified list entry.
- Function qualifier
- INPUT; BINARY(4)
Indicates the action to be performed. Here are the possible 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
- INPUT; BINARY(4)
Indicates whether the list action or pull-down choice is successful. Here are the possible values:
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:
- An escape message is sent by the action program or command.
- The cancel flag for the job is set on by the action program or command.
- The exit flag for the job is set on by the action program or command.
Conversely, the list action is successful if none of the above occur.
- Pull-down field name
- INPUT; CHAR(10)
The name of the pull-down field from which the pull-down choice is selected. If the pull-down field does not have a name, this parameter is set to blanks.
When the action being processed is not a pull-down choice, this parameter is set to blanks.
This parameter is available only when the interface level is set to two or greater.
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) | Panel name |
| 34 | 22 | CHAR(10) | List name |
| 44 | 2C | CHAR(4) | List entry handle |
| 48 | 30 | BINARY(4) | Option number |
| 52 | 34 | BINARY(4) | Function qualifier |
| 56 | 38 | BINARY(4) | Action results |
| 60 | 3C | CHAR(10) | Pull-down field name |
Field Descriptions
Action results. Indicates whether the list action or pull-down choice is successful. Here are the possible values:
| 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:
- An escape message is sent by the action program or command.
- The cancel flag for the job is set on by the action program or command.
- The exit flag for the job is set on by the action program or command.
Conversely, the list action is successful if none of the above occur.
Application handle. The application handle of the application that is currently being processed by the UIM.
Function qualifier. Indicates the action to be performed. Here are the possible 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. |
List entry handle. The handle of the list entry that is currently being processed by the UIM. The following value can be used:
| EXTE | Processes the extended action entry. |
List name. The name of the list that is currently being processed by the UIM.
Option number. The option number of the list action or pull-down choice that is currently being processed for the specified list entry.
Panel name. The name of the panel that is currently being processed by the UIM.
Pull-down field name. The name of the pull-down field from which the pull-down choice is selected. If the pull-down field 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.
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:
| 5 | The exit program is called for an action list option or pull-down choice when ACTFOR=LIST is specified on the PDFLDC tag. |
Exit program introduced: V2R2
[ Back to top | User Interface Manager APIs | APIs by category ]