TRANSFER Reference Manual

SCAN-BY-ITEM-NAME
TISERV UOW Descriptions
2–458 069139, Update 1 to 40969 Tandem Computers Incorporated
FIRST-CALL
indicates whether this is an initial name search or a continuation of a previous
name search from the point specified by the input item name and the value of
RECALL-MATCH-LENGTH.
Y The search is an initial name search.
N The search is a continuation of previous search.
ITEM-TYPE
indicates the type of item to be retrieved; all other types of items are ignored.
Use this field only if FILTER-BY-ITEM-TYPE is set to Y.
RECALL-MATCH-LENGTH
indicates, together with the item name, for a continuation of a previous search,
where the search is to resume. This value is returned in a previous call to this
UOW, and must be used as input in the next SCAN-BY-ITEM-NAME request
where the FIRST-CALL option is set to N, to continue the current name search.
With each call to this UOW that is part of a continuing search, enter in the
RECALL-MATCH-LENGTH field the value returned to that field in the
response to the previous call.
NUM-REQUESTED
is the number of named items to be retrieved from the folder. The size of the
response depends on how many items you request. The suggested maximum
value for this field is 49. Based on a maximum IPC size of 3000 bytes containing
the reply for a single SCAN-BY-ITEM-NAME UOW, approximately 49 items can
be contained in the SCAN-BY-ITEM NAME response; this estimate includes IPC
and response overhead with the result rounded down. The maximum size for an
IPC is application dependent, although 3000 bytes is a reasonable upper bound.
RETN-CODE
is the return code. TISERV returns a code in this field to indicate one of the
following entries:
To indicate successful retrieval:
0 OK
To indicate problems with the item or item name:
-4001 W-EOF
4035 E-ITEM-NOT-FOUND
4047 E-REC-NOT-FOUND
4051 E-MUST-BE-YN
4056 E-INVALID-ITEM-TYPE
4062 E-INVALID-ITEM
-4063 W-ITEM-NOT-RETURNED