ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

This content has been translated automatically.  Click here  to view the French version.
Help / WLanguage / Managing databases / HFSQL / HFSQL functions
WINDEV
WindowsLinuxJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac Catalyst
Others
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 a data file, a query or an HFSQL view..
Example
// Change the search key
IF Customer.ChangeKey(Name) = False THEN
	Error("Select a customer in the table")
END
Syntax
<Result> = <Source>.ChangeKey([<Item> [, <Browse mode>]])
<Result>: Boolean
  • True if the search key was modified,
  • False in the event of a problem (e.g. no read function preceded the key change): the route 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, the function <Source>.ChangeKey function will use the last browse item specified on this data file by the last HFSQL management function (function starting with the letter 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 function <Source>.Filter returns the optimized route key for the filter.
Caution: In this case, on large data files, performance problems may arise.

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

Last update: 12/06/2024

Send a report | Local help