PC SOFT

ONLINE HELP
 WINDEV, WEBDEV AND WINDEV MOBILE
  • How to describe a full-text index through programming?
  • List of HFSQL properties used to describe a full-text index through programming
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
HDescribeFullTextIndex (Function)
In french: HDécritIndexFullText
HFSQLHFSQL Client/ServerAvailable only with these kinds of connection
Describes a full-text index of data file created through programming.
After the call to HDescribeFullTextIndex:
  • The item can be handled like any analysis item.
  • The item description cannot be modified anymore.
  • The description variable of item is reinitialized. A new index description can be performed.
Example
MyFullTextIndex is Description of FullTextIndex
 
// Describe the full-text index
MyFullTextIndex.MinimumLength = 4
MyFullTextIndex.Name = "MyFullTextIndex"
MyFullTextIndex.Items = "LASTNAME+FIRSTNAME"
MyFullTextIndex.AccentSensitive = True
MyFullTextIndex.CaseSensitive = False
 
HDescribeFullTextIndex(AFile, MyFullTextIndex)
Syntax
<Result> = HDescribeFullTextIndex(<Data file> , <Full-text index>)
<Result>: Boolean
  • True if the operation was performed,
  • False if a problem occurs. HErrorInfo is used to identify the error.
<Data file>: Character string
Name of HFSQL data file (described by HDescribeFile).
<Full-text index>: FullTextIndex Description variable
Name of the FullTextIndex Description variable containing the description of the full-text index.
Remarks

How to describe a full-text index through programming?

To describe a full-text index through programming, you must:
  1. Use the File Description, Item Description, Link description and FullTextIndex Description variables (if necessary).
  2. Describe the characteristics of data file, items, links and full-text indexes via the HFSQL properties.
  3. Define the description of items with HDescribeItem.
  4. Define the description of full-text indexes with HDescribeFullTextIndex.
  5. Define the description of the data file (HDescribeFile) and the links (HDescribeLink).

List of HFSQL properties used to describe a full-text index through programming

The following properties are available in read/write mode.
AccentSensitiveThe AccentSensitive property is used to determine if accented characters are taken into account in the different searches performed on the item (with HReadSeek, HReadSeekFirst and HReadSeekLast, for example).
CaseSensitiveThe CaseSensitive property is used to determine if the different searches performed on the item distinguish between uppercase and lowercase characters (with HReadSeek, HReadSeekFirst and HReadSeekLast, for example).
ItemsThe Items property is used to configure the different items of a full-text index.
ManageHTMLManageHTML is used to configure the management mode of the HTML format in a full-text index.
ManageRTFManageRTF is used to configure the management mode of the RTF format in a full-text index.
MinimumLengthThe MinimumLength property is used to configure the minimum length of the words to be indexed.
NameThe Name property is used to get:
  • the name of the font associated with a Font variable.
  • the name of a control, report or report block.
  • the name of a control, group of controls or window.
  • the name of a control, group of controls or page.
Component: wd280hf.dll
See also
Minimum version required
  • Version 14
This page is also available for…
Comments
Click [Add] to post a comment