ICatalogRead::GetTopicForF1Keyword method

  • Article

method GetTopicForF1Keyword - returns a stream containing the matching topic for the F1 keyword in XHTML format. F1 keywords consists of an array of prioritized F1 keywords

Syntax

HRESULT GetTopicForF1Keyword(
  [in]          ICatalog    *Catalog,
  [in]          SAFEARRAY   BSTR,
  [in]          IHelpFilter *filter,
  [out, retval] IUnknown    **pRetVal
);

Parameters

Catalog [in]

BSTR [in]

filter [in]

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