Add List Entry (QUIADDLE) API

The Add List Entry (QUIADDLE) API adds one new entry to a list. The new entry is inserted immediately before or immediately after the entry identified by the current entry pointer for the list. The new entry can also be inserted at the beginning or at the end of the list. On return to the application program, the current entry points to the newly inserted entry.

Authorities and Locks

None.

Required Parameter Group

Application handle

INPUT; CHAR(8)

A value assigned by the UIM and returned to the application program by the Open Display Application (QUIOPNDA) API or the Open Print Application (QUIOPNPA) API when the application is opened.

Variable buffer

INPUT; CHAR(*)

Program storage containing values of one or more dialog variables, from which dialog variable values are copied. Dialog variables are copied in the order specified in the variable record definition.

If the variable record name parameter specifies the name of a variable record defined in the panel group for an open application, dialog variables are copied from the variable buffer to the application variable pool before the list entry is added. This parameter operation is the same as using the Put Dialog Variable (QUIPUTV) API immediately before the QUIADDLE API.

Variable buffer length

INPUT; BINARY(4)

The length of the variable buffer. The buffer must be large enough to contain all the dialog variables in the variable record definition specified in the variable record name parameter. If the buffer is not large enough, an error condition is reported.

Variable record name

INPUT; CHAR(10)

The name of the variable record that determines which dialog variables are copied from the variable buffer to the application variable pool. The variable record must be defined in the panel group for the open application. The following special value can be used:

*NONE

The QUIPUTV API is not used during the QUIADDLE API. The variable buffer parameter and variable buffer length are ignored.

List name

INPUT; CHAR(10)

The name of the list to which an entry is added. If the list is not currently active in the open application, it is activated by this API.

Option

INPUT; CHAR(4)

The location of the new entry in the list. When an entry is added to the list, the current entry is always changed to point to the new list entry.

One of the following values must be specified to indicate the new entry's location:

FRST	Added as the first entry in the list
LAST	Added as the last entry in the list
NEXT	Added after the current entry
PREV	Added before the current entry

List entry handle

OUTPUT; CHAR(4)

A value representing an entry in a UIM list and returned to the application program representing the current entry in the list until it is removed from the list, even if other entries are inserted and removed from the list. This value is the handle of the entry just inserted in the list.

Error code

I/O; CHAR(*)

The structure in which to return error information. For the format of the structure, see Error code parameter.

Error Messages

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