| 1 | Cursor-sensitive prompt information | Input | Char(*) |
Interface Level 1:
| 1 | Type of call | Input | Binary(4) |
| 2 | Application handle | Input | Char(8) |
| 3 | Panel name | Input | Char(10) |
| 4 | Panel element type | Input | Char(1) |
| 5 | Dialog variable name | Input | Char(10) |
| 6 | List name | Input | Char(10) |
| 7 | List entry handle | Input | Char(4) |
Interface Level 2:
No additional parameters are required for interface level 2.
An exit program for handling a cursor prompt request can be specified on the PROMPT attribute of the data item (DATAI), data item extender (DATAIX), and list column (LISTCOL) tags. This attribute specifies the name of a dialog variable identifying the program to call.
This dialog variable cannot be blanks or nulls. The UIM cannot process a prompt request without the exit program.
Normally, the exit program displays a selection list panel. Such a list panel allows the user to select one or more entries from a list of possible choices. The application then sets the selected choices in the appropriate dialog variables, which are shown when the UIM redisplays the panel where the prompt function was requested.
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.
None.
A structure that provides information related to the user request. For details, see Single Parameter Structure.
This parameter must be set to the following value:
| 8 | The exit program is called to provide cursor-sensitive prompting. |
The application handle of the application that is currently being processed by the UIM.
The name of the panel that is currently being processed by the UIM.
One of the following values identify the type of panel element prompt:
| 1 | Prompts for a data item (DATAI tag). |
| 2 | Prompts for a data item extender (DATAIX tag). |
| 3 | Prompts for a list column (LISTCOL tag). |
The name of the dialog variable where the cursor was positioned when the prompt function was requested.
The name of the list where the cursor was positioned when the prompt function was requested. This parameter is set only when the panel element type parameter indicates that a LISTCOL tag is prompted.
The list entry handle where the cursor was positioned when the prompt function was requested. This parameter is set only when the panel element type parameter indicates that a LISTCOL tag is prompted.
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(1) | Panel element type |
| 35 | 23 | CHAR(1) | Reserved |
| 36 | 24 | CHAR(10) | Dialog variable name |
| 46 | 2E | CHAR(10) | List name |
| 56 | 38 | CHAR(4) | List entry handle |
Application handle. The application handle of the application that is currently being processed by the UIM.
Dialog variable name. The name of the dialog variable where the cursor was positioned when the prompt function was requested.
List name. The name of the list where the cursor was positioned when the prompt function was requested. This field is set only when the panel element type field indicates that a LISTCOL tag is prompted.
List entry handle. The list entry handle where the cursor was positioned when the prompt function was requested. This field is set only when the panel element type field indicates that a LISTCOL tag is prompted.
Panel element type. One of the following values identify the type of panel element prompt:
| 1 | Prompts for a data item (DATAI tag). |
| 2 | Prompts for a data item extender (DATAIX tag). |
| 3 | Prompts for a list column (LISTCOL tag). |
Panel name. The name of the panel that is currently being processed by the UIM.
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:
| 8 | The exit program is called to provide cursor-sensitive prompting. |
[ Back to top | User Interface Manager APIs | APIs by category ]