TRANSFER Reference Manual

SCAN-FOLDER-BY-KEY
TISERV UOW Descriptions
2–472 069139, Update 1 to 40969 Tandem Computers Incorporated
NUM-REQUESTED
is the number of items to be retrieved from the folder. The value of NUM-
REQUESTED affects the size of the response UOW. The maximum of this number
is dependent on the value of MAX-KEY-LEN. The suggested maximum for a
MAX-KEY-LEN of 200 would be 10. Based on a MAX-KEY-LEN of 200 and a
maximum IPC size of 3000 bytes containing the reply for a single SCAN-FOLDER-
BY-KEY UOW, about 10 items can be contained in the SCAN-FOLDER-BY-KEY
response; this estimate includes IPC and UOW response overhead with the result
rounded down. The maximum size for an IPC is application dependent, although
3000 bytes is a reasonable upper bound. In the response, the input to NUM-
REQUESTED is echoed as output.
STARTING-KEY-LEN
is the length, in bytes, of the initial ordering key information in the STARTING-
KEY field. This field together with STARTING-KEY and STARTING-DUPLICATE
determines which item is the first retrieved. The first item in the folder with an
ordering key either equal to or greater than STARTING-KEY for STARTING-KEY-
LEN bytes is the first item returned in the ITEMS-RETURNED field. Only the first
STARTING-KEY-LEN bytes of STARTING-KEY are used; the remainder of the
field is ignored.
To retrieve the first item in the folder, set this field to 0; when length is set to 0,
GENERIC-KEY-LEN and SKIP-EXACT are ignored.
The maximum value for STARTING-KEY-LEN is 200. If this field is less than 0 or
greater than 200, the error E-INVALID-KEY-LEN is returned.
In the response, STARTING-KEY-LEN corresponds to the last item returned in the
current scan. This is the appropriate setting for the STARTING-KEY-LEN field in
the request for a subsequent scan of the same folder.
GENERIC-KEY-LEN
is the length, in bytes, of the STARTING-KEY to be used for generic matching.
The maximum value for GENERIC-KEY-LEN is 200. If this field is less than 0 or
greater than 200, the error E-INVALID-KEY-LEN is returned.
If GENERIC-KEY-LEN is greater than 0, only items with ordering keys
matching STARTING-KEY for GENERIC-KEY-LEN bytes are returned.
If GENERIC-KEY-LEN is 0, generic matching is not used.
If this field is not less than or equal to STARTING-KEY-LEN, the error
E-INVALID-KEY-LEN is returned. In the response, input to this field is echoed as
output.