Share via


Help API Reference

The Help API enables opening help catalogs and retrieving help content items such as:

  • indexed help topics (XHTML, HTML)
  • non-indexed images
  • CSS files
  • JavaScript
  • audio/video elements

In this section

Topic Description
ICatalog
State object, holds open catalog and all info about catalog
ICatalogRead
Stateless object, does fetch action based on catalog object passed in
ICatalogReadWriteLock
Catalog lock state object, holds catalog lock and all info about catalog lock
IHelpFilter
Collection of filter criteria name/value pairs
IHelpKeyValuePair
Key/value pair for IHelpFilter objects
IKeyword
Help Keyword interface, contains methods to retrieve keyword information
IKeywordCollection
Collection of IKeyword interfaces
ITopic
Help topic interface, contains methods to retrieve topic information
ITopicCollection
Collection of ITopics
IndexException
An interface that inherits from the IDispatch interface.