Data Queue APIs--Categories - FTP Directory Listing - IBM
Data Queue APIs--Categories - FTP Directory Listing - IBM
Data Queue APIs--Categories - FTP Directory Listing - IBM
You also want an ePaper? Increase the reach of your titles
YUMPU automatically turns print PDFs into web optimized ePapers that Google loves.
Retrieve User Index Entries (QUSRTVUI) API<br />
8 + (the maximum number of entries parameter * 8)<br />
You must provide enough space in both the receiver variable and the entry lengths and entry offsets<br />
parameter for this API to return this information to you. You will not receive complete information<br />
in the following two situations.<br />
❍ You provide enough space in the receiver variable parameter for the API to return all index<br />
entries, but there is not enough space in the entry lengths and entry offset parameter to return<br />
the lengths and offsets for all entries. You will be unable to parse through all of the entries in<br />
the receiver variable parameter. Check the bytes returned and bytes available fields in the<br />
entry lengths and entry offsets parameter to ensure that the information is complete.<br />
❍ You provide enough space in the entry lengths and entry offsets parameter to return all<br />
lengths and offsets, but there is not enough space in the receiver variable parameter to return<br />
all index entries removed. Some of the entry lengths and entry offsets will not be valid; they<br />
will refer to index entries that could not be returned to you. Check the bytes returned and<br />
bytes available fields in the receiver variable parameter to ensure that the information is<br />
complete.<br />
See the Format for Entry Lengths and Entry Offsets for details about the data structure.<br />
Length of entry lengths and entry offsets<br />
INPUT; BINARY(4)<br />
The length of the entry lengths and entry offsets parameter. If the length is longer than the entry<br />
lengths and entry offsets parameter, the results may not be predictable. The minimum length is 8.<br />
If the receiver variable cannot hold all the entries that satisfy the search criteria:<br />
❍ The entries are truncated.<br />
❍ Not all the information in the entry lengths and entry offsets parameter is valid.<br />
Number of entries returned<br />
OUTPUT; BINARY(4)<br />
The total number of index entries found that satisfy the search criteria. If this field is 0, no entries<br />
satisfied the search criteria. This value can never be greater than the maximum number of entries<br />
parameter.<br />
Returned library name<br />
OUTPUT; CHAR(10)<br />
The name of the library that contains the user index from which the entries were successfully<br />
retrieved. This parameter is not set if an error occurs.<br />
Qualified user index name<br />
INPUT; CHAR(20)<br />
The user index for which you want to retrieve information, and the library in which it is located. The<br />
first 10 characters contain the user index name, and the second 10 characters contain the library<br />
name. You can use these special values for the library name:<br />
http://infocntr.rchland.ibm.com/pubs/html/as400/v4r5/ic2924/info/apis/qusrtvui.htm (3 of 8) [10/4/1999 2:34:12 PM]
Change language