ISearchQueryHelper::put_QueryTermExpansion method (searchapi.h)

Article
02/22/2024

Sets a value that specifies how query terms are to be expanded.

Syntax

HRESULT put_QueryTermExpansion(
  [in] SEARCH_TERM_EXPANSION expandTerms
);

Parameters

[in] expandTerms

Type: SEARCH_TERM_EXPANSION

Value from the SEARCH_TERM_EXPANSION enumeration that specifies the search term expansion. If not set, the default value is SEARCH_TERM_PREFIX_ALL.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

The ISearchQueryHelper::put_QueryTermExpansion method allows for expansion of some query terms with wildcard characters, similar to regular expression expansion.

While the SEARCH_TERM_EXPANSION enumerated type lets you specify stem expansion, Windows Search does not currently support its use with the ISearchQueryHelper interface.

Checkout the DSearch code sample to see how to create a class for a static console application to query Windows Search using the Microsoft.Search.Interop assembly for ISearchQueryHelper.

Requirements

Requirement	Value
Minimum supported client	Windows XP with SP2, Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2003 with SP1 [desktop apps only]
Target Platform	Windows
Header	searchapi.h
Redistributable	Windows Desktop Search (WDS) 3.0