IHelpCatalogRead::GetIndexedTopic method

[This documentation is preliminary and is subject to change.]

method GetIndexedTopic - Returns a data stream containing the XHTML data for a topic identified by its topic id in an open catalog.

Syntax

HRESULT GetIndexedTopic(
  [in]           IHelpCatalog *catalog,
  [in]           BSTR topicId,
  [in]           IHelpFilter *filter,
  [out, retval]  IUnknown **pRetVal
);

Parameters

  • catalog [in]
    Catalog interface instance to be used for the function.

  • topicId [in]
    Identifier for the topic that you want to use as the starting point for the table of contents .

  • filter [in]
    TBD.

  • pRetVal [out, retval]
    Returns an IStream containing the topic content. Help topic content is XHTML formated.

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

IHelpCatalogRead

 

 

Build date: 9/7/2011