IHelpCatalogRead::GetSearchResults method
[This documentation is preliminary and is subject to change.]
method GetSearchResults - Returns a data stream of search results in open search XML format for a given query within a catalog. FilterCritera is an array of filter criteria to refine the search results. Supports paging.
Syntax
HRESULT GetSearchResults(
[in] IHelpCatalog *catalog,
[in] BSTR query,
[in] IHelpFilter *filter,
[in] long options,
[in] long pageSize,
[in] long pageNumber,
[out] long *totalSearchResults,
[out, retval] IHelpTopicCollection **pRetVal
);
Parameters
catalog [in]
Catalog interface instance to be used for the function.query [in]
Search terms. Multiple search terms can be used if separated by a space then an AND is implied. Logic expressions AND, OR and NOT can be utilized. Support for NEAR operation is also available.filter [in]
IHelpFilter object containing filtering to be applied to the search result set to further refine it.options [in]
TBD.pageSize [in]
Number of search results to return per page (1 .. n).pageNumber [in]
Page number to retrieve (1 .. n).totalSearchResults [out]
Total number of found topics for the search.pRetVal [out, retval]
Returns an IHelpTopicCollection interface. The collection contains IHelpTopic objects in order of most to least relevant.
Return value
If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
Remarks
TBD.
Examples
Requirements
Minimum supported client |
Windows Developer Preview |
Minimum supported server |
Windows Server Developer Preview |
IDL |
Windows.Help.Runtime.idl |
See also
Build date: 9/7/2011