| |
Locates related master set key item
entry that matches the specified search item value and sets up
pointers to the first and last entries of a detail data set chain in
preparation for chained access to the data entries which are members
of the chain. The path is determined and the chain pointers are
located on the basis of a specified search item and its value.
With the TPI modes, index access is supported.
DBFIND(base,dset,mode,status,item,argument)
- base
-
is the name of an array used as the base parameter when opening the
database. The first element of the array must contain the base ID
returned by DBOPEN. (Refer to DBOPEN for more information about the
base ID.)
- dset
-
is the name of an array containing the left-justified name of the
data set to which the entry is to be added, or is an integer
referencing the data set by number. The data set name can be up
to 16 characters long. If shorter, it must be terminated by a
semicolon, a space or the NUL character.
- mode
-
must be an integer equal to 1 or 10.
Please refer to the TPI Support
documentation for additional DBFIND modes.
- status
-
is the name of an array of 10 halfwords in which the database 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.
Otherwise it provides a status code to describe the failure.
|
| 2 |
Zero.
|
| 3-4 |
Word record number set to zero (32 bit).
|
| 5-6 |
Word count of number of entries in chain or qualifier (32 bit).
For modes 21 and 24 2^31-1 is returned.
|
| 7-8 |
If detail, word record number of predecessor on current
detail chain (32 bit).
For modes 21 and 24 2^31-1 is returned.
|
| 9-10 |
If detail, word record number of successor on current
detail chain (32 bit).
For modes 21 and 24 2^31-1 is returned.
|
- 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,
a space or the NUL character.
- 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. This is referred to as a
simple argument.
Notes:
-
As of Eloqauence B.07.00, DBFIND modes 1,4,21 and 24 are implemented but can
currently not be used with search items. They may be used with an
Eloquence index item.
-
Eloquence supports the TPI modes for database access.
Please refer to the TPI Support
documentation for additional DBFIND modes.
|
|
