PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English US

  • 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
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Others
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 when it is returned by HRecNum. For the functions that handle the current record number (HDelete, HRead, HModify, ...), the value of this number is not updated: you must use HRecNum(). For example: not to do:
HDelete(Customer)
but
HDelete(Customer, HRecNum())
The reading is performed from the lowest value to the greatest value of search item (see the notes 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 is used to position in the data file in order to perform a browse loop among the records corresponding to 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
Notes:
  • By default, HSeekFirst and HSeekLast are used to perform an exact-match search.
  • By default, HSeek is used to perform a generic search.
Versions 15 and later
Android This function is now available for the Android applications.
New in version 15
Android This function is now available for the Android applications.
Android This function is now available for the Android applications.
Versions 17 and later
iPhone/iPad This function is now available for the iPhone/iPad applications.
New in version 17
iPhone/iPad This function is now available for the iPhone/iPad applications.
iPhone/iPad This function is now available for the iPhone/iPad applications.
Versions 18 and later
Android Widget This function is now available in Android Widget mode.
Universal Windows 10 App This function is now available in Windows Store apps mode.
New in version 18
Android Widget This function is now available in Android Widget mode.
Universal Windows 10 App This function is now available in Windows Store apps mode.
Android Widget This function is now available in Android Widget mode.
Universal Windows 10 App This function is now available in Windows Store apps mode.
Note: From version 19, HFSQL is the new name of HyperFileSQL.
Versions 21 and later
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
New in version 21
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
Universal Windows 10 App This function is now available in Universal Windows 10 App mode.
Example
// 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, Complete("MOORE", 30))
Syntax
<Result> = HSeek(<File Name> , <Name of Key Item> , <Sought Value> [, <Options>])
<Result>: Boolean
  • True if the positioning was performed,
  • False if an error occurred (lock, ...): the record is not read. This problem can be caused by:
    • a positioning problem (empty data file, ...): HFound returns False and HError returns 0.
    • an error: HError returns an integer other than 0. HErrorInfo returns more details.
<File Name>: Character string (with or without quotes)
Name of HFSQL data file used.
<Name of Key Item>: Character string (with or without quotes)
Name of key item on which the search will be performed.
<Sought Value>: Type corresponding to the value
Value of sought item.
<Options>: Optional constant (or combination of constants)
Configures:
  • the lock mode applied to the sought record. By default, the lock performed corresponds to the current lock mode, defined by HStartLock.
  • the type of browse
  • the type of search performed.
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.
hLockNoNo lock (even if HStartLock was called): the record can be read or modified by another application during the reading.
hIdenticalExact-match search (see the Notes).
A generic search is performed by default (parameter not specified).
hLimitParsingThe browse will stop as soon as the last sought 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.
hKeepFilterThe filter implemented 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, poor performance may occur on huge data files.
Hyper File 5.5 This variable cannot be used.
Windows Mobile The management of locks is performed on the HFSQL Client/Server data files and on the data files handled by native access. A HFSQL Mobile record cannot be locked. Indeed, the operating system of Pocket PC does not allow you to lock records.
Java Access by JDBC: This parameter is ignored.
OLE DBNative Accesses The lock options will have no effect if the locks are not supported by the OLE DB provider or by the Native Access.
Hyper File 5.5 The lock options are ignored. Use the locking read functions (HReadFirstLock) kept for backward compatibility.
Remarks

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 Complete.

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 Second Element of Composite Key>, ...])
Example:
// 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 whose subscript is 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.
Components
WINDEVWEBDEV - Server codeReports and Queries wd230hf.dll
Windows Mobile wp230hf.dll
Java wd230java.jar
Linux wd230hf.so
Android wd230android.jar
Minimum required version
  • Version 9
This page is also available for…
Comments
Click [Add] to post a comment