SearchFlags Enumeration

enum SearchFlags {
  dtsSearchFuzzy = 0x0001,
  dtsSearchPhonic = 0x0002,
  dtsSearchStemming = 0x0004,
  dtsSearchNatural = 0x0008,
  dtsSearchSynonyms = 0x0010,
  dtsSearchUserSynonyms = 0x0020,
  dtsSearchWordNetSynonyms = 0x0040,
  dtsSearchWordNetRelated = 0x0080,
  dtsSearchAllSynonyms = 0x00f0,
  dtsSearchWantHitsByWord = 0x0100,
  dtsWlbListFields = 0x0100,
  dtsSearchWantHitsByWord2 = 0x0400,
  dtsSearchWantHitsArray = 0x0800,
  dtsSearchDelayDocInfo = 0x1000,
  dtsSearchExternalSynonyms = 0x2000,
  dtsSearchWantHitDetails = 0x8000,
  dtsSearchAutoTermWeight = 0x10000,
  dtsSearchTypeAllWords = 0x20000,
  dtsSearchTypeAnyWords = 0x40000,
  dtsSearchSelectMostRecent = 0x080000,
  dtsSearchPositionalScoring = 0x100000,
  dtsSearchApplyLanguageAnalyzer = 0x200000
};

File

dtsearch.h

Members

Members	Description
dtsSearchFuzzy = 0x0001	Enable fuzzy searching for all words in the search request.
dtsSearchPhonic = 0x0002	Enable phonic searching for all words in the search request
dtsSearchStemming = 0x0004	Enable stemming for all words in the search request
dtsSearchNatural = 0x0008	Equivalent to dtsSearchTypeAnyWords \| dtsSearchAutoTermWeight \| dtsSearchPositionalScoring.
dtsSearchSynonyms = 0x0010	Enable synonym expansion. See Synonym search settings.
dtsSearchUserSynonyms = 0x0020	Enable synonym expansion using user-defined synonyms. See Synonym search settings.
dtsSearchWordNetSynonyms = 0x0040	Enable synonym expansion using WordNet related words. See Synonym search settings.
dtsSearchWordNetRelated = 0x0080	Enable synonym expansion using WordNet synonyms. See Synonym search settings.
dtsSearchAllSynonyms = 0x00f0	Combines all synonym flags
dtsSearchWantHitsByWord = 0x0100	Request a list of the words that were matched in each document. See dtsSearchWantHitsByWord in the Overviews section.
dtsWlbListFields = 0x0100	In dtsWordListBuilder, include field names in the output.
dtsSearchWantHitsByWord2 = 0x0400	Deprecated. Use dtsSearchWantHitDetails instead.
dtsSearchWantHitsArray = 0x0800	Adds word offsets of individual hits to the hits by word report. See dtsSearchWantHitsByWord in the Overviews section.
dtsSearchDelayDocInfo = 0x1000	Optimize search by waiting until document records are requested through a search results object before reading them from the index. See dtsSearchDelayDocInfo in the Overviews section.
dtsSearchExternalSynonyms = 0x2000	Enable synonym expansion using an external thesaurus. See Synonym search settings.
dtsSearchWantHitDetails = 0x8000	Request detailed information about the words that generated each hit associated with an item in search results. See dtsSearchWantHitDetails in the Overviews section.
dtsSearchAutoTermWeight = 0x10000	Apply the automatic term weighting to each term in the request. See Relevance in the Overviews section.
dtsSearchTypeAllWords = 0x20000	Find all of the words in the search request. See "All words" and "Any words" Searches in the Overviews section.
dtsSearchTypeAnyWords = 0x40000	Find any of the words in the search request. See "All words" and "Any words" Searches in the Overviews section.
dtsSearchSelectMostRecent = 0x080000	When selecting the documents to return (up to the MaxFilesToRetrieve limit in the SearchJob), select the most recent documents rather than the best-matching documents. Cannot be used with dtsSearchDelayDocInfo, because the document date for each document is needed.
dtsSearchPositionalScoring = 0x100000	Rank documents higher when hits are closer to the top of the document and when hits are located close to each other within a document. This improves relevancy ranking for "all words" and "any words" searches. See Relevance in the Overviews section.
dtsSearchApplyLanguageAnalyzer = 0x200000	Apply Language Analyzer to search request, if this application uses an external language analyzer (see Language Analyzer API)

Description

Used in the searchFlags member of dtsSearchJob to control advanced search features