HDescribeFullTextIndex (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Help / WLanguage / Managing databases / HFSQL / HFSQL functions

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

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

HDescribeFullTextIndex (Function)

In french: HDécritIndexFullText

Available only with these kinds of connection

Describes a full-text index of data file created programmatically.

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:

Use the File Description, Item Description, Link description and FullTextIndex Description variables (if necessary).
Describe the characteristics of the data file, its fields, links and full-text indexes using HFSQL properties.
Define the description of items with HDescribeItem.
Define the description of full-text indexes with HDescribeFullTextIndex.
Define the description of the data file (HDescribeFile) and the links (HDescribeLink).

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

The following properties are available in read/write mode.


AccentSensitive	The 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).
CaseSensitive	The 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).
Items	The Items property is used to configure the different items of a full-text index.
ManageHTML	The property ManageHTML property is used to set the HTML management mode in a full-text index.
ManageRTF	The property ManageRTF property is used to set the RTF management mode in a full-text index.
MinimumLength	The MinimumLength property is used to configure the minimum length of the words to be indexed.
Name	The 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: wd300hf.dll