HChangeKey (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

ExecuteQueryAsynchronous

ExecuteSQLQueryAsynchronous

HCreateMoveableReplica

HCreateSubscriberReplica

HDeactivateAutoFilter

HDescribeFullTextIndex

HErrorStatusModification

HExecuteQuery

HExecuteQueryAsynchronous

HExecuteSQLQuery

HExecuteSQLQueryAsynchronous

HFilterIncludedBetween

HMigrateLinkedCompositeKey

HRecreateSubscriberReplica

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

HChangeKey (Function)

In french: HChangeClé

Not available with this kind of connection

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 for example).

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

Versions 15 and later

This function is now available for Android applications.

New in version 15

This function is now available for Android applications.

Versions 17 and later

This function is now available for iPhone/iPad applications.

New in version 17

This function is now available for 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.

Remark: 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(<Data file> [, <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.

<Data file>: Character string (with or without quotes)

Name of data file, HFSQL view or query used.

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

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 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, performance issues may arise for large data files

The <Browse mode> parameter cannot be used.

Component: wd260hf.dll