Update List Entry (QUIUPDLE) API

The Update List Entry (QUIUPDLE) API updates the list entry identified by the current entry pointer for the list or the extended action entry. The current contents of all dialog variables corresponding to dialog variables in the list are saved in the entry. The current entry pointer of the list is not changed by this operation.

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.

Variable buffer

INPUT; CHAR(*)

The program buffer from which dialog variable values are copied. The 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, which is defined in the panel group for this open application, dialog variables are copied from the variable buffer to the application variable pool before the list entry is updated. The operation of this parameter is the same as using the Put Dialog Variable (QUIPUTV) API immediately before the QUIUPDLE API.

The variable buffer must be large enough to contain all the variables specified in the variable record definition.

Variable buffer length

INPUT; BINARY(4)

The length of the variable buffer provided. The buffer must be large enough to contain all the dialog variables in the definition of the variable record, specified in the variable record name parameter.

Variable record name

INPUT; CHAR(10)

The name of the variable record that determines which dialog variables are copied between the variable buffer and 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 done during the QUIUPDLE API. The variable buffer parameter is ignored when this value is used.

List name

INPUT; CHAR(10)

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

Option

INPUT; CHAR(4)

The updated list entry. One of the following values must be specified:

EXTE	The extended action entry is updated.
SAME	The list entry identified by the current entry pointer is updated.

List entry handle

OUTPUT; CHAR(4)

The list entry handle for the updated list entry. 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.

When the option parameter has the value EXTE, this parameter returns the value EXTE, indicating that the extended action entry is updated.

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 ]