TRANSFER Reference Manual

SCAN-FOLDER
TISERV UOW Descriptions
2–462 069139, Update 1 to 40969 Tandem Computers Incorporated
FOLDER-NAME
is the name of the folder whose contents are to be scanned. This can be a private
folder owned by the correspondent or any local shared folder owned by a group of
which the correspondent is a member.
ITEM-ID
identifies the item in the folder following which the retrieval is to start. You can
begin with the first item in the folder by setting this field to binary zeros. If the
starting ITEM-ID is nonzero, it must be the item ID of an item that is stored in the
folder. To refer to an item produced by a previous UOW within the same IPC, you
can replace ITEM-ID with ITEM-HANDLE, which is defined in “Commonly Used
Fields” at the beginning of this section.
Note If the ITEM-ID that you put in this field has been deleted, TISERV returns an error.
OPTIONS
allows you to filter the scan by selecting only items of a given type from the folder,
as follows:
To select this filtering, set FILTER-BY-ITEM-TYPE to Y and use the ITEM-
TYPE field to specify the item type.
To suppress filtering, set FILTER-BY-ITEM-TYPE to N.
The RESERVED-1 field in the OPTIONS structure is reserved for use by Tandem.
This field must be set to N.
NUM-REQUESTED
is the number of items to be retrieved from the folder. The suggested maximum is
200. Based on a maximum IPC size of 3000 bytes containing the reply for a single
SCAN-FOLDER UOW, about 200 items can be contained in the SCAN-FOLDER
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.