HChangeKey (Function)

After the function execution, the rest of browse is performed from the current record, according to the new search item. HChangeKey can be used to start a file browse after a positioning on a record in direct access (with HRead for example).

Note: This function can be used on a HFSQL data file, query or view.

Versions 15 and later

This function is now available for the Android applications.

New in version 15

This function is now available for the Android applications.

Versions 17 and later

This function is now available for the iPhone/iPad applications.

New in version 17

This function is now available for the iPhone/iPad applications.

Versions 18 and later

This function is now available in Android Widget mode.

This function is now available in Windows Store apps mode.

New in version 18

This function is now available in Android Widget mode.

This function is now available in Windows Store apps mode.

This function is now available in Android Widget mode.

This function is now available in Windows Store apps mode.

Versions 21 and later

This function is now available in Universal Windows 10 App mode.

New in version 21

This function is now available in Universal Windows 10 App mode.

Note: From version 19, HFSQL is the new name of HyperFileSQL.

Example

See additional examples

// Change the search key
IF HChangeKey(CUSTOMER, NAME) = False THEN
Error("Select a customer in the table")
END

Syntax

<Result> = HChangeKey(<File Name> [,<Item Name>] [, <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.

<File Name>: Character string (with or without quotes)

Name of data file, HFSQL view or query used.

<Item Name>: Optional character string (with or without quotes)

Name of the new search item. If this name is not specified, HChangeKey handles the last key item specified on this file by the last function for HFSQL management (starting with the letter H).

<Browse Mode>: Optional Integer constant

Characteristic of the file browse on the new key:
hKeepFilter The 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.
The <Browse Mode> parameter cannot be used.

Component : wd240hf.dll