lxaFreeString
Summary
This function frees the memory associated with the string. It is provided so that programs compiled with a different version of C Runtime libraries can free strings allocated by Salience. It is a wrapper for free().
Syntax
int lxaFreeString(char* acBuffer);
Parameters
| Pointer to a char* buffer to be freed |
|---|
Returns
This method returns an integer return code.
Example
See example code in [lxaLoadLicense] for usage.
lxaFreeLicense
Summary
This function frees the memory associated with the LexalyticsLicense structure.
Syntax
int lxaFreeLicense(LexalyticsLicense* pLicense);
Parameters
| Pointer to a LexalyticsLicense to be freed |
|---|
Returns
This method returns an integer return code.
Example
TODO: Example needed for Salience 6
lxaFreeEntityList
Summary
This function frees the memory associated with a SalienceEntityList structure. This structure is filled in by calls to lxaGetNamedEntities and lxaGetUserDefinedEntities, and must be called to free memory allocated by these results.
Syntax
int lxaFreeEntityList(SalienceEntityList* pResults);
Parameters
| Pointer to a SalienceEntityList to be freed |
|---|
Returns
This method returns an integer return code.
Example
See example code in lxaGetNamedEntities for usage.
lxaFreeCollectionEntityList
Summary
This function frees the memory associated with a SalienceCollectionEntityList structure. This structure is filled in by calls to lxaGetCollectionEntities, and must be called to free memory allocated by these results.
Syntax
int lxaFreeCollectionEntityList(SalienceCollectionEntityList* pResults);
Parameters
| Pointer to a SalienceCollectionEntityList to be freed |
|---|
Returns
This method returns an integer return code.
Example
TODO: Example needed for Salience 6
lxaFreeThemeList
Summary
This function frees the memory associated with a SalienceThemeList structure. This structure is filled in by calls to lxaGetThemes and lxaGetCollectionThemes, and must be called to free memory allocated by these results.
Syntax
int lxaFreeThemeList(SalienceThemeList* pThemesList);
Parameters
| Pointer to a SalienceThemeList to be freed |
|---|
Returns
This method returns an integer return code.
Example
See example code in lxaGetThemes for usage.
lxaFreeFacetList
Summary
This function frees the memory associated with a SalienceFacetList structure. This structure is filled in by calls to lxaGetCollectionFacets, and must be called to free memory allocated by these results.
Syntax
int lxaFreeFacetList(SalienceFacetList* pFacetList);
Parameters
| Pointer to a SalienceFacetList to be freed |
|---|
Returns
This method returns an integer return code.
Example
TODO: Example needed for Salience 6
lxaFreeRelationList
Summary
This function frees the memory associated with a SalienceRelationList structure. This structure is filled in by calls to lxaGetNamedEntityRelationships and lxaGetUserEntityRelationships, and must be called to free memory allocated by these results.
Syntax
int lxaFreeRelationList(SalienceRelationList* pRelationList);
Parameters
| Pointer to a SalienceRelationList to be freed |
|---|
Returns
This method returns an integer return code.
Example
See example code in lxaGetNamedEntityRelationships for usage.
lxaFreeOpinionList
Summary
This function frees the memory associated with a SalienceOpinionList structure. This structure is filled in by calls to lxaGetNamedEntityOpinions and lxaGetUserEntityOpinions, and must be called to free memory allocated by these results.
Syntax
int lxaFreeOpinionList(SalienceOpinionList* pOpinionList);
Parameters
| Pointer to a SalienceOpinionList to be freed |
|---|
Returns
This method returns an integer return code.
Example
See example code in lxaGetNamedEntityOpinions for usage.
lxaFreeSentimentResult
Summary
This function frees the memory associated with a SalienceSentimentResult structure. This structure is filled in by calls to lxaGetSentiment, and must be called to free memory allocated by these results.
Syntax
int lxaFreeSentimentResult(SalienceSentimentResult* pResult);
Parameters
| Pointer to a SalienceSentimentResult to be freed |
|---|
Returns
This method returns an integer return code.
Example
See example code in lxaGetSentiment for usage.
lxaFreeDocumentDetails
Summary
This function frees the memory associated with a SalienceDocumentDetails structure. This structure is filled in by calls to lxaGetDocumentDetails, and must be called to free memory allocated by these results.
Syntax
int lxaFreeDocumentDetails(SalienceDocumentDetails* pDetails);
Parameters
| Pointer to a SalienceDocumentDetails to be freed |
|---|
Returns
This method returns an integer return code.
Example
See example code in lxaGetDocumentDetails for usage.
lxaFreeTopicList
Summary
This function frees the memory associated with a SalienceTopicList structure. This structure is filled in by calls to lxaGetQueryDefinedTopics, lxaGetConceptDefinedTopics, lxaGetCollectionQueryDefinedTopics, and lxaGetCollectionConceptDefinedTopics and must be called to free memory allocated by these results.
Syntax
int lxaFreeTopicList(SalienceTopicList* pTopicList);
Parameters
| Pointer to a SalienceTopicList to be freed |
|---|
Returns
This method returns an integer return code.
Example
See example code in lxaGetQueryDefinedTopics for usage.
lxaFreeDocument
Summary
This function frees the memory associated with a SalienceDocument structure. This structure is filled in by calls to retrieve markup text such as lxaGetNamedEntityMarkup, lxaGetUserEntityMarkup, lxaGetPOSMarkup, and lxaGetSentimentMarkup and must be called to free memory allocated by these results.
Syntax
int lxaFreeDocument(SalienceDocument* pDocument);
Parameters
| Pointer to a SalienceDocument to be freed |
|---|
Returns
This method returns an integer return code.
Example
See example code in lxaGetNamedEntityMarkup for usage.
lxaFreeSummaryResult
Summary
This function frees the memory associated with a SalienceSummaryResult structure. This structure is filled in by calls to retrieve a document-level summary via lxaGetSummary and must be called to free memory allocated by these results.
Syntax
int lxaFreeSummaryResult(SalienceSummaryResult* pSummaryResult);
Parameters
| Pointer to a SalienceSummaryResult to be freed |
|---|
Returns
This method returns an integer return code.
Example
See example code in lxaGetSummary for usage.
lxaFreeIntentionList
Summary
This function frees the memory associated with a SalienceIntentionList structure. This structure is filled in by calls to lxaGetIntentions and must be called to free memory allocated by these results.
Syntax
int lxaFreeIntentionList(SalienceIntentionList* pIntentionList);
Parameters
| Pointer to a SalienceIntentionList to be freed |
|---|
Returns
This method returns an integer return code.
Example
See example code in lxaGetIntentions for usage.
lxaFreeOCRCharacterAttributeList
Summary
This function frees the memory associated with a OCRCharacterAttributeList structure. This structure is created by the user and passed in to calls to lxaCorrectOCRErrors. This function assumes that the OCRCharacterAttributeList structure was created by the user purely from the heap. If the user has created this structure using some combination of static and stack memory, they should not use this function and should manage the freeing of this structure themselves in an appropriate way.
Syntax
int lxaFreeOCRAttributeList(OCRCharacterAttributeList* pAttributes);
Parameters
| Pointer to a OCRCharacterAttributeList to be freed |
|---|
Returns
This method returns an integer return code.
Updated 4 months ago