ISearchQueryHelper::get_QuerySyntax method (searchapi.h)

Article
02/22/2024

Gets the syntax of the query.

Syntax

HRESULT get_QuerySyntax(
  [out, retval] SEARCH_QUERY_SYNTAX *pQuerySyntax
);

Parameters

[out, retval] pQuerySyntax

Type: SEARCH_QUERY_SYNTAX*

Receives a pointer to a value from the SEARCH_QUERY_SYNTAX enumeration.

Return value

Type: HRESULT

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

Remarks

The allowed syntaxes are Simple, Natural Query Syntax (NQS), and Advanced Query Syntax (AQS). If not set, the default query syntax is SEARCH_ADVANCED_QUERY_SYNTAX.

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