HCheckIndex (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

Help

WLanguage

Management of databases

HCreateMoveableReplica

HCreateSubscriberReplica

HDeactivateAutoFilter

HDescribeFullTextIndex

HErrorStatusModification

HFilterIncludedBetween

HMigrateLinkedCompositeKey

HRecreateSubscriberReplica

Corrupted index

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

HCheckIndex (Function)

In french: HVérifieIndex

Available only with these kinds of connection

Checks whether the data found in the index file (.NDX file) properly refers the data found in the data file (.FIC file). This function applies to the HFSQL data files (Classic or Client/Server) only.

The HFSQL Client/Server data file is automatically locked in write mode during the check.

Reminder: An index is corrupted when one of the referenced records is not the expected one. In this case, the data file must be re-indexed.

Versions 18 and later

This function is now available in Windows Store apps mode.

New in version 18

This function is now available in Windows Store apps mode.

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

Versions 19 and later

This function is now available for the Android applications that use data files in HFSQL format.

This function is now available in Android Widget mode.

This function is now available for Java applications.

New in version 19

This function is now available for the Android applications that use data files in HFSQL format.

This function is now available in Android Widget mode.

This function is now available for Java applications.

This function is now available for the Android applications that use data files in HFSQL format.

This function is now available in Android Widget mode.

This function is now available for Java applications.

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.

Versions 24 and later

This function is now available for iPhone/iPad applications.

New in version 24

This function is now available for iPhone/iPad applications.

Example

// Check the index
let IndexResult = HCheckIndex(CUSTOMER)
// Manage the result
SWITCH IndexResult
CASE 0
Info ("The index is correct")
CASE 1
Info("The file must be optimized.")
CASE 2
Info("HFSQL error" + HError() + " during the test")
END

Syntax

<Result> = HCheckIndex([<File name> [, <Key name>] [, <Progress Bar>]])

<Result>: Integer

Can correspond to:
0 if the check is correct.
1 if the index is corrupted: a reindex operation is required (HIndex)
2 if an HFSQL error occurred: the data file cannot be accessed, etc.
3 if the function is not supported by this type of data file (xBase, AS400, etc.)

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

Name of data file used. If this name is not specified, HCheckIndex handles the last data file used by the last function for HFSQL management (starting with the letter H).

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

Name of the key item to check. If this parameter is not specified, all the keys of the data file are checked.

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

Name of window where the progress bar will be displayed,
Name of the Progress Bar control to use.
This parameter is ignored.

Remarks

Corrupted index

When the function detects a problem in the index file, the H.Comment variable contains:

<Name of affected key> + TAB + <Record number causing problem> + CR +
<Name of affected key 2> + TAB + <Record number causing problem 2> ...

<Record number causing problem> is equal to -1 if no record was defined.

Note: The H.Comment variable is not filled if the index file is entirely corrupted.

Component : wd240hf.dll