ISearchQueryHelper::get_QueryContentProperties method (searchapi.h)

Article
02/22/2024

Gets the list of properties included in the query when search terms do not explicitly specify a property.

Syntax

HRESULT get_QueryContentProperties(
  [out, retval] LPWSTR *ppszContentProperties
);

Parameters

[out, retval] ppszContentProperties

Type: LPWSTR*

Receives a pointer to a comma-delimited, null-terminated Unicode string of content properties to search. If ppszContentProperties is NULL, all properties are searched.

Return value

Type: HRESULT

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

Remarks

Search terms may or may not be explicitly prefixed by a property ("author:Irina" or just "Irina"). If SEARCH_ADVANCED_QUERY_SYNTAX or NO_QUERY_SYNTAX is set in ISearchQueryHelper::put_QuerySyntax, all search terms not prefixed by a property keyword are matched against the list of properties in ppszContentProperties.

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