fpFreeOLESummaryInfo()

This function frees the memory allocated by fpGetOLESummaryInfoFile() or fpGetOLESummaryInfo() for metadata extraction.

DEPRECATED: The fpFreeOLESummaryInfo() function is deprecated in KeyView 23.2.0 and later. OpenText recommends that you create a KVDocument to represent each document, and access metadata by calling the function fpGetMetadataList().

This function is still available for existing implementations, but it might be incompatible with new functionality and might be removed in future.

Syntax

BOOL pascal fpFreeOLESummaryInfo( 
    KVFilterSession     session,
    KVSummaryInfoEx    *pSummaryInfo );

Arguments

session

A KeyView Filter session that you initialized by calling fpInit().

pSummaryInfo A pointer to the KVSummaryInfoEx structure.

Returns

  • If the call is successful, the return value is TRUE.
  • If the call is unsuccessful, the return value is FALSE.

Discussion

Call this function after fpGetOLESummaryInfo() or fpGetOLESummaryInfoFile() has successfully filled pSummaryInfo, and the data is no longer required.