FullTextIndex description (Type of variable)

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Properties specific to the description of full-text indexes
How to describe the data files by programming?

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

FullTextIndex description (Type of variable)

In french: Description d'IndexFullText (Type de variable)

Available only with these kinds of connection

A FullTextIndex Description variable is used to describe one or more full-text indexes by programming. The characteristics of these indexes can be defined by several WLanguage properties

To add the description of this index into the description of a data file, use HDescribeFullTextIndex. The "FullTextIndex Description" variable is reinitialized and it can be used to describe another full-text index by programming.

Versions 17 and later

This type of variable is now available for the iPhone and iPad applications.

New in version 17

This type of variable is now available for the iPhone and iPad applications.

Versions 18 and later

This type of variable is now available in Windows Store apps mode.

New in version 18

This type of variable is now available in Windows Store apps mode.

Versions 21 and later

This type of variable is now available in Universal Windows 10 App mode.

New in version 21

This type of variable is now available in Universal Windows 10 App mode.

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

Example

AFile is File Description
AnItem is Item Description
MyFullTextIndex is FullTextIndex Description
CUSTOMER is Data Source

// Describe the "CUSTOMER" file
AFile..Name = "CUSTOMER"
AFile..Type = hFileNormal
AFile..FicCryptMethod = hCryptStandard

// Describe the "LASTNAME" item
AnItem..Name = "LASTNAME"
AnItem..Type = hItemText
AnItem..Size = 40
AnItem..KeyType = hDuplicatesKey
HDescribeItem(AFile, AnItem)

// Describe the "FIRSTNAME" item
AnItem..Name = "FIRSTNAME"
AnItem..Type = hItemText
AnItem..Size = 40
HDescribeItem(AFile, AnItem)

// Describe the full-text index
MyFullTextIndex..MinimumLength = 4
MyFullTextIndex..Name = "MyFullTextIndex"
MyFullTextIndex..Items = "LASTNAME+FIRSTNAME"
MyFullTextIndex..AccentuationSensitive = True
MyFullTextIndex..CaseSensitive = False
HDescribeFullTextIndex(AFile, MyFullTextIndex)

// Validates the file description
HDescribeFile(AFile)
// Create the Customer file (recognized because declared as data source)
HCreation(CUSTOMER)
// Create a record
CUSTOMER.LASTNAME = "Doe"
CUSTOMER.FIRSTNAME = "Andrew"
HAdd(CUSTOMER)
// Create a record
CUSTOMER.LASTNAME = "Doe"
CUSTOMER.FIRSTNAME = "Vince"
HAdd(CUSTOMER)

Syntax

Declaring one or more FullTextIndex descriptions Hide the details

<Variable Name> is FullTextIndex description
<Variable Name 1>, <Variable Name 2> are FullTextIndex descriptions

<Variable Name>:

Name of the "hFullTextIndex Description" variable to declare.
Note: The a and an keywords are optional: they provide better readability.

Describing a "FullTextIndex Description" variable Hide the details

To describe a "FullTextIndex Description" variable:
Use the WLanguage properties specific to the descriptions of full-text indexes. See remarks for more details.

To validate the description of a "FullTextIndex Description" variable:
Use HDescribeFullTextIndex.

Remarks

Properties specific to the description of full-text indexes

The properties specific to the description of full-text indexes are presented in the table below:

Name	Type used	Effect

ManageHTML	Boolean	Configures the management mode of the HTML format in a full-text index.
ManageRTF	Boolean	Configures the management mode of the RTF format in a full-text index.
MinimumLength	Integer	Used to define and find out the minimum length of the words to index.
Versions 20 and later StopWord New in version 20 StopWord StopWord	Character string	Used to define the empty words not to index.
Name	Character string	Mandatory property used to define and find out the name of the full-text index item.
Versions 20 and later Option New in version 20 Option Option	Integer constant	Used to define specific options on the full-text index item. This property can correspond to: the hftPunctuationUnicode constant to take into account the specific features of the Unicode punctuation. the hftPunctuationSimple constant not to take into account the specific features of the Unicode punctuation.
Versions 20 and later Stemming New in version 20 Stemming Stemming	Integer constant	Mandatory property used to define the language in which the stemming must be performed.
Items	Character string	Used to define and find out the different items included in the full-text index.
AccentuationSensitive	Boolean	Used to define and find out whether the punctuation (comma, dot, ...) is taken into account in the searches performed on the item
CaseSensitive	Boolean	Used to define and find out whether the case (uppercase/lowercase characters) is taken into account in the searches performed on the item.
Versions 20 and later Synonym New in version 20 Synonym Synonym	Character string	Used to define the synonyms taken into account during the indexing.

How to describe the data files by programming?

To describe the data files by programming, you must:

1. Declare the "File description", "Item description", "FullTextIndex Description" and "Link description" variables (if necessary).

2. For each data file:

Describe the characteristics of the data file via the HFSQL properties.
Describe the characteristics of the items via the HFSQL properties.
Validate the description of each item (HDescribeItem).
Describe (if necessary) the characteristics of full-text indexes via the HFSQL properties.
Validate the description of each full-text index (HDescribeFullTextIndex).
Validate the description of the data file (HDescribeFile).

3. Describe (if necessary) the characteristics of links via the HFSQL properties.

4. Validate (if necessary) the description of each link (HDescribeLink.