Using the User Interface Manager APIs

When calling the user interface manager (UIM) APIs, the calling program must pass arguments by reference. That is, all UIM API programs expect the calling program to pass a space pointer to each of the argument values. For some HLL compilers, this is the only way of passing arguments when calling a program.

Unless otherwise noted, all argument values must be in uppercase, and left-adjusted with trailing blanks. For example, if a program accepts a special value of "ALL" for a parameter defined as CHAR(4), "ALL" must be passed (without the quotes).


Terms and Definitions

Application variable pool. The set of all dialog variable values for an open application.

Argument list. In UIM, this list consists of values that are passed to a program.

Coded character set identifier (CCSID). A 32-bit number identifying a specific set of encoding scheme identifiers, character set identifiers, code page identifiers, and other relevant information that uniquely identifies the coded graphic character representation used.

Contextual help. Help information about a single item, such as the field on which the cursor is positioned when help is requested.

Dialog variable. A named element in a panel group used to pass data values between programs or between a program and a user. The current contents of all dialog variables corresponding to variables in the list are saved as each entry is added.

Error variable. The dialog variable specified on the ERRVAR attribute of the variable definition (VAR) tag. The error variable is used to set and test the error status of the dialog variable named on the NAME attribute of the VAR tag.

Extended action entry. The first line below the column headings in a list. This line contains entry-capable fields for the option column and for at least one additional list column.

Extended action list area. A list area of a panel that contains an extended action entry.

Extended help. Help information for all the items on the display; it contains all contextual help items and can contain additional information as well.

List entry handle. A value that uniquely distinguishes an entry in a UIM list until it is removed from the list. A list entry handle is meaningful only for a particular open application, list, and entry combination. It has no meaning in any other open UIM application, or even in the same application if the list or the entry is deleted and then re-created. Unpredictable results are possible if a list entry handle is used outside of this definition.

Message reference key. A unique string of characters that identify a particular instance of a message in a queue. The message key can also be used to refer to a specific instance of a message in order to move, receive, reply to, resend, or move it.

Open data path (ODP). A control block containing information about the merged file attributes and information returned by I/O operations.

Pop-up window. An area of the screen with visible borders, which supplements the dialog occurring in the full- screen panel or in a previous pop-up window.

Pull-down field choice. A choice that appears in a pull-down menu.

Trimming. An operation performed by removing a list entry from the end of the list opposite from the end where the new entry is added.

Variable buffer. A buffer used to pass dialog variables between the application program and the UIM.

Variable record. A named element of a panel group that identifies the content and layout of a buffer of dialog variables.

Window. An area on the display that is treated as a separate display. Windows have visible boundaries and appear to overlay the display from which they are requested.


[ Back to top | User Interface Manager APIs | APIs by category ]