lxaGetDocumentDetails

<< lxaPrepareCollectionFromFile | Back to Salience 6 C API Index | lxaGetSummary >>

Summary

Retrieves various bits of useful information about the current text including term frequency analysis and document chunk information.
The acConfigurationID parameter specifies the configuration for the results, which are returned in a SalienceDocumentDetails structure. Configurations are defined using the method lxaAddSalienceConfiguration.
Call lxaFreeDocumentDetails when you are finished with the information to free any allocated memory.

Syntax

int lxaGetDocumentDetails(SalienceSession *pSession, 
                          SalienceDocumentDetails *pDetails,
                          const char *acConfigurationID);

Parameters

pSession Pointer to a SalienceSession structure previously returned by a call to lxaOpenSalienceSession
pDetails Pointer to a SalienceDocumentDetails structure
acConfigurationID Character string specifying the configuration for the results, blank for the default configuration

Returns

This function returns an integer return code.

Example

     char* acBuffer = "This is some text to process";
     ...
     SalienceSession* pSession;
     SalienceDocumentDetails oDetails;
     if(lxaOpenSalienceSession(oLicense, &oStartup, &pSession) != LXA_OK)
          return 1;
     lxaPrepareText(pSession,acBuffer);
     lxaGetDocumentDetails(pSession,&oDetails);
     ...
     lxaFreeDocumentDetails(&oDetails);
     lxaCloseSalienceSession(pSession);

<< lxaPrepareCollectionFromFile | Back to Salience 6 C API Index | lxaGetSummary >>