ICatalogRead::GetSearchResults method

  • Article

method GetSearchResults - returns an ITopicCollection for a given query within a catalog. filter is a collection of key/value pairs to refine the search results. Supports paging.

Syntax

HRESULT GetSearchResults(
  [in]          ICatalog         *Catalog,
  [in]          BSTR             query,
  [in]          IHelpFilter      *filter,
  [in]          long             options,
  [in]          long             pageSize,
  [in]          long             pageNumber,
  [out]         long             *totalSearchResults,
  [out, retval] ITopicCollection **pRetVal
);

Parameters

Catalog [in]

query [in]

filter [in]

options [in]

pageSize [in]

pageNumber [in]

totalSearchResults [out]

pRetVal [out, retval]

Return value

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

Requirements
Minimum supported client
 Windows 8 [desktop apps only]
Minimum supported server
 Windows Server 2012 [desktop apps only]
IDL
Windows.Help.Runtime.idl

See also

ICatalogRead