PC SOFT

ONLINE HELP
 WINDEV, WEBDEV AND WINDEV MOBILE
Add
Out
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
<Source>.CheckIndex (Function)
In french: <Source>.VérifieIndex
HFSQLHFSQL Client/ServerAvailable 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.
HFSQL Client/Server 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.
Example
// Check the index
let IndexResult = Customer.CheckIndex()
// 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> = <Source>.CheckIndex([<Key item> [, <Progress Bar>]])
<Result>: Integer
Can correspond to:
  • 0 if the check is correct.
  • 1 if the index is corrupted: a reindex operation is required (<Source>.Index)
  • 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.)
<Source>: Type corresponding to the specified source
Name of the data file used.
<Key item>: Optional character string
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 control name or window name
  • Name of window where the progress bar will be displayed,
  • Name of the Progress Bar control to use.
WEBDEV - Server code 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.
Remark: The H.Comment variable is not filled if the index file is entirely corrupted.
Component: wd280hf.dll
See also
Minimum version required
  • Version 25
This page is also available for…
Comments
Click [Add] to post a comment