Data Queue APIs--Categories - FTP Directory Listing - IBM

Retrieve User Index Entries (QUSRTVUI) API
User Index Lock
*SHRUPD
Required Parameter Group
Receiver variable
OUTPUT; CHAR(*)
The variable that is to receive the information requested. You can specify the size of this area to be
smaller than the format requested as long as you specify the length parameter correctly. As a result,
the API returns only the data that the area can hold.
Use the entry lengths and entry offsets parameter to parse through this parameter. If the number of
entries returned parameter is 0, then only the bytes available and the bytes provided have been
changed.
To determine if all the entries are valid in the receiver variable, compare the bytes returned and
bytes available fields. If the bytes returned are less than the bytes available, your receiver variable is
not large enough to hold all the entries that match the search criteria parameter. While processing
the entries, you need to make sure that both:
❍ Your current offset in the receiver variable plus the entry offset is less than the length of the
receiver variable
❍ Your current offset in the receiver variable plus the entry offset plus the entry length is less
than the length of the receiver variable.
The size of the receiver variable parameter should be greater than or equal to:
8 + (the maximum number of entries parameter
* the maximum entry length)
The maximum entry length was defined when the index was created. It can be obtained by using the
Retrieve User Index Attributes (QUSRUIAT) API.
Refer to the IDXE0100 Format for the layout of this parameter.
Length of receiver variable
INPUT; BINARY(4)
The length of the receiver variable. If the length is larger than the size of the receiver variable, the
results may not be predictable. The minimum length is 8 bytes.
Entry lengths and entry offsets
OUTPUT; ARRAY(*) of CHAR(8)
A data structure containing entry lengths and entry offsets for all entries found that met the search
criteria. An entry length and entry offset exist for every entry returned in the receiver variable.
These entry lengths and entry offsets are used to parse through the receiver variable.
The size of the entry lengths and entry offsets parameter should be at least:
http://infocntr.rchland.ibm.com/pubs/html/as400/v4r5/ic2924/info/apis/qusrtvui.htm (2 of 8) [10/4/1999 2:34:12 PM]