This content has been translated automatically.  Click here  to view the French version.
Help / WLanguage / Managing databases / HFSQL / HFSQL functions
  • Generic search/Exact-match search
  • Space characters at the end of item
  • Performing a search on a composite key
  • Search on an array item
  • Search and filter
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WindowsLinuxPHPWEBDEV - Browser code
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Stored procedures
HSeek (Function)
In french: HRecherche
ODBCNot available with this kind of connection
Positions on the first record of the data file whose value for a specific item is greater than or equal to a sought value (generic search by default). The record is not read. To read the record, use HReadSeek.

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(). For example: not to do:
HDelete(Customer, HRecNum())
Values in the browse item are read in ascending order (see Remarks for more details).
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, HSeek sets the position in the data file to loop through the records that match a condition. HNext is used to position on the next record corresponding to the condition.
Several cases may occur after the call to HSeek:
  • a record corresponding to the condition was found: HFound returns True
  • the data file is empty or there is no record corresponding to the condition: HOut returns True
  • By default, HSeekFirst and HSeekLast are used to perform an exact-match search.
  • By default, HSeek performs a generic search.
// Generic search for the first record for which
// the zip code starts with "75"
HSeek(Customer, ZC, "75")
// Exact-match search for the first record
// for which the Customer name is Moore
// Mode 7: Text item ending with Charact(0)
HSeek(Customer, Name, "Moore" + Charact(0))
// Mode 5.5: Text item filled by space characters
HSeek(Customer, Name, Complète("Moore", 30))
<Result> = HSeek(<Data file> , <Key item> , <Sought value> [, <Options>])
<Result>: Boolean
  • True if the position was set,
  • False if an error occurred (lock, ...): the record is not read. 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)
  • the lock mode applied to the sought record.
  • the type of iteration
  • the type of search performed.
hIdenticalExact-match search (see the Notes).
A generic search is performed by default (parameter not specified).
hKeepFilterThe 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 issues may arise for large files.
Hyper File 5.5 This variable cannot be used.
hLimitParsingThe iteration will stop when the last searched value is found. The current record will correspond to the record found. In this case, HFound returns False and HOut returns True.
This constant is used to optimize the speed in Client/Server mode.
hLockNoNo lock: the record can be read or modified by another application during the reading.
hLockReadWriteLock in read/write: the record currently read cannot be read or modified by another application.
OLE DB Lock in write-only. Operating mode equivalent to the hLockWrite constant.
hLockWriteLock in write mode: the record currently read can be read by another application but it cannot be modified by another application.
Java Access by JDBC: This parameter is ignored.
OLE DBNative Connectors (Native Accesses) The lock options will have no effect if the locks are not supported by the OLE DB provider or by the Native Connector.
Hyper File 5.5 The lock options are ignored. Use locking read functions (HReadFirstLock) kept for backward compatibility.

Generic search/Exact-match search

A generic search or an exact-match search will be performed according to <Sought value>.
  • For a generic search: performs a search on all the records that starts by the specified value
    To perform a generic search, the requested value must be specified in <Sought value>.
  • For an exact-match search: performs a search of all the records that exactly match the specified value.
    To perform an exact-match search, the size of the search argument must be exactly the same as the size of the key. The search argument must be filled with "space" characters for the text keys. To do so, use the Complete function.

Space characters at the end of item

By default, when reading a record, the space characters found at the end of the text items are not deleted in the file variables.
In order for the space characters to be deleted, use WithSpace.

Performing a search on a composite key

Several methods can be used to perform a search on a composite key:
Using a list of values
The following syntax is used to perform a search on a composite key:
HSeek(<File name>, <Name of composite key>, ...
[<Search value of first element of composite key>,
<Search value of first element of composite key>, ...])
// Find the record
HSeek(Customer, LastName_FirstName, ["MOORE","Vince"])
Hyper File 5.5 To perform generic searches on a composite key, all the components of composite key must be Text components. Otherwise, an exact-match search is performed.

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), this filter is taken into account during the search.
Component: wd280hf.dll
Minimum version required
  • Version 9
This page is also available for…
Click [Add] to post a comment

Last update: 07/16/2022

Send a report | Local help