TurboIMAGE/XL Database Management System Reference Manual (30391-90012)

180 Chapter5
TurboIMAGE/XL Library Procedures
DBFIND
documentation for additional DBFIND modes. The section on DBUTIL in
chapter 8 of this book has a brief description of the TPI option.
status is the name of an array of 10 halfwords in which TurboIMAGE/XL returns
status information about the procedure. If the procedure executes
successfully, the status array contents are:
Element Contents
1 If the procedure succeeds, the return status is 0. Table
5-11. describes the contents of element 1 when the
procedure does not succeed.
2 Zero.
3-4 Word current record number set to zero.
5-6 Word count of number of entries in chain or qualifier. For
modes 21 and 24, 2
31
−1.
7-8 Word record number of last entry in chain. For modes 21
and 24, 2
31
−1 for details. Always zeroes for masters.
9-10 Word record number of first entry in chain. For modes 21
and 24, 2
31
−1 for details. Always zeroes for masters.
item is the name of an array containing a left-justified name of the detail data
set search item or is an integer referencing the search item number that
defines the path containing the desired chain. The specified search item
defines the path to which the chain belongs. For a B-Tree DBFIND on a
master, it is the key item name or a number. The name can be up to 16
characters long. If shorter, it must be terminated by a semicolon or a
blank.
argument contains a value for the key item to be used in calculated access to locate
the desired chain head in the master data set for non-B-Tree index
searches. This is referred to as a simple argument. For B-Tree index
searches, there are two formats. One is for mode 1 wildcard searches on X
and U types and allows a trailing wildcard character. The argument is
scanned for the first occurrence of the wildcard character, for example, an
@ character. Subsequent text in the item value is ignored.