TRANSFER Reference Manual

SCAN-FOLDER-BY-KEY
TISERV UOW Descriptions
069139, Update 1 to 40969 Tandem Computers Incorporated 2–473
MAX-KEY-LEN
refers to the ORDERING-KEY field returned with each item in ITEM-RETURNED.
This is the maximum number of bytes in ORDERING-KEY to be returned. The
maximum value for MAX-KEY-LEN is 200. If this field is less than 0 or greater
than 200, the error E-INVALID-KEY-LEN is returned.
Ordering keys that are shorter than MAX-KEY-LEN are automatically padded
with the padding character specified by the PAD-CHAR field.
Ordering keys that are longer than MAX-KEY-LEN are truncated, and the warning
W-ORD-KEY-TRUNCATED is returned. The length returned in the
corresponding ORDERING-KEY-LEN field, however, is the actual length or the
ordering key, prior to truncation.
MAX-KEY-LEN should be an even number length so that all elements of ITEMS-
RETURNED are word aligned. If the number in MAX-KEY-LEN is odd, TISERV
automatically increments this value by 1 and returns the warning W-MAX-KEY-
LEN-ADJUSTED. This warning, however, is overridden by the warnings W-EOF
and W-ORD-KEY-TRUNCATED.
In the response, the input to this field is echoed as output.
PAD-CHAR
is the character to be used for padding the returned ORDERING-KEY when the
ordering key is shorter than MAX-KEY-LEN. In the response, the input to this
field is echoed as output.
STARTING-DUPLICATE
is used with folders that contain duplicate ordering keys. This field contains an
internal restart value that is used to distinguish between items with duplicate
ordering keys.
On the initial call to SCAN-FOLDER-BY-KEY, STARTING-DUPLICATE is not
used.
When you use STARTING-DUPLICATE, STARTING-KEY must contain the full
ordering key as returned in the response STARTING-KEY field. In the response,
STARTING-DUPLICATE corresponds to the last item returned in the current scan.
This is the appropriate setting for the STARTING-DUPLICATE field in the request
for a subsequent scan of the same folder.
STARTING-KEY
is the ordering key of the first item to retrieve. The size must be consistent with
STARTING-KEY-LEN. In the response, STARTING-KEY corresponds to the last
item returned in the current scan. This is the appropriate setting for the
STARTING-KEY field in the request for a subsequent scan of the same folder.