FindBestWordMatches(MaxNoOfMatches As Integer) As Integer

DocContent object

Example

Description

This method iterates through the ValueStrings of all of the DocWords in the DocContent object and tries to match all available search words against them. It finds the MaxNoOfMatches best matches and saves them for access by GetFirstWordMatch and GetNextWordMatch.

The matches are sorted according to confidence. This means that GetFirstWordMatch returns the best-matched object, and subsequent calls to GetNextWordMatch return objects with decreasing confidence.

The search criteria are set by a call to SetWordSearchOptions. (The default search criteria are listed in that help topic.)

The FindBestWordMatches method must be preceded by one or several calls to AddSearchWord. After FindBestWordMatches is called, the search words are deleted in order to permit a new search with new search words.

A "match" does not have to be a perfect match.

Syntax

[ReturnValue =] Object.FindBestWordMatches( MaxNoOfMatches )

Part

Data type

Description

Object

DocContent

 

MaxNoOfMatches

Integer

Maximum number of matching words to be saved. Must be greater than 0.

Return value

Data type: Integer

Description: Returns 0 on success.

Remarks

The DocContent object