lxaGetCollectionFacets

<< lxaGetCollectionThemes | Back to Salience 6 C API Index | lxaGetCollectionQueryDefinedTopics >>

Summary

Retrieves the facets extracted across all documents in the collection. These results can be adjusted through the available Collection Options, which must be set before this call is made.
The acConfigurationID parameter specifies the configuration for the results, which are returned in a SalienceFacetList structure. Configurations are defined using the method lxaAddSalienceConfiguration.
After use you should free the allocated memory by calling lxaFreeFacetList.

Syntax

int lxaGetCollectionFacets(SalienceSession *pSession,
                           SalienceFacetList *pResults,
                           const char *acConfigurationID);

Parameters

pSession Pointer to a SalienceSession structure previously returned by a call to lxaOpenSalienceSession
pResults Pointer to a SalienceFacetList structure that will get filled in by the call
acConfigurationID Character string specifying the configuration for the results, blank for the default configuration

Returns

This method returns an integer return code.

Example

TODO: Example needed for Salience 6

<< lxaGetCollectionThemes | Back to Salience 6 C API Index | lxaGetCollectionQueryDefinedTopics >>