Data Queue APIs--Categories - FTP Directory Listing - IBM
Data Queue APIs--Categories - FTP Directory Listing - IBM Data Queue APIs--Categories - FTP Directory Listing - IBM
Retrieve User Index Entries (QUSRTVUI) API 7 8 Find the first index entry or entries. Last Find the last index entry or entries. Between Find all entries between the two arguments specified in the search criteria. Search criteria INPUT; CHAR(*) The criteria used to find matches in the user index. If the search type is 8 (between), both search elements must have the same length. When the search type is 8 (between), this parameter contains two search elements. The first element is considered the starting element, and the second element is the ending element. This parameter is ignored when the search type parameter is 6 (first) or 7 (last). Length of search criteria INPUT; BINARY(4) The length of the search criteria that is to be used. This parameter is ignored when the search type is 6 (first) or 7 (last). If the search type is 8 (between), this parameter specifies the length of the first element. The second element must have the same length as the first element. Valid values are 1-2000, depending on how the user index was created. For a fixed and keyed user index, the length of the search criteria: ❍ Can be greater than the length of the key ❍ Must be less than or equal to the entry length Search criteria offset INPUT; BINARY(4) The offset of the second search element from the beginning of the search criteria parameter. This parameter is ignored unless the search type is 8 (between). Error code I/O; CHAR(*) The structure in which to return error information. For the format of the structure, see Error Code Parameter. http://infocntr.rchland.ibm.com/pubs/html/as400/v4r5/ic2924/info/apis/qusrtvui.htm (5 of 8) [10/4/1999 2:34:12 PM]
Retrieve User Index Entries (QUSRTVUI) API Format for Entry Lengths and Entry Offsets The following information is returned in the entry lengths and entry offsets parameter. The information is needed to parse through the receiver variable. For detailed descriptions of the fields in the table, see Field Descriptions. Offset Dec Hex Type Field 0 0 BINARY(4) Bytes returned 4 4 BINARY(4) Bytes available Note: The following fields will be repeated. The number of times they are repeated depends on the length of the entry lengths and entry offsets parameter and the number of entries actually retrieved. BINARY(4) Entry length BINARY(4) Entry offset IDXE0100 Format The following index information is returned for the IDXE0100 format in the receiver variable parameter. For detailed descriptions of the fields in the table, see Field Descriptions. Offset Dec Hex Type Field 0 0 BINARY(4) Bytes returned 4 4 BINARY(4) Bytes available 8 8 CHAR(*) Entry 1-n Field Descriptions Bytes available. The length of all data available to return. All available data is returned if enough space is provided. Bytes returned. The length of the data actually returned. Entry length. The length of the entry retrieved from the index. Valid values are 1-2000, depending on how the user index was created. Entry offset. The number of bytes from the beginning of the immediately preceding entry to the first byte of the entry returned. For the first entry, the offset is the number of bytes from the beginning of the receiver variable to the first byte of the first entry. Entry 1-n. All entries that satisfy the search criteria (up to the maximum number of entries parameter) are returned. User indexes are created to contain only scalar data, which results in the index entries being contiguous. Use the entry length and entry offset values to parse this field. This field is repeated by the value in the number of entries returned parameter if the receiver variable is http://infocntr.rchland.ibm.com/pubs/html/as400/v4r5/ic2924/info/apis/qusrtvui.htm (6 of 8) [10/4/1999 2:34:12 PM]
- Page 37 and 38: User Queue APIs User Queue APIs Thi
- Page 39 and 40: Create User Queue (QUSCRTUQ) API To
- Page 41 and 42: Create User Queue (QUSCRTUQ) API Au
- Page 43 and 44: Create User Queue (QUSCRTUQ) API Do
- Page 45 and 46: Create User Queue (QUSCRTUQ) API Ex
- Page 47 and 48: Delete User Queue (QUSDLTUQ) API De
- Page 49 and 50: Delete User Queue (QUSDLTUQ) API CP
- Page 51 and 52: User Index APIs For details about M
- Page 53 and 54: Add User Index Entries (QUSADDUI) A
- Page 55 and 56: Add User Index Entries (QUSADDUI) A
- Page 57 and 58: Add User Index Entries (QUSADDUI) A
- Page 59 and 60: Create User Index (QUSCRTUI) API Mo
- Page 61 and 62: Create User Index (QUSCRTUI) API IN
- Page 63 and 64: Create User Index (QUSCRTUI) API Op
- Page 65 and 66: Create User Index (QUSCRTUI) API Se
- Page 67 and 68: Create User Index (QUSCRTUI) API ht
- Page 69 and 70: Delete User Index (QUSDLTUI) API Al
- Page 71 and 72: Remove User Index Entries (QUSRMVUI
- Page 73 and 74: Remove User Index Entries (QUSRMVUI
- Page 75 and 76: Remove User Index Entries (QUSRMVUI
- Page 77 and 78: Remove User Index Entries (QUSRMVUI
- Page 79 and 80: Retrieve User Index Attributes (QUS
- Page 81 and 82: Retrieve User Index Attributes (QUS
- Page 83 and 84: Retrieve User Index Attributes (QUS
- Page 85 and 86: Retrieve User Index Entries (QUSRTV
- Page 87: Retrieve User Index Entries (QUSRTV
- Page 91 and 92: Retrieve User Index Entries (QUSRTV
- Page 93 and 94: User Space APIs the user space, suc
- Page 95 and 96: Change User Space (QUSCHGUS) API Re
- Page 97 and 98: Change User Space (QUSCHGUS) API Al
- Page 99 and 100: Change User Space Attributes (QUSCU
- Page 101 and 102: Change User Space Attributes (QUSCU
- Page 103 and 104: Create User Space (QUSCRTUS) API Cr
- Page 105 and 106: Create User Space (QUSCRTUS) API IN
- Page 107 and 108: Create User Space (QUSCRTUS) API de
- Page 109 and 110: Create User Space (QUSCRTUS) API CP
- Page 111 and 112: Delete User Space (QUSDLTUS) API Q.
- Page 113 and 114: Retrieve Pointer to User Space (QUS
- Page 115 and 116: Retrieve Pointer to User Space (QUS
- Page 117 and 118: Retrieve User Space (QUSRTVUS) API
- Page 119 and 120: Retrieve User Space (QUSRTVUS) API
- Page 121 and 122: Retrieve User Space Attributes (QUS
- Page 123 and 124: Retrieve User Space Attributes (QUS
- Page 125 and 126: Change Library List (QLICHGLL) API
- Page 127 and 128: Change Library List (QLICHGLL) API
- Page 129 and 130: Change Object Description (QLICOBJD
- Page 131 and 132: Change Object Description (QLICOBJD
- Page 133 and 134: Change Object Description (QLICOBJD
- Page 135 and 136: Change Object Description (QLICOBJD
- Page 137 and 138: Change Object Description (QLICOBJD
Retrieve User Index Entries (QUSRTVUI) API<br />
7<br />
8<br />
Find the first index entry or entries.<br />
Last<br />
Find the last index entry or entries.<br />
Between<br />
Find all entries between the two arguments specified in the search criteria.<br />
Search criteria<br />
INPUT; CHAR(*)<br />
The criteria used to find matches in the user index.<br />
If the search type is 8 (between), both search elements must have the same length. When the search<br />
type is 8 (between), this parameter contains two search elements. The first element is considered the<br />
starting element, and the second element is the ending element.<br />
This parameter is ignored when the search type parameter is 6 (first) or 7 (last).<br />
Length of search criteria<br />
INPUT; BINARY(4)<br />
The length of the search criteria that is to be used. This parameter is ignored when the search type is<br />
6 (first) or 7 (last).<br />
If the search type is 8 (between), this parameter specifies the length of the first element. The second<br />
element must have the same length as the first element. Valid values are 1-2000, depending on how<br />
the user index was created.<br />
For a fixed and keyed user index, the length of the search criteria:<br />
❍ Can be greater than the length of the key<br />
❍ Must be less than or equal to the entry length<br />
Search criteria offset<br />
INPUT; BINARY(4)<br />
The offset of the second search element from the beginning of the search criteria parameter. This<br />
parameter is ignored unless the search type is 8 (between).<br />
Error code<br />
I/O; CHAR(*)<br />
The structure in which to return error information. For the format of the structure, see Error Code<br />
Parameter.<br />
http://infocntr.rchland.ibm.com/pubs/html/as400/v4r5/ic2924/info/apis/qusrtvui.htm (5 of 8) [10/4/1999 2:34:12 PM]
Change language