Help / WLanguage / Managing databases / HFSQL / HFSQL functions
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WindowsLinuxPHPWEBDEV - Browser code
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Stored procedures
Changes the browse item. The current record is not modified.
After the function is executed, the browse is performed from the current record, according to the new browse item. <Source>.ChangeKey can be used to start browsing a data file, after being positioned on a record with direct access (with <Source>.Read for example).
Remark: This function can be used on an HFSQL data file, query or view.
// Change the search key
IF Customer.ChangeKey(Name) = False THEN
Error("Select a customer in the table")
<Result> = <Source>.ChangeKey([<Item> [, <Browse mode>]])
<Result>: Boolean
  • True if the search key was modified,
  • False an error occurred (no read function has preceded the change of key...): the search key is not modified. HError is used to identify the error.
<Source>: Type corresponding to the specified source
Name of data file, HFSQL view or query used.
<Item>: Optional character string
Name of the new browse item.
If this name is not specified, <Source>.ChangeKey will use the last browse item specified by the last HFSQL management function (function starting with "H").
<Browse mode>: Optional Integer constant
Characteristics of the data file browse on the new key:
hKeepFilterThe filter set by <Source>.Filter will be taken into account, even if the search key is not optimized for the filter.
Reminder: <Source>.Filter returns the search key optimized for the filter.
Caution: In this case, performance issues may arise for large data files

Hyper File 5.5 The <Browse mode> parameter cannot be used.
Component: wd280hf.dll
Minimum version required
  • Version 25
This page is also available for…
Click [Add] to post a comment

Last update: 06/21/2023

Send a report | Local help