Delete List (QUIDLTL) API

Required Parameter Group:

Application handle

Input

Char(8)

List name

Input

Char(10)

Error code

I/O

Char(*)

Default Public Authority: *USE

Threadsafe: No

The Delete List (QUIDLTL) API deletes an active list and provides a way for the application to start over with a new list.

QUIDLTL does not need to be used before the Close Application (QUICLOA) API because all lists associated with an open application are automatically deleted when the application is closed.

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 Open Print Application (QUIOPNPA) API when the application is opened.
List name: INPUT; CHAR(10)
The name of the list to be deleted. 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 Add List Multiple Entries (QUIADDLM) API, or when the list attributes are set with the Set List Attributes (QUISETLA) API.
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

Message ID

Error Message Text

CPF3C90 E

Literal value cannot be changed.

CPF6AA0 E

Request is not allowed when extending a list that is not complete.

CPF6A0B E

Application handle &3 not valid.

CPF6A0C E

Application domain error for application &1.

CPF6A0F E

Previous error occurred while running application &3.

CPF6A24 E

Parameter &1 not passed correctly.

CPF6A25 E

Return code length of &1 not valid.

CPF6A91 E

List &4 does not exist.

CPF6A92 E

List &4 not active.

CPF9872 E

Program or service program &1 in library &2 ended. Reason code &3.

API introduced: V2R2

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