ICatalogRead interface
Stateless object, does fetch action based on catalog object passed in
Members
The ICatalogRead interface inherits from the IDispatch interface. ICatalogRead also has these types of members:
Methods
The ICatalogRead interface has these methods.
| Method | Description |
|---|---|
| GetIndexedTopic | method GetIndexedTopic - returns a data stream containing the XHTML data for a topic identified by its topic id in an open catalog |
| GetIndexedTopicDetails | method GetIndexedTopicDetails - returns an ITopic interface containing the details of a topic identified by its topic id in an open catalog |
| GetKeywords | method GetKeywords - returns an IKeywordCollection of all of the keywords in the catalog |
| GetLinkedAsset | method GetLinkedAsset - returns a data stream containing the requested asset. Asset is identified by its package name and file path within the package within the currently open catalog |
| GetSearchResults | method GetSearchResults - returns an ITopicCollection for a given query within a catalog. filter is a collection of key/value pairs to refine the search results. Supports paging. |
| GetTableOfContents | 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) |
| GetTopicDetailsForF1Keyword | method GetTopicDetailsForF1Keyword - returns an ITopic interface containing the matching topic for the F1 keyword. F1 keywords consists of an array of prioritized F1 keywords |
| GetTopicForF1Keyword | 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 |
Requirements
| Minimum supported client |
Windows 8 [desktop apps only] |
| Minimum supported server |
Windows Server 2012 [desktop apps only] |
| IDL |
|