Data Queue APIs--Categories - FTP Directory Listing - IBM
Data Queue APIs--Categories - FTP Directory Listing - IBM
Data Queue APIs--Categories - FTP Directory Listing - IBM
Create successful ePaper yourself
Turn your PDF publications into a flip-book with our unique Google optimized e-Paper software.
Remove User Index Entries (QUSRMVUI) API<br />
OUTPUT; ARRAY of CHAR(8)<br />
A data structure that contains entry lengths and entry offsets for all entries that were found that met<br />
the remove criteria parameter. An entry length and entry offset exist for every entry returned in the<br />
entries removed parameter. These entry lengths and entry offsets are used to parse through the<br />
entries removed parameter. If the length of entries removed parameter is 0, this information will not<br />
be returned.<br />
The size of the entry lengths and entry offsets parameter should be at least:<br />
8 + (the maximum number of entries parameter * 8)<br />
You must provide enough space in both the entries removed and the entry lengths and offset<br />
parameter for this API to return complete information to you.<br />
You will not receive complete information in the following two situations.<br />
❍ You provide enough space in the entries removed parameter for the API to return all index<br />
entries removed, but there is not enough space in the entry lengths and entry offset parameter<br />
to return the lengths and offsets for all entries. You will be unable to parse through all of the<br />
entries in the entries removed parameter. Check the bytes returned and bytes available fields<br />
in the entry lengths and entry offsets parameter to ensure 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 entries removed 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 entries removed parameter to ensure that the information is<br />
complete.<br />
See Format for Entry Lengths and Entry Offsets for details on 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. If the length is longer than the entry lengths and<br />
entry offsets parameter, the results may not be predictable. The minimum length is 8. If the length of<br />
entries removed parameter is 0, which means you do not want the entries removed to be returned,<br />
this parameter is ignored.<br />
Returned library name<br />
OUTPUT; CHAR(10)<br />
The name of the library that contains the user index from which the entries were removed. If the<br />
entries are successfully removed from the user index, the name of the library that contained the user<br />
index entries is returned. This parameter is not set if an error occurs.<br />
Qualified user index name<br />
INPUT; CHAR(20)<br />
The user index from which you want to remove entries, 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 />
http://infocntr.rchland.ibm.com/pubs/html/as400/v4r5/ic2924/info/apis/qusrmvui.htm (3 of 8) [10/4/1999 2:33:55 PM]
Change language