Remove List Entry (QUIRMVLE) API

The Remove List Entry (QUIRMVLE) API removes the list entry identified by the value of the current entry pointer for the list. The current entry pointer is always updated to the entry before the one removed. If the first list entry is removed, the current entry pointer is set to the top of the list if the list is complete at the top.

If the list is incomplete at the top, the UIM calls the incomplete list extension program to add another entry to the list.

If the list entry identified by the display position attribute parameter of the Set List Attributes (QUISETLA) API is removed, the display position attribute is set at the entry before the one that was removed. If the new display position attribute is the first entry in the list, the display position attribute is set at the top of the list (logically the entry before the first entry in the list) if the list is complete at the top.

Authorities and Locks

None.

Required Parameter Group

Application handle

INPUT; CHAR(8)

The application handle 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.

List name

INPUT; CHAR(10)

The name of the list from which an entry is removed. If the list is not currently active in the open application, an error message is reported. A list is made active the first time an entry is inserted with the Add List Entry (QUIADDLE) API, Add List Multiple Entries (QUIADDLM) API, or its attributes are set with the QUISETLA API.

Extend option

INPUT; CHAR(1)

Specifies whether or not an incomplete list is automatically extended in an attempt to remove the first entry from a list that is incomplete at the top. One of the following values must be specified:

Y	The list is extended, if necessary, to add at least one entry to the top of the list or to mark the list as complete at the top.
N	The list is not extended to find the entry before the entry being removed, and the entry is not removed from the list.

List entry handle

OUTPUT; CHAR(4)

The list entry handle value from the current entry pointer. A list entry handle uniquely distinguishes an entry until it is removed from the list, even if other entries are inserted and removed from the list. A value of TOP indicates that the current entry pointer is positioned at the top of 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