Retrieve List Attributes (QUIRTVLA) API

  Required Parameter Group:

  Default Public Authority: *USE

  Threadsafe: No

The Retrieve List Attributes (QUIRTVLA) API retrieves the following list attributes:

Authorities and Locks


Required Parameter Group

Application handle

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

List name

The name of the list whose attributes are retrieved. 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) or Add List Multiple Entries (QUIADDLM) API, or the fist time the list's attributes are set with the Set List Attributes (QUISETLA) API.


The current attributes of the list. For the format of the receiver variable, see Format of Data Returned.

Receiver length

The amount of data the application program is prepared to receive. If the length specified is larger than the amount of data available, the receiver is not changed beyond the amount of data available.

Error code
I/O; CHAR(*)

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

Format of Data Returned

The format of the data available, returned in the receiver parameter, is as follows:

Error Messages

API introduced: V2R2

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