HDescribeFullTextIndex (Function)

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

Management of databases

HFSQL functions

HDescribeFullTextIndex

Presentation

Example

How to describe a full-text index by programming?

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

HCreateMoveableReplica

HCreateSubscriberReplica

HDeactivateAutoFilter

HDescribeFullTextIndex

HErrorStatusModification

HFilterIncludedBetween

HMigrateLinkedCompositeKey

HRecreateSubscriberReplica

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

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 by 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 re-initialized. A new index description can be performed.

Versions 17 and later

This function is now available for the iPhone/iPad applications.

New in version 17

This function is now available for the iPhone/iPad applications.

Versions 18 and later

This function is now available in Windows Store apps mode.

New in version 18

This function is now available in Windows Store apps mode.

Versions 21 and later

This function is now available in Universal Windows 10 App mode.

New in version 21

This function is now available in Universal Windows 10 App mode.

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

Example

See additional examples

MyFullTextIndex is Description of FullTextIndex

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

HDescribeFullTextIndex(AFile, MyFullTextIndex)

Syntax

<Result> = HDescribeFullTextIndex(<File Name> , <Full-text index>)

<Result>: Boolean

True if the operation was performed,
False if a problem occurred. HErrorInfo is used to identify the error.

<File Name>: Character string (with or without quotes)

Name of HFSQL data file (described by HDescribeFile).

<Full-text index>: FullTextIndex Description variable

Name of FullTextIndex Description variable containing the description of full-text index.

Remarks

How to describe a full-text index by programming?

To describe a full-text index by programming, you must:

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

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

The following properties are available in read/write.


AccentuationSensitive	..AccentuationSensitive is used to configure the management mode of accented characters in the different searches performed on the item or on the full-text index (by HReadSeek, HReadSeekFirst and HReadSeekLast for example).
CaseSensitive	..CaseSensitive is used to configure the management mode of case (uppercase/lowercase characters) in the different searches performed on the item or on the full-text index (by HReadSeek, HReadSeekFirst and HReadSeekLast for example).
Items	..Items is used to configure the different items included in a full-text index.
ManageHTML	..ManageHTML is used to configure the HTML management mode in a full-text index.
ManageRTF	..ManageRTF is used to configure the management mode of RTF in a full-text index.
MinimumLength	..MinimumLength is used to configure the minimum length of the words to index.
Name	..Name is used to find out: 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 : wd240hf.dll