Exit Program for Conditioning Panel Items
Required Parameter Group for Single Parameter Interface:
| 1 | Panel item information | Input | Char(*) |
QSYSINC Member Name: EUICTEX
Required Parameter Group for Multiple Parameter Interface:
Interface Level 1:
| 1 | Type of call | Input | Binary(4) |
| 2 | Application handle | Input | Char(8) |
| 3 | Object name | Input | Char(10) |
| 4 | Library name | Input | Char(10) |
| 5 | Object type | Input | Char(10) |
| 6 | Help module name | Input | Char(32) |
| 7 | Panel name | Input | Char(10) |
| 8 | Condition name | Input | Char(10) |
| 9 | Return code | Output | Char(1) |
Interface Level 2:
No additional parameters are required for interface level 2.
An exit program may be called during condition evaluation for conditions specified on the EXPR attribute of the COND tag and the LINKWHEN and UNLESSn attributes of the LINK tag.
The exit program can be provided for those instances when the determination of user class or existence of an object is not sufficient.
The exit program is called during the evaluation of conditions on a panel. For hypertext link calls, this program will be run every time. When the CHKPGM function is specified on the COND tag, the EVAL attribute on the COND tag will determine when this program is called. A return code set by the exit program will indicate to UIM whether the CHKPGM function should be evaluated to true or false.
The default for the function will be false if the exit program cannot be called. A message will be displayed at the bottom of the panel in the case of an error on the call to the exit program.
If the exit program is being called to process a COND tag on a menu item in a *MENU object, the multiple parameter interface will always be used. The multiple parameter interface will always be used when processing the the LINKWHEN and UNLESSn attributes on a hypertext link also.
Authorities and Locks
None.
Required Parameter Group
- Panel item 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:
12 The exit program is called to evaluate the condition for the given panel group, menu, or hypertext link.
- Application handle
- INPUT; CHAR(8)
The application handle of the application that is currently being processed by the UIM. This value is set only when a *PNLGRP object is being processed. It is set to blanks when the exit program is called for a *MENU object or LINK tag condition processing.
- Object name
- INPUT; CHAR(10)
The name of the panel group or menu object that is being processed. If the exit program is called to process the condition on a LINKWHEN or UNLESSn attribute on a LINK tag, this parameter contains the name of the panel group that contains the help identifier named in the LINK tag.
- Library name
- INPUT; CHAR(10)
The name of the library that contains the object that is being processed. If the exit program is called to process the condition on a LINKWHEN or UNLESSn attribute on a LINK tag, this parameter contains the name of the library that contains the panel group named in the object name parameter.
- Object type
- INPUT; CHAR(10)
The type of object (*MENU or *PNLGRP) that is being processed.
- Help module name
- INPUT; CHAR(32)
The name of the help module that is being processed when the exit program is called to process the condition on a LINKWHEN or UNLESSn attribute on a LINK tag. When conditions on a menu or panel item are being processed, this parameter is blank.
- Panel name
- INPUT; CHAR(10)
The name of the panel that is being processed. This value is blank when the exit program is called to process the condition on a LINKWHEN or UNLESSn attribute on a LINK tag.
- Condition name
- INPUT; CHAR(10)
The name of the condition that is currently being evaluated. This is the name as it was entered on the COND NAME attribute of the panel group source. If the exit program is called to process the condition on a LINKWHEN or UNLESSn attribute on a LINK tag, this parameter is set to blanks.
- Return code
- OUTPUT; CHAR(1)
Return code from the exit program, indicating the true or false condition. If a value other than one of those listed below is returned, the condition is set to false.
1 Condition of the CHKPGM function is true. 0 Condition of the CHKPGM function is false.
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) | Object name |
| 34 | 22 | CHAR(10) | Library name |
| 44 | 2C | CHAR(10) | Object type |
| 54 | 36 | CHAR(32) | Help module name |
| 86 | 56 | CHAR(10) | Panel name |
| 96 | 60 | CHAR(10) | Condition name |
| 106 | 6A | CHAR(1) | Return code |
Field Descriptions
Application handle. The application handle of the application that is currently being processed by the UIM. This value is set only when a *PNLGRP object is being processed. It is set to blanks when the exit program is called for a *MENU object or LINK tag condition processing.
Condition name. The name of the condition that is currently being evaluated. This is the name as it was entered on the COND NAME attribute of the panel group source. If the exit program is called to process the condition on a LINKWHEN or UNLESSn attribute on a LINK tag, this field is set to blanks.
Help module name. The name of the help module that is being processed when the exit program is called to process the condition on a LINKWHEN or UNLESSn attribute on a LINK tag. When conditions on a menu or panel item are being processed, this field is blank.
Library name. The name of the library that contains the object that is being processed. If the exit program is called to process the condition on a LINKWHEN or UNLESSn attribute on a LINK tag, this field contains the name of the library that contains the panel group named in the object name parameter.
Object name. The name of the panel group or menu object that is being processed. If the exit program is called to process the condition on a LINKWHEN or UNLESSn attribute on a LINK tag, this field contains the name of the panel group that contains the help identifier named in the LINK tag.
Object type. The type of object (*MENU or *PNLGRP) that is being processed.
Panel name. The name of the panel that is being processed. This value is blank when the exit program is called to process the condition on a LINKWHEN or UNLESSn attribute on a LINK tag.
Reserved. A reserved field.
Return code. Return code from the exit program, indicating the true or false condition. If a value other than one of those listed below is returned, the condition is set to false.
| 1 | Condition of the CHKPGM function is true. |
| 0 | Condition of the CHKPGM function is false. |
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:
| 12 | The exit program is called to evaluate the condition for the given panel group, menu, or hypertext link. |
Exit program introduced: V4R4
[ Back to top | User Interface Manager APIs | APIs by category ]