ICatalogRead::GetTableOfContents method

method GetTableOfContents - returns an ITopicCollection of ToC data. ToC is from the starting point of the topic id and matching the topic locale and topic version (to support multiple locale and versions in a catalog). The return detail can be one of four levels (Children of the topicId, Siblings of the topicId, Ancestors of the topicId, or all ToC Root Nodes)

Syntax

HRESULT GetTableOfContents(
  [in]          ICatalog         *Catalog,
  [in]          BSTR             topicId,
  [in]          IHelpFilter      *filter,
  [in]          TocReturnDetail  returnDetail,
  [out, retval] ITopicCollection **pRetVal
);

Parameters

Catalog [in]

topicId [in]

filter [in]

returnDetail [in]

pRetVal [out, retval]

Return value

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

Requirements

See also

ICatalogRead