E@DBKFNDBEGRNG
Name
The E@DBKFNDBEGRNG call has the following format:
DN@<Logical>(E@E@DBKFNDBEGRNG)
where <Logical> identifies the database file and index to use to perform the E@DBKFNDBEGRNG call.
Description
When you need to process a range of data without interruption, E@DBKFNDBEGRNG retrieves the keys of first database record in the range.
Using the API in a Program
The database routines perform an equal condition on all D@ fields that have an assigned value—that is, all columns up to, and including, the field moved to the E@DBBEGRNG.
E@DBKFNDBEGRNG must be paired with E@DBKFNDNXTRNG.
You must populate the delimiting D@ fields and E@DBBEGRNG before using E@DBKFNDBEGRNG.
Input Values
| Field | Description |
|---|---|
| <Logical> | <Logical> in the E@ statement identifies the database file and index to use to perform the call. |
| Record retrieval variables (also known as D@ and D# fields) | Fill in only the D@ fields that define the appropriate range; leave empty those D@ fields that do not define the range. |
| E@DBBEGRNG | Move a number into E@DBBEGRNG in order to tell the interface which key is the last significant one defining the range. This number is equivalent to the position of the field in the index. |
Return Values
| Field | Description |
|---|---|
| D<prefix>@NOTFOUND |
Each routine sets the logical value <FileName>-NOTFOUND or <FileName>-FOUND based on the outcome of the read process. The Find routines set D<prefix>@NOTFOUND to FALSE if a record is found, TRUE if a record is not found, or E@KEY@FOUND if the keys are found. |
Programming Example
For an example of programming, see E@DBFINDBEGRNG.