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.
Remove User Index Entries (QUSRMVUI) API<br />
Required Parameter Group<br />
Number of entries removed<br />
OUTPUT; BINARY(4)<br />
The number of index entries, satisfying the values specified on the remove criteria parameter, that<br />
were successfully removed from the user index. If this field is 0, no entries satisfied the remove<br />
criteria. This value can never be greater than the maximum number of entries parameter.<br />
Entries removed<br />
OUTPUT; CHAR(*)<br />
The actual entries removed. All entries that satisfied the remove criteria parameter and were<br />
removed (up to the maximum number of entries parameter) are returned if sufficient space is<br />
provided. The API returns only the data that the area can hold.<br />
The size of the entries removed parameter should be greater than or equal to:<br />
8 + (the maximum number of entries parameter<br />
* the maximum entry length)<br />
The maximum entry length was defined when the index was created. It can be obtained by using the<br />
Retrieve User Index Attributes (QUSRUIAT) API.<br />
To determine if all the entries are valid in the entries removed parameter, compare the bytes<br />
returned and the bytes available fields in the entries removed parameter.<br />
The entries are always returned starting with the entry that is closest to or equal to the remove<br />
argument. Then entries are kept in the order that they proceed away from the remove criteria<br />
parameter. Each entry removed from the user index is based on the binary value of the remove<br />
criteria. No other collating sequence is supported. User indexes can contain only scalar data, which<br />
makes the index entries contiguous. Use the entry lengths and entry offsets parameter to parse the<br />
entries that were removed and returned in this parameter.<br />
If you do not want the entries that were removed to be returned in this parameter, specify 0 for the<br />
length of entries removed parameter.<br />
Every entry removed causes the number of entries removed parameter to be incremented by 1. You<br />
can also use the Retrieve User Index Attributes (QUSRUIAT) API to retrieve this information.<br />
Refer to IDXE0100 Format for the layout of this parameter.<br />
Length of entries removed<br />
INPUT; BINARY(4)<br />
The length of the entries removed parameter. If this length is larger than the actual size of the entries<br />
removed parameter, the results may not be predictable. The minimum length is 0 or >= (greater than<br />
or equal to) 8 bytes. If 0 is used, the entries removed from the index are not returned and the bytes<br />
returned and the bytes available in the entries removed parameter are not set.<br />
Entry lengths and entry offsets<br />
http://infocntr.rchland.ibm.com/pubs/html/as400/v4r5/ic2924/info/apis/qusrmvui.htm (2 of 8) [10/4/1999 2:33:55 PM]
Change language