Free

API reference for functions relating to freeing memory resources that have been used by Salience to store results. This should be done when your work is complete so that performance isn't affected.

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().

Returns: Integer return code. To retrieve more information on the return code use lxaGetLastWarnings on the SalienceSession structure.

More information on errors and warnings can be found in the Errors and Warning Codes section of our documentation.

Function Signature:
int lxaFreeString(char *acBuffer);

Parameter

Description

acBuffer

Pointer to a char buffer to be freed

See example code in lxaLoadLicense for usage.

lxaFreeLicense

Summary: This function frees the memory associated with the LexalyticsLicense structure.

Returns: Integer return code. To retrieve more information on the return code use lxaGetLastWarnings on the SalienceSession structure.

More information on errors and warnings can be found in the Errors and Warning Codes section of our documentation.

Function Signature:
int lxaFreeLicense(LexalyticsLicense *pLicense);

Parameter

Description

pLicense

Pointer to a LexalyticsLicense to be freed

See example code in lxaLoadLicense for usage.

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.

Returns: Integer return code. To retrieve more information on the return code use lxaGetLastWarnings on the SalienceSession structure.

More information on errors and warnings can be found in the Errors and Warning Codes section of our documentation.

Function Signature:
int lxaFreeEntityList(SalienceEntityList *pResults);

Parameter

Description

pResults

Pointer to a SalienceEntityList to be freed

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.

Returns: Integer return code. To retrieve more information on the return code use lxaGetLastWarnings on the SalienceSession structure.

More information on errors and warnings can be found in the Errors and Warning Codes section of our documentation.

Function Signature:
int lxaFreeCollectionEntityList(SalienceCollectionEntityList *pResults);

Parameter

Description

pResults

Pointer to a SalienceCollectionEntityList to be freed

See example code in lxaGetCollectionEntities for usage.

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.

Returns: Integer return code. To retrieve more information on the return code use lxaGetLastWarnings on the SalienceSession structure.

More information on errors and warnings can be found in the Errors and Warning Codes section of our documentation.

Function Signature:
int lxaFreeThemeList(SalienceThemeList *pThemesList);

Parameter

Description

pThemesList

Pointer to a SalienceThemeList to be freed

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.

Returns: Integer return code. To retrieve more information on the return code use lxaGetLastWarnings on the SalienceSession structure.

More information on errors and warnings can be found in the Errors and Warning Codes section of our documentation.

Function Signature:
int lxaFreeFacetList(SalienceFacetList *pFacetList);

Parameter

Description

pFacetList

Pointer to a SalienceFacetList to be freed

See example code in lxaGetCollectionFacets for usage.

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.

Returns: Integer return code. To retrieve more information on the return code use lxaGetLastWarnings on the SalienceSession structure.

More information on errors and warnings can be found in the Errors and Warning Codes section of our documentation.

Function Signature:
int lxaFreeRelationList(SalienceRelationList *pRelationList);

Parameter

Description

pResults

Pointer to a SalienceRelationList to be freed

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.

Returns: Integer return code. To retrieve more information on the return code use lxaGetLastWarnings on the SalienceSession structure.

More information on errors and warnings can be found in the Errors and Warning Codes section of our documentation.

Function Signature:
int lxaFreeOpinionList(SalienceOpinionList *pOpinionList);

Parameter

Description

pOpinionList

Pointer to a SalienceOpinionList to be freed

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.

Returns: Integer return code. To retrieve more information on the return code use lxaGetLastWarnings on the SalienceSession structure.

More information on errors and warnings can be found in the Errors and Warning Codes section of our documentation.

Function Signature:
int lxaFreeSentimentResult(SalienceSentimentResult *pResult);

Parameter

Description

pResult

Pointer to a SalienceSentimentResult to be freed

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.

Returns: Integer return code. To retrieve more information on the return code use lxaGetLastWarnings on the SalienceSession structure.

More information on errors and warnings can be found in the Errors and Warning Codes section of our documentation.

Function Signature:
int lxaFreeDocumentDetails(SalienceDocumentDetails *pDetails);

Parameter

Description

pDetails

Pointer to a SalienceDocumentDetails to be freed

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.

Returns: Integer return code. To retrieve more information on the return code use lxaGetLastWarnings on the SalienceSession structure.

More information on errors and warnings can be found in the Errors and Warning Codes section of our documentation.

Function Signature:
int lxaFreeTopicList(SalienceTopicList *pTopicList);

Parameter

Description

pTopicList

Pointer to a SalienceTopicList to be freed

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.

Returns: Integer return code. To retrieve more information on the return code use lxaGetLastWarnings on the SalienceSession structure.

More information on errors and warnings can be found in the Errors and Warning Codes section of our documentation.

Function Signature:
int lxaFreeDocument(SalienceDocument *pDocument);

Parameter

Description

pDocument

Pointer to a SalienceDocument to be freed

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.

Returns: Integer return code. To retrieve more information on the return code use lxaGetLastWarnings on the SalienceSession structure.

More information on errors and warnings can be found in the Errors and Warning Codes section of our documentation.

Function Signature:
int lxaFreeSummaryResult(SalienceSummaryResult *pSummaryResult);

Parameter

Description

pSummaryResult

Pointer to a SalienceSummaryResult to be freed

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.

Returns: Integer return code. To retrieve more information on the return code use lxaGetLastWarnings on the SalienceSession structure.

More information on errors and warnings can be found in the Errors and Warning Codes section of our documentation.

Function Signature:
int lxaFreeIntentionList(SalienceIntentionList *pIntentionList);

Parameter

Description

pIntentionList

Pointer to a SalienceIntentionList to be freed

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.

Returns: Integer return code. To retrieve more information on the return code use lxaGetLastWarnings on the SalienceSession structure.

More information on errors and warnings can be found in the Errors and Warning Codes section of our documentation.

Function Signature:
int lxaFreeOCRAttributeList(OCRCharacterAttributeList *pAttributes);

Parameter

Description

pAttributes

Pointer to a OCRCharacterAttributeList to be freed

See example code in lxaCorrectOCRErrors for usage.