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. HChangeKey
can be used to start browsing a data file, after being positioned on a record with direct access (with HRead
Remark: This function can be used on an HFSQL data file, query or view.
// Change the search key
IF HChangeKey(Customer, Name) = False THEN
Error("Select a customer in the table")
<Result> = HChangeKey(<Data file> [, <Item> [, <Browse mode>]])
- 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.
<Data file>: Character string
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, HChangeKey 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:
|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 issues may arise for large data files
The <Browse mode> parameter cannot be used.