TRANSFER Reference Manual

SCAN-FOLDER
TISERV UOW Descriptions
069139, Update 1 to 40969 Tandem Computers Incorporated 2–461
SCAN-FOLDER
(UOW Code 120)
SCAN-FOLDER scans the contents of a folder and retrieves the IDs of items in the
folder. SCAN-FOLDER returns item IDs according to the ordering key by which items
were saved in the folder. If you scan a folder that is in APPLIC-DEFINED order and
requires the ordering key of each item, use the SCAN-FOLDER-BY-KEY UOW.
SCAN-FOLDER differs from the SCAN-FOLDER-B00 UOW in that it does not return
the unsave time of the item; you must use the SCAN-FOLDER-B00 UOW to have the
unsave time returned.
Although SCAN-FOLDER does return named items, it does not allow you to scan
folders by search criteria for selected named items; you must use the SCAN-BY-ITEM-
NAME UOW for this purpose. SCAN-BY-ITEM-NAME retrieves the item name in
addition to the item ID and the unsave time of the items it returns. The names of items
returned by SCAN-FOLDER can be obtained with the GET-ITEM-NAME UOW.
DEF scan-folder-uow.
02 hdr.
03 self-ident PIC AA VALUE "UW".
03 uow-code TYPE BINARY 16 UNSIGNED
VALUE 120.
02 folder-name PIC X(80).
02 item-id.
03 dummy PIC X(12).
02 options.
03 filter-by-item-type TYPE BOOLEAN.
03 reserved-1 TYPE BOOLEAN VALUE "N".
03 item-type PIC 9(4) COMP.
02 num-requested TYPE BINARY 16 UNSIGNED
VALUE 20.
END.
DEF scan-folder-rsp.
02 hdr.
03 self-ident PIC AA VALUE "UW".
03 uow-code TYPE BINARY 16 UNSIGNED
VALUE 120.
02 retn-code TYPE BINARY 16.
02 retn-code-detail TYPE BINARY 16.
02 num-returned TYPE BINARY 16 UNSIGNED.
02 items-returned.
03 item-id.
04 dummy PIC X(12) OCCURS 0 TO 20 TIMES
DEPENDING ON num-returned.
END.
HDR
is the UOW header. The UOW-CODE value is 120.