PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English US
  • Properties specific to the description of full-text indexes
  • How to describe the data files by programming?
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Others
Stored procedures
FullTextIndex description (Type of variable)
In French: Description d'IndexFullText (Type de variable)
HFSQLHFSQL Client/ServerAvailable 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
iPhone/iPad This type of variable is now available for the iPhone and iPad applications.
New in version 17
iPhone/iPad This type of variable is now available for the iPhone and iPad applications.
iPhone/iPad This type of variable is now available for the iPhone and iPad applications.
Versions 18 and later
Universal Windows 10 App This type of variable is now available in Windows Store apps mode.
New in version 18
Universal Windows 10 App This type of variable is now available in Windows Store apps mode.
Universal Windows 10 App This type of variable is now available in Windows Store apps mode.
Versions 21 and later
Universal Windows 10 App This type of variable is now available in Universal Windows 10 App mode.
New in version 21
Universal Windows 10 App This type of variable is now available in Universal Windows 10 App mode.
Universal Windows 10 App 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:
NameType usedEffect
ManageHTMLBooleanConfigures the management mode of the HTML format in a full-text index.
ManageRTFBooleanConfigures the management mode of the RTF format in a full-text index.
MinimumLengthIntegerUsed 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 stringUsed to define the empty words not to index.
NameCharacter stringMandatory 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 constantUsed 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 constantMandatory property used to define the language in which the stemming must be performed.
ItemsCharacter stringUsed to define and find out the different items included in the full-text index.
AccentuationSensitiveBooleanUsed to define and find out whether the punctuation (comma, dot, ...) is taken into account in the searches performed on the item
CaseSensitiveBooleanUsed 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 stringUsed 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:
3. Describe (if necessary) the characteristics of links via the HFSQL properties.
4. Validate (if necessary) the description of each link (HDescribeLink.
Minimum required version
  • Version 14
This page is also available for…
Comments
Click [Add] to post a comment