dtSearch Text Retrieval Engine Programmer's Reference
dtsWordListBuilder Class

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

File: dts_wlb.h

class dtsWordListBuilder;

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.