HListSynonym (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

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

HListSynonym (Function)

In french: HListeSynonyme

Returns the list of synonyms used by a full-text index.

Example

// Retrieves all the synonym words
let sAllSynonyms = HListSynonym(DataFile, MyFullTextIndex)
// For each group of synonym words
FOR EACH STRING sSynonymList OF sAllSynonyms SEPARATED BY CR
	let sString = "The following words are synonyms: " 
	// Extracts each synonym
	FOR EACH STRING sSynonym OF sSynonymList SEPARATED BY TAB
		// Adds the word to the string
		sString += sSynonym + " "
	END
	Trace(sString)
END

Syntax

<Result> = HListSynonym(<Data file> , <Full-text index> [, <Path of the WDD file> [, <Password of the WDD file>]])

<Result>: Character string

List of synonyms defined for the specified full-text index in the specified data file. This list has the following format:
<Word 1> + TAB + <Synonym 1A> + TAB + <Synonym 1B> + CR + ...
<Word 2> + TAB + <Synonym 2> + ... + CR + ...
<Word N> + TAB + <Synonym N>
In this list:
The synonyms are separated by a tabulation (TAB).
The different groups of synonyms are separated by a Carriage Return (CR).
Remarks:
The words can be written in uppercase if the full-text index is not sensitive to the case or without accented characters if the full-text index is not sensitive to the accented characters.
The words whose length is less than the minimum length specified for the full-text index may not appear in this list.

<Data file>: Character string

Name of the data file containing the full-text index.

<Full-text index>: Character string

Name of full-text index used.

<Path of the WDD file>: Optional character string

Full path of analysis (.WDD file) where the data file is described. If this parameter is not specified or is an empty string (""), the data file is searched for in the current analysis.

<Password of the WDD file>: Optional string or Secret string

Password defined for the analysis. If no password is defined, this parameter must be an empty string ("").
New in version 2025
Secret strings: If you use the secret string vault, the type of secret string used for this parameter must be "ANSI or Unicode string".
To learn more about secret strings and how to use the vault, see Secret string vault.

Component: wd300hf.dll