WordListBuilder::ListFieldValues Method

List all field values in the index that match an expression

public long ListFieldValues(ref String Field, ref String toMatch, long nLimit);

Visual Basic

Public Function ListFieldValues(ByRef Field As String, ByRef toMatch As String, nLimit As long) As long

Parameters

Parameters	Description
toMatch	The expression to match
nLimit	Maximum number of words to find
field	The field to enumerate (the field must have been designated as an EnumerableField when the index was built)

Returns

Number of words found.

Remarks

A SearchFilter can be used with ListFieldValues to limit the results to values in a set of documents. Use SetFilter to attach a SearchFilter to the WordListBuilder.

When a SearchFilter is used, all counts returned by WordListBuilder are document counts. For example, if a word occurs 20 times in 7 documents, the count returned will be 7 for both GetNthWordCount and GetNthWordDocCount.