dtsWordListBuilder Class

dtsWordListBuilder provides a way to list words, field names, or field values in an index.

File

File: dts_wlb.h

getWord Method

Syntax

C++

class dtsWordListBuilder;

Group

Classes

Members

Methods

Method	Description
closeIndex	Close the currently-open index
dtsWordListBuilder	Create a dtsWordListBuilder
getCount	Returns the number of items in the list
getField	Get the name of the field a word occurs in.
getFlags	Returns WordListBuilderFlags with the options currently in effect.
getLastError	Returns zero if the last operation succeeded, or an ErrorCodes value if the last operation failed
getWord(long, char *, long, long&)	Get the text of one word in the list
getWord(long, char *, long, long&, long&)	Get the text of one word in the list
listFieldValues	List all values of an enumerable field.
listFields	List all fields in the index
listMatchingWords	List all words matching an expression
listWords	List aRange words around cursorWord in the index.
openIndex	Open an index
setFlags	Set option settings for the WordListBuilder using WordListBuilderFlags
setSearchFilter	Use a search filter (dtsSearchFilter) to limit the items that can be returned from listMatchingWords or listFieldValues.
sort	Sort words in the WordListBuilder

Methods

Method	Description
closeIndex	Close the currently-open index
dtsWordListBuilder	Create a dtsWordListBuilder
getCount	Returns the number of items in the list
getField	Get the name of the field a word occurs in.
getFlags	Returns WordListBuilderFlags with the options currently in effect.
getLastError	Returns zero if the last operation succeeded, or an ErrorCodes value if the last operation failed
getWord(long, char *, long, long&)	Get the text of one word in the list
getWord(long, char *, long, long&, long&)	Get the text of one word in the list
listFieldValues	List all values of an enumerable field.
listFields	List all fields in the index
listMatchingWords	List all words matching an expression
listWords	List aRange words around cursorWord in the index.
openIndex	Open an index
setFlags	Set option settings for the WordListBuilder using WordListBuilderFlags
setSearchFilter	Use a search filter (dtsSearchFilter) to limit the items that can be returned from listMatchingWords or listFieldValues.
sort	Sort words in the WordListBuilder

Remarks

dtsWordListBuilder is intended for quick enumeration of words, field names, or field values in an index.

Two ways of listing words are provided, one for listing the words before and after a word in an index, and one for listing words that match a search term in an index.

The scrolling list of indexed words that updates as a user enters a search request in dtSearch Desktop is implemented using WordListBuilder's ListWords method. The "Browse Words" dialog box in dtSearch Desktop that lists words matching an expression is implemented using the ListMatchingWords method.

Listing of field values only lists values of fields that were designated as EnumerableFields when the documents were indexed.

For speed, WordListBuilder does not actually enumerate the references for each word and instead relies on counts incrementally stored in the index. Therefore, the reported counts may include artifacts of the indexing process such as reindexed or removed documents, so the counts may be higher than the actual count of references in the index. Compressing an index will remove these extra references.

Class Hierarchy

dtsWordListBuilder