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 />
Format for Entry Lengths and Entry Offsets<br />
The following information is returned in the entry lengths and entry offsets parameter. The information is<br />
needed to parse through the receiver variable. For detailed descriptions of the fields in the table, see Field<br />
Descriptions.<br />
Offset<br />
Dec Hex<br />
Type Field<br />
0 0 BINARY(4) Bytes returned<br />
4 4 BINARY(4) Bytes available<br />
Note: The following fields will be repeated. The number of times they are repeated depends on the<br />
length of the entry lengths and entry offsets parameter and the number of entries actually retrieved.<br />
BINARY(4) Entry length<br />
BINARY(4) Entry offset<br />
IDXE0100 Format<br />
The following index information is returned for the IDXE0100 format in the receiver variable parameter.<br />
For detailed descriptions of the fields in the table, see Field Descriptions.<br />
Offset<br />
Dec Hex<br />
Type Field<br />
0 0 BINARY(4) Bytes returned<br />
4 4 BINARY(4) Bytes available<br />
8 8 CHAR(*) Entry 1-n<br />
Field Descriptions<br />
Bytes available. The length of all data available to return. All available data is returned if enough space is<br />
provided.<br />
Bytes returned. The length of the data actually returned.<br />
Entry length. The length of the entry retrieved from the index. Valid values are 1-2000, depending on<br />
how the user index was created.<br />
Entry offset. The number of bytes from the beginning of the immediately preceding entry to the first byte<br />
of the entry returned. For the first entry, the offset is the number of bytes from the beginning of the<br />
receiver variable to the first byte of the first entry.<br />
Entry 1-n. All entries that satisfy the search criteria (up to the maximum number of entries parameter) are<br />
returned. User indexes are created to contain only scalar data, which results in the index entries being<br />
contiguous. Use the entry length and entry offset values to parse this field.<br />
This field is repeated by the value in the number of entries returned parameter if the receiver variable is<br />
http://infocntr.rchland.ibm.com/pubs/html/as400/v4r5/ic2924/info/apis/qusrtvui.htm (6 of 8) [10/4/1999 2:34:12 PM]
Change language