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

Add User Index Entries (QUSADDUI) API
The number of entries that are to be added to the user index. Valid values are 1 through 4095.
Error code
I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error Code
Parameter.
Format for Entry Lengths and Entry Offsets
The following table defines the format for the entry lengths and entry offsets parameter. This information
is needed to parse through the index entries parameter. For detailed descriptions of the fields in the table,
see Field Descriptions.
Offset
Note: The following fields
will be repeated. The number
of times they are repeated
depends on the value specified
in the number of entries
parameter.
Type Field Dec Hex
BINARY(4) Entry
length
Field Descriptions
BINARY(4) Entry
offset
Entry length The length of the entry to be inserted into the index. Valid values are 1-2000. This value
depends on how the user index was created.
Entry offset. For the first entry, the offset is the number of bytes from the beginning of the index entries
parameter to the first byte of the first entry. For each subsequent entry, the offset is the number of bytes
from the beginning of the previous entry to the first byte of the next entry. Each entry offset value must be
greater than or equal to 0 and must refer to an entry within the index entries parameter.
Error Messages
CPF24B4 E
Severe error while addressing parameter list.
CPF3CF1 E
Error code parameter not valid.
CPF3C7B E
Length of index entries is not valid.
CPF3C7C E
User index is full.
http://infocntr.rchland.ibm.com/pubs/html/as400/v4r5/ic2924/info/apis/qusaddui.htm (4 of 6) [10/4/1999 2:33:37 PM]