- Generic search/Exact-match search
- Performing a search on a composite key
- Search on an array item
- Search and filter
- Locks
HSeekFirst (Function) In french: HRecherchePremier
 Not available with this kind of connection
Positions on the first file record whose value for a specific item is greater than or equal to a sought value. The record is not read. The number of the current record is modified only when it is returned by HRecNum. For the functions that handle the current record number ( HDelete, HRead, HModify, etc.), the value of this number is not updated: you must use HRecNum. Example not to do:
// Deletes a record not corresponding to the expected one
HSeekFirst(Customer, CustomerID, 25)
HDelete(Customer)
but:
// Delete the sought record
HSeekFirst(Customer, CustomerID, 25)
HDelete(Customer, HRecNum())
Caution: The record loaded in memory is not modified. The HFSQL variables (Customer.Name for example, which means the Name item of Customer file) are not updated. In most cases, HSeekFirst sets the position in the data file to loop through the records that match a condition. Several cases may occur after the call to HSeekFirst: - a record corresponding to the condition was found, locked (if necessary) and loaded in memory: HFound returns True.
- the data file is empty or there is no record corresponding to the condition: HOut returns True.
- the function tries to lock a record that is already locked in read-only: HErrorLock returns True and HOut returns True.
// Find the first record for which
// the Customer name is Moore
HSeekFirst(Customer, Name, "Moore")
// The record is not read.
// Finds all the customers with a specific last and first names.
// The search is performed according to a composite key.
bufSoughtVal is Buffer = HBuildKeyValue(Customer, LastName_FirstName, sLastName, sFirstName)
HSeekFirst(Customer, LastName_FirstName, bufSoughtVal, hLockWrite)
WHILE HFound(Customer) = True
HDelete(Customer, HRecNum())
HNext(Customer, LastName_FirstName, hLockWrite)
END
Syntax
<Result> = HSeekFirst(<Data file> , <Key item> , <Sought value> [, <Options>])
<Result>: Boolean - True if the position was set on the record (corresponds to the value of HFound).
- False if a problem occurs. This problem can be caused by:
- a positioning problem (empty data file, etc.): HFound returns False and HError returns 0.
- an error: HError returns an integer other than 0. HErrorInfo returns more details.
<Data file>: Character string Name of the HFSQL data file used. <Key item>: Character string Name of key item on which the search will be performed. <Sought value>: Type corresponding to the value Value of the sought item. <Options>: Optional constant (or combination of constants) Configures:- the lock mode applied to the sought record
- the type of search performed.
| | | hGeneric | Generic search (see the Notes)
An exact-match search is performed by default (constant not specified). | | hKeepFilter | The filter set by HFilter will be taken into account, even if the search key is not optimized for the filter. Reminder: HFilter returns the search key optimized for the filter.
Caution: in this case, performance problems may occur on large files.
By default, the iteration performed after HSeekFirst ignores the filter. | | hLimitParsing | The iteration will stop when the last searched value is found. The current record will correspond to this last record found.
HFound will return False and HOut will return True.
This constant is used to optimize the search speed in Client/Server mode. | | hLockNo | No lock: the record can be read or modified by another application during the reading. | | hLockReadWrite | Lock in read/write: the record currently read cannot be read or modified by another application.
| | hLockWrite | Lock in write mode: the record currently read can be read by another application but it cannot be modified by another application. |
Remarks Generic search/Exact-match search - Generic search (mainly on the Character String items): Finds all the records starting with the specified value.
For example: When a generic search is performed on "Smith" (for the NAME item), all records whose Name item starts with "Smith" will match the search. Therefore, the record containing "Smither" will correspond to the search (HFound returns True). - Exact-match search: Finds all the records that exactly correspond to the specified value.
For example: When an exact-match search is performed on "Smith" (for the NAME item), HFound returns True for the records whose item exactly matches "Smith". - Examples of searches performed on CUSTOMER file sorted by name:
 | | | | | | | Sought value | Options | HSeekFirst sets the position on the record | HFound returns | HOut returns | Explanations | | Durand | | 1 | True | False | Durand exists.
The end of data file was not reached yet. | | Dupuis | | 1 | False | False | Dupuis does not exist. Positioning on the first greater value (Durand).
The end of data file was not reached yet. | | Moor | hGeneric | 8 | True | False | Moor does not exist but the search is a generic search and Moore is found (among others).
The end of data file was not reached yet. | | Moor | | The record was not found (no move) | False | False | Moor does not exist.
The end of data file was not reached yet. | | Norbert | | The record was not found (no move) | False | True | Norbert does not exist.
Position on the first greater value (this value does not exist): The end of data file has been reached. |
Search on an array item The search is performed on the first array element (element with index 1). To perform a search on the other array elements, use the filters or queries. Search and filter If a filter is enabled ( HFilter), the search takes the filter into account.
This page is also available for…
|
|
|